Support asynchronous exports or imports via Async Helper

Contents

• Introduction
• Enable and Create Async Helper
• Configure Status Export
• Configure Result Export

Introduction

Integrator.io supports asynchronous imports using its Async Helper feature if your target application supports asynchronous exports or imports. The Async Helper can send poll requests for you to obtain the feed status at regular intervals. The Async Helper also retrieves the result from your target application and displays it on the dashboard. You can configure the Async Helper on the Import page for HTTP application types.

Note: The Async Helper is currently only available for Amazon Item feeds and Walmart Item Feeds.

If a target application is busy performing other tasks, it may not return a result immediately. In such cases you can use the Async Helper to configure poll wait time intervals until the target application is able to return a result.

The example in this article uses Amazon Item Feeds to explain the Async Helper feature.

The following image illustrates how the Async Helper sends poll messages to Amazon at regular intervals to obtain feed status. When Amazon's API answers a poll message with a result status, the Async Helper retrieves the requested data.

Once integrator.io submits the feed to Amazon, Amazon responds with a feed submission ID. Integrator.io uses this ID to retrieve the export status via poll messages sent at regular intervals. While Amazon is processing the request, Amazon responds to each poll message with a status message indicating that the request is still in progress. Once Amazon completes the feed submission process, it responds to the latest poll message with an XML response that includes the final result.

Integrator.io transforms the XML result data to JSON with user-defined transformation rules for further processing. The transformed data from the result then displays on the dashboard.

Enable and Create Async Helper

Use the following procedure to enable and create Async Helper for your flow.

1. On the Import page, check the Configure Async Helper checkbox.

   

2. Click the + icon to create an Async Helper. Once created, the helper displays in the Async Helper drop-down menu.

   

3. Complete the following fields in the Async Helper Configuration window:

   Field Name	Description
   Name	Enter a name for the Async Helper that you are creating.
   Status Export	Click the + icon to configure the status export.
   Initial Wait Time	Enter the wait time in minutes. This is the length of time integrator.io waits before sending the first poll message to the target application. For example, if you enter the number "2", integrator.io waits for two minutes before sending the first poll request to check the current feed status.
   Poll Wait Time	Enter the wait time in minutes. This is the length of time integrator.io waits before sending subsequent poll requests. For example, if you enter the number "2", integrator.io sends a poll request every two minutes until the target application returns a result feed status.
   Status Path	Enter the XML/JSON path where the In Progress Values and Done Values appear in the response received. This path is applied to resources extracted from the Status Export. For example, FeedProcessingStatus.
   In-Progress Values	Enter the feed status values returned by the target application's response schema. Consult the target application's API documentation to determine the  values returned from the target application's poll responses. For example, if you have sent a feed to Amazon, your in-progress values are: SUBMIT, IN PROGRESS. Use comma separated values to define the in-progress value. Note: These values are case sensitive.
   Done Values	Enter the value(s) that you receive as a response from the target application after the feed processing is complete. For example, if you have sent a feed to Amazon, your Done Values is DONE.
   Same As Status Export	Select this checkbox if the Resource Path specified in the Status Export is same as that of the Submit Resource Path.
   Submit Resource Path	This field appears if Same As Status Export checkbox is unchecked. Use this to specify the path for obtaining other feed info resources. Integrator.io passes this data to status and result exports to evaluate handlebars expressions. For example, /SubmitFeedResponse/SubmitFeedResult/FeedSubmissionInfo.
   Transform Rules for Submit Response	Use this optional field if the target application returns responses in non-JSON formats. For example, if your target application is Amazon, the response data received is in XML format. You can convert the XML response data to JSON using Transform Rules for Submit Response.  For more information, see Transform Rules Guide.
   Result Export	Click the + icon to configure the result export.

Configure Status Export

Use the following steps to configure status export:

1. Complete the following fields:

   Field Name	Description
   Name	Enter the name of status export you are creating.
   Description	Enter a short description of the status export's purpose.
   HTTP Method	Select the HTTP method to be used. For example, GET, POST.
   Relative URI	Enter the relative URI of the target application. For example: /?Action=GetFeedSubmissionList&FeedSubmissionIdList.Id.1={{data.FeedSubmissionId}}.
   Success Media Type	Enter the success media type. For example, if your target application is Amazon, the response is in XML format.
   Error Media Type	Enter the response media type. For example, if your target application is Amazon, the response is in XML.
   Resource Path	Enter the resource path. For example: /GetFeedSubmissionListResponse/GetFeedSubmissionListResult/FeedSubmissionInfo.
   Export Type	Select All.

2. Click Configure Transform Rules to generate the data.
3. Click Save.

Configure Result Export

1. Complete the following fields:

   Field Name	Description
   Name	Enter the name of result export you are creating.
   Description	Enter a short description of the result export's purpose.
   HTTP Method	Select the HTTP method to be used. For example, GET, POST.
   Relative URI	The relative URI of the target application. For example: /?Action=GetFeedSubmissionResult&FeedSubmissionId={{data.FeedSubmissionId}}
   Success Media Type	Enter the success media type. For example, if your target application is Amazon, the response returns in XML format.
   Error Media Type	Enter the response media type. For example, if your target application is Amazon, the response returns in XML format.
   Resource Path	Enter the resource path. For example: /AmazonEnvelope/Message/ProcessingReport/Result.
   Export Type	Select All.

2. Click Save.