Start and Pause an Integration Schedule

After you define a schedule, you must activate it. You can also pause (deactivate) a schedule, as needed. You can also submit schedules to run immediately.

To start an integration schedule:

1. Go to the Integrations page.
2. Go to the row of the integration on which the scheduled run is defined.
3. Select Schedule from the menu.
   The Schedule and Future Runs page is displayed.
4. Start the scheduled integration in either of the following ways.

   Method

   Steps

   To start an integration based on a schedule. Click the icon. If you are a user with the ServiceAdministrator role, you can change the user with which to submit the schedule. Click Confirm to start the schedule. If you have defined scheduled parameters on this integration, the Schedule Parameters page is displayed. Make any necessary parameter value updates, and click Start Schedule. The following message is displayed in the banner. Pause the schedule when you need to temporarily prevent this integration from running. The button is changed to (stop schedule button). Note: If you want to pause the schedule run, click in the upper right corner, then click Confirm when prompted.

   To start a schedule immediately: Select Submit Now from the menu. If you are a user with the ServiceAdministrator role, you can change the user with which to submit the schedule. The following message is displayed in the banner. Submit Now request to run integration integration_name (version_number) was submitted successfully with instance id number.

   
   

   
   Description of the illustration sched_future_runs.png

   
   
5. Click the instance ID in the banner or select Track Instances from the menu to track scheduled integration progress on the Track Instances page.
   When you click Submit Now or Start Schedule, an instance status and instance ID are created immediately and are visible on the Track Instances page. The following status values are displayed during the course of the scheduled integration lifecycle:

   • Waiting (Typically the state of an instance when it is scheduled to execute sometime in the future.)
   • Paused (The schedule has been paused, meaning the instance is also paused. Unpausing the schedule moves the instance back to the waiting state.)
   • In progress
   • Succeeded
   • Errored
   • Aborted

   
   

   
   Description of the illustration track_int_inprog.png

   
   

   If necessary, scheduled integration instances in the waiting or paused state can be canceled by selecting the icon. This action moves the scheduled integration instance to the aborted state. If this is a regularly scheduled integration (for example, it is scheduled daily at the same time), another instance gets created immediately for the next day's schedule and moved to the waiting state.

   If the scheduled integration run is successful, the status value is updated to Succeeded.

   
   

   
   Description of the illustration track_int_success.png

   
   
6. Click to view the following schedule milestones in the activity stream.
   • Schedule request submitted: Indicates the time at which the request to trigger the scheduled integration was submitted.
   • Schedule request started running: Indicates the time at which the submitted request started executing.
   • Schedule paused: Indicates the time at which a schedule was paused.
   • Schedule resumed: Indicates the time at which the schedule was resumed (from a paused state).
7. Select Schedule from the menu if you want to return to the Schedule and Future Runs page.