Split shape

Introduction

The split shape is used to split out a given payload element. When data is split, the specified element (including any nested elements) is extracted for onward processing.

For example, your process flow might receive customer data from a source connection, but you need to send address details to a different endpoint. In this case, you'd use the route shape to create two different routes, mapping just customer data down one, and splitting out addresses for the other.

A single incoming payload for any process flow shape should not exceed 500MB.

We recommend processing multiple, smaller payloads rather than one single payload (1000 x 0.5MB payloads are more efficient than 1 x 500MB payload!).

For payloads up to 500MB, consider adding a flow control shape to batch data into multiple, smaller payloads. Payloads exceeding 500MB should be batched at source.

Adding & configuring a split shape

Show me

1

Add a split shape

In your process flow, add the split shape in the usual way:

2

Access settings

Click the settings icon for the split shape:

3

Select source details (optional)

If appropriate, enter a source integration and a source endpoint - for example:

Adding this information allows you to navigate the associated schema to determine where data is split. This is easier than entering a path manually, but it's not essential.

4

Define where incoming data is split

Move down to the level to split section. If you added source details in the previous step, you can use the dropdown data path to select the required data element to split - for example:

Alternatively, you can enter the required data path manually. For example:

Here, customer.addresses targets the addresses array within a customer object.

Remember - any data (including nested data) within the selected element will be split out into a new payload.

5

Add a wrapper key (optional)

If required, you can add a wrapper key. This wraps the entire payload in an element of the given name - for example:

Here, defining ADDRESSES as the wrapper key would wrap the payload as shown below:

6

Save changes

Save shape settings to exit back to the canvas.

Last updated

Was this helpful?