--- category: [Administration & Integrations, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions, Platform and Product Extensions/Integration] keyword: [Integrate, Workday Integration, Orchestrate for Integrations, Orchestration, Orchestration Builder] nav: wcp_docs parent_url: /wcp_docs/ title: Define HTTP Polling Configurations layout: subsection --- ### Prerequisites Create a Workday Integration System or Workday Business Process orchestration. ### Context HTTP polling configurations enable you to check the status of external systems without manual intervention. You can reference a polling configuration in any Send HTTP Request step. Note: HTTP polling is designed exclusively for use with external third-party systems. You can't use it in conjunction with the Send Workday API Request component to poll Workday APIs. Orchestration processing pauses while polling is ongoing. It resumes when either: - Specified conditions are met in the external system, or - A specified time period elapses. Example: you create a polling configuration to check when an external system has finished importing the data you need for downstream components in your orchestration. You can perform HTTP polling as part of a group, branch, error handler, or suborchestration as well as in the main body of the orchestration. ### Steps 1. Open your orchestration in Orchestration Builder and click the gear icon to access Orchestration Settings. 2. In the Settings panel, complete these fields on the HTTP Polling tab:
Option Description
NameProvide a name for the polling integration configuration. This is the name by which the configuration is referenced in the Polling Settings section of the Send HTTP Request component's properties panel.
Total Polling Duration (Minutes)Specify how long polling should last in total. The maximum value allowed is 2880 minutes (48 hours).
Starting Interval (Minutes)Specify the starting interval from which polling begins. The minimum value allowed is 1 minute and the maximum is 60 minutes. The default value is 15 minutes.

Orchestrate employs exponential backoff, meaning it conserves resources by doubling the interval between retries after each failed attempt up to the interval maximum of 60 minutes. Retries continue until either the poll succeeds or the Total Polling Duration value is reached.

Example: if you enter a Starting Interval value of 10 minutes and a Total Polling Duration value of 200 minutes, Orchestrate performs polls after intervals of 10 minutes, 20 minutes, 40 minutes, 60 minutes, 120 minutes, 180 minutes, and 200 minutes.

Note: Orchestration Builder displays a 'legacy configuration' notice when you access HTTP Polling settings you created before exponential polling was available. Legacy configurations continue to work as originally designed but don't take advantage of exponential polling until they're modified and saved.

Error On TimeoutSelect this checkbox if you want Orchestrate to log an error when polling times out. You can configure an error handler to take action based on this error.

3. To specify the circumstances under which polling ends, click Add Stop Condition and from the Condition 1 drop-down menu, select a condition type. These are the available types and the conditions they check for: - Header: A specific header type in the HTTP response. - Header Value: A specific value in the HTTP response. - Status Code: 1 or more specific HTTP response codes. - Status Code Range: Any HTTP response code within a specific range. - Custom: A condition that you create using Expression Builder. You can add more than 1 stop condition to your polling configuration. If you do so, polling stops and orchestration processing continues only when all of the specified conditions are met. If the Stop conditions have not been met and Total Polling Duration elapses, the orchestration proceeds using the last polling response as the step's output. You can then build additional workflows which may include logging an error or executing alternative processing steps. 4. Complete the fields relevant to your condition type:
Option Description
HeaderName: The header type you want to check for.
Header ValueName: The header type of the value you want to check for.

Value: A specific value associated with that header type.

Status Code

Codes: The response code or codes you want to check for.

Status Code RangeStart of Range: The first value in the range of response codes you want to check for.

End of Range: The last value in the range.

Custom

Condition: An expression that defines a specific custom condition of your choosing. The expression can use the output of the HTTP step itself (currentStep) or any of these global values:

  • An Orchestrate Expression Language global function.
  • A launch parameter.
  • An app attribute.

It can't use the output of upstream steps.


5. Click Save. ### Result The configuration you created is now available to Orchestration Builder's Send HTTP Request component. You can find it in the component's Settings tab, in the Polling Settings section. Note: Select the Advanced Mode check box if the Polling Settings section isn't displayed. ### Example An external system processes a large file and provides an endpoint where you can check the job status. The job can take several hours to complete. You configure a HTTP polling configuration with these time values: - Total Polling Duration: 120 minutes - Starting Interval: 2 minutes You create 2 stop conditions. The first is a Status Code of 200. For the second, you write an expression that checks the response body for the presence of the word `completed`. The orchestration initiates the file processing and then, using the HTTP polling configuration, checks the external job status endpoint after 2 minutes, then after another 4 minutes, then again after 8 minutes, and so on up to the 60 minute interval limit, until both stop conditions are met or until the total polling time of 120 minutes has elapsed.