viewing Apigee X documentation.
View Apigee Edge documentation.
The Timer task lets you add a time delay to the integration execution flow.
During an integration execution, when the control reaches the Timer task, execution is paused for the specified time limit, and all tasks after the Timer task are suspended. The integration resumes the execution after the time limit expires.
Configure the Timer task
To configure the Timer task:
- In the Apigee UI, select your Apigee Organization.
- Click Develop > Integrations.
- Select an existing integration or create a new integration by clicking CREATE INTEGRATION.
If you are creating a new integration:
- Enter a name and description in the Create Integration dialog.
- Select a Region for the integration from the list of supported regions.
- Click Create.
This opens the integration in the integration designer.
- In the integration designer navigation bar, click +Add a task/trigger > Tasks to view the list of available tasks.
- Click and place the Timer task element in the integration designer.
- Click the Timer task element on the designer to view the Timer task configuration pane.
- Configure the remaining fields using the Configuration properties for the task as detailed in the tables below.
- Changes to the properties are saved automatically.
The following table describes the configuration properties of the Timer task.
||Integer||Time (in minutes) till which the integration execution must be paused. The maximum time limit is 44640 minutes (31 days) which is also the default value. Integration automatically resumes the execution of the next downstream task after the expiry of the time limit.|
Compare Approval task, Suspend task, and Timer task
All the three (Approval, Suspend, and Timer) tasks perform a similar function of pausing and resuming an integration. However, there are subtle differences among them. The following table describes the differences amongst the three tasks.
|Approval task||Suspend task||Timer task|
|Doesn't support automatic resumption of an integration and requires manual intervention to resume the integration.||Supports both manual and automatic resumption of an integration. If there is no manual intervention to revoke the suspension, the integration will automatically resume execution after the expiry of the suspension time limit.||Supports only automatic resumption of an integration. The integration execution automatically resumes after the exipry of the suspension time limit.|
|Can't resume an integration via an API call. You must manually resolve the suspension by using the Integrations UI.||Can resume an integration by using the
||Supports only automatic resumption of an integration.|
|Users receive notification when an integration pauses (suspended).||Users don't receive any notification when an integration pauses (suspended).||Users don't receive any notification when an integration pauses (suspended).|
|Supports a output variable (boolean), which allows you to perform conditional checks
before resuming an integration. However, the output variable can only have
the value as either
||Supports a output variable (string), which allows you to perform conditional checks before resuming an integration. You can set any value to the output variable.||Doesn't support any output variables.|
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.