Integration Settings

Add an Integration

Now that the connection is set up, go to the Apps tab and click Data Pull. There you'll see the list of integrations, and a button to add a "New Integration" in the top-right corner. Click to get started.

Create an Integration:

To create an integration:

In the Data Pull app page, select New Integration.
Give the integration a name, ideally one that demonstrates what kind of data it will be used to retrieve.
Set the Type to "Order" or "Material" depending on the kind of data you're pulling.
1. If you select "Order", you can choose to create "Create" or "Delete" orders.
Select the connection.

Integration settings

Once an integration is created, you can click on it to look at the details. In the Settings tab, you'll see these options:

General: Change the integration name, connection, method, or data structure.
Connection: This is the path/extension of the connection base URL.
Headers: Add or remove headers that should be included, like authorization tokens.
Other Settings: Configure additional settings regarding how ItemPath creates records.
Request: Use either a GET or POST API method to pull data.
Confirmation: Set the endpoint to send confirmation responses.

You can toggle the entire integration to "Inactive" with the switch at the top-right.

General

The General section allows you to modify basic settings, such as the integration name, whether the integration is active, which connection is being used, and the structure of the data that Data Pull will be retrieving. There are three options for Data Structure:

Flat: The data being retrieved is non-hierarchical, all key-value pairs have a simple data type.
Nested: The data retrieved is hierarchical, where at least one key contains a deeper, complex data structure,
No Structure: The data being retrieved has no structure.

Connection

The Path entered here is the endpoint where orders or materials are being pulled from. The path is an extension of the Data Pull connection set up in ItemPath's global settings.

Checking the "Verify" box will require SSL certificate verification for this endpoint.

Timeout is the number of seconds that can pass without a response before Data Pull logs a timeout error. The default is 10 seconds.

Headers

The headers entered here will apply to each transaction sent with this integration. These are also in addition to any global headers set up in the Data Pull connection.

Check the "Private" box if these headers are used for authentication and should not be shown in the logs.

Other Settings

The options in this block depend on whether you are retrieving or deleting Orders or Materials.

If you are setting up an integration for Orders:

Time Format: You can specify the time format used in incoming data (e.g., YYYY-MM-DD or YYYYMMDD.0).
Auto Detect Direction Type: Whether you would like ItemPath to automatically detect the direction type. For example, if a negative value is used to differentiate picks and puts you can specify here that all picks will have negative quantities.
Default Direction Type: The default direction type for the data (if the retrieved data is for Picks and Pulls).
Append Lines: If the system should append lines to an existing Order. If this setting is disabled, the system will attempt to create a new Order, which will fail if the order name has been used before. If enabled, the system will search for existing orders with the same name and add only unique order line numbers.
Enable Manual Pull: Whether a user can initiate a manual pull in Data Pull.
Run Unauthenticated: If enabled, a manual run of this integration will not require integration.
Group By: This option allows you to specify a field to group line level data by.

If you are setting up an integration for Materials:

Time Format: You can specify the time format used in incoming data (e.g., YYYY-MM-DD or YYYYMMDD.0).
Default Material Property: This is the value to be used if no Material Property is specified otherwise when creating Materials. If none is set, the Material Property in the ItemPath's global Settings will be used (if there is one).
Enable Manual Pull: Whether a user can initiate a manual pull in Data Pull.

Request

Change the default API method from GET to POST and enter the body of the request, if you need to pull data that way. This is used especially for GraphQL.

Confirmations

Set the endpoint to send confirmation responses to once an order or material has been created. Mappings for this are in the next step.