Preview

This product or feature is covered by the Pre-GA Offerings Terms of the Google Cloud Terms of Service. Pre-GA products and features might have limited support, and changes to pre-GA products and features might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

See the supported connectors for Application Integration.

While Loop task

The While Loop task lets you make repeated calls to a sub-integration from your current (main) integration until a specified condition is met.

The API Trigger ID and the Integration name identifies the sub-integration you want to run.

The task also lets you collect the response from each sub-integration run and store the value in your current integration for use in downstream tasks. You can use any of the following approach to collect the responses:

• Collate the response of each run in an array variable, where each element of the array has the response from one particular run. To collate the responses, configure the Collect values from sub-integration output(s) property.
• Aggregate the responses of all the runs in a single variable. To aggregate the responses, configure the Override values from sub-integration output(s) property.

Note:

• The While Loop task can run a maximum of 8000 iterations. This constraint holds good even if the configured condition results in an infinte loop.
• The cumulative size of the data collected from each sub-integration run cannot exceed 50 MB. If the size exceeds 50 MB, the integration fails, and the downstream tasks are not run.

Configuration properties

The following table describes the configuration properties of the While Loop task.

Property	Data type	Description
API Trigger ID	String	Trigger ID of the sub-integration to run. This value is available in the Trigger ID field of the API Trigger in the sub-integration.
Integration name	String	Name of the sub-integration to run.
While loop condition	N/A	Condition to terminate the loop. The sub-integration runs till the condition is met.
Map to sub-integration input(s)	N/A	Values to pass from the current integration to the sub-integration. The values of this property are in the form of key-value pairs, where the key is a variable in the current integration, and the value is the corresponding input variable in the sub-integration. For example, suppose your main integration has the productID variable, which you want to map to the subIntProductID sub-integration variable; you would select productID from the Integration variable to map from drop-down and enter subIntProductID in the Sub-Integration input to map to field.
Collect values from sub-integration output(s)	N/A	Collate the results of the sub-integration runs. Every time the sub-integration runs, you can store the output of the sub-integration in an array variable of the current integration. Enter the sub-integration's output variable in the Sub-Integration output to collect from field and select the array variable in current integration from the Integration variable to collect into drop-down. Each element of the array has the response from a particular sub-integration run. For example, if the array variable is resultsArray, resultsArray[0] has the response from the first run and resultsArray[1] has the response from the second run.
Override values from sub-integration output(s)	N/A	Read the output variable of a sub-integration run and store it in a variable of the current integration. Select the sub-integration's output variable from the Sub-integration output to map from drop-down, and select the corresponding variable in the current integration from the Integration variable to override drop-down. You can send the overridden variable in the current integration to the next sub-integration run by mapping the variable in the Map to additional sub-integration input(s) property. As a result, you can cumulatively aggregate the responses from the sub-integration runs.
Loop metadata	JSON array	The output variable that has the execution details of the sub-integration runs like the sub-integration execution ID, errors messages, and variable values passed during execution.

Best practices

For information about the usage limits that apply to the While Loop task, see Usage limits.

Retry on failure

You can configure various retry strategies to handle errors in a task. The retry strategies allow you to specify how to rerun the task or integration in case of an error. For more information, see Error handling strategies.