File format: CBOR

CBOR is a binary data serialization format based on JSON. Like JSON it allows the transmission of data objects that contain name-value pairs, but in a more concise manner. This increases processing and transfer speeds at the cost of human-readability.

Note

XML data can be sent to the Streaming API, after which it is converted to CBOR format and may be loaded to Amperity using an ingest query that flattens it into a tabular format.

Pull CBOR files

To pull CBOR files to Amperity:

  1. Select a data source.

  2. Configure a courier for the location and name of the CBOR file.

  3. Define a feed to associate fields in the CBOR file with semantic tags.

Data sources

Pull CBOR files to Amperity using one of the following data sources:

Load data

Use a feed to associate fields in the CBOR file with semantic tags and a courier to pull the CBOR file from its upstream data source.

Couriers

A courier brings data from an external system to Amperity.

A courier must specify the location of the CBOR file, and then define how that file is to be pulled to Amperity.

  1. File settings

  2. Feed selection

File settings

Use the File settings section of the courier configuration page to specify the path to the CBOR file and to define formattting within the file.

Feed selection

Use the Feed selection section of the courier configuration page to identify the feed for which this courier pulls data, and then files are loaded.

From the Load type dropdown select one of:

  • Load Use this option to load data to the associated domain table.

  • Truncate and load Use this option to delete all rows in the associated domain table, and then load data.

Important

The "schema" must match the structure of the incoming file, including all nested groupings and data types. Set "nullable" to True to allow fields to contain NULL values. A CBOR file can have hundreds of fields. The ellipses (...) in this example represents locations within this example structure where additional fields may be present.

Tip

Set rowTag to the element in the CBOR file that should be treated as a row in a table. The default value is row.

Feeds

A feed defines how to load data into a domain table, including specifying required columns and columns with semantic tags for customer profile (PII) or transactions data.

Apply profile (PII) semantics to customer records and transaction, and product catalog semantics to interaction records. Use blocking key (bk), foreign key (fk), and separation key (sk) semantic tags to define how Amperity should understand values that exist across data sources.

Send CBOR files

Important

Amperity does not send CBOR files to downstream workflows.