Track data shape

Introduction

The track data shape can be used to track processed data, based on field paths that you define. When data passes through a track data shape, values associated with your defined field paths are tracked, which means they are added to the tracked data panel on the Process Flow Home page.

For example, you might choose to track all customer_id values that pass through the shape, so at any time you can quickly check if a given customer record has been processed:

Need to know

• Data that is tracked via the track data shape is retained for one year.

• The track data shape works with incoming payloads from a connection shape, and also from a manual payload, inbound API or webhook.

• JSON payloads are supported.

• Flow and metadata variables are supported when defining field paths.

Adding & configuring a track data shape

To add and configure a new track shape, follow the steps below.

Step 1 In your process flow, add the track data shape in the usual way:

Step 2 You can now configure the track data shape. How you do this depends on whether the data to be tracked is being added to the process flow via a connector shape, or from a non-connector source (such as a manual payload, inbound API request, or webhook):

I want to track data from a connector in my flow

Step 1 Select a source instance and endpoint for the connection that you want to use:

Step 2 Notice that the entity and direction fields are automatically populated and locked - these details are taken from your selected connector and cannot be changed.

Step 3 Move down to the field paths section. Based on the data schema defined for your selected connector, some suggestions are made:

You can delete or change any of these suggestions - to do this, click the associated 'edit' icon:

From here you can change the setting by entering a field path manually, or toggle the manual input option OFF to browse the data schema and select a path:

Alternatively, use the delete button to remove a suggested field path.

Step 4 If you need to add a new field path, click the add new field button:

...then navigate the data schema for your selected connector and select the required field:

Note: If you want to specify flow or metadata variables for your field path, toggle the manual input option ON and enter your value manually (click the create button to confirm).

Step 5 Save the shape.

I want to track data from a non-connector source

Step 1 Leave source instance and endpoint fields blank - for example:

Step 2 Move down to the entity field and click anywhere within it to choose an entity type:

This determines the type of data that you're processing - for example: customers, orders, products, etc.:

Step 3 Set the direction field to send (if you are pushing tracked data into another system) or to receive (if you are receiving tracked data):

Step 4 Move down to the field paths section and click the add new field button:

Here you can enter a path to the required field (i.e. the field that you want to track) manually - for example:

If you want to specify flow or metadata variables for your field path, toggle the manual input option ON and enter your value manually, then click the create button to confirm.

You can repeat this step to add any other fields that you want to track with this shape.

Step 5 Save the shape.