Schedule Integrations

You can schedule integrations and integration sets A sequence of integrations that can be run on-demand or be scheduled. to run once later or at a recurring frequency.

  1. Click Tap Main Menu  > Maintenance > Integrations. 
  2. Click Tap Schedule Processes .

    Note: If you don't see this button, click tap Run Processes to toggle the labels.

  3. Click Tap Schedule an Integration . 
  4. Select the integration or integration set from the list. Click Tap Select. 
  5. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, you use the default name which ends with a date and time stamp.

    Note: For integration sets, include "IntegrationSet" in the name to make it easier to distinguish integration sets from single integrations on the Integrations page.

  6. Select or enter any parameters or files that are required. Required and optional parameters, and external files vary by integration.

    Caution: For integration sets, repeat this step for each integration in the integration set.

  7. In Schedule, select one of the following:

    Caution: Although integrations run in parallel and independently, if you schedule the same integration or integration set to run repeatedly at short intervals, errors can result. Also frequent runs increase the traffic load on the network. A best practice is to space runs at least 15 minutes apart. Example: If two integrations access and update a file, the first integration must finish the update before the second integration starts to update the same file. If the first integration moves or erases that file before the second can access it, the second integration fails.

    • One-time Scheduled Run

      1. Select a date . 
      2. Click Tap Apply.
      3. Enter the Start Time. 
      4. Click Tap Schedule Integration. 
      5. Close the panel.

    • Recurring Scheduled Run

      Repeat the run on a regular schedule.

      1. Click Tap Recurrence .
      2. From Repeats, select the frequency of runs:

        By Month

        • Select the months.
        • Select the day of the month.

        By Day — Select the number of days between runs.

        By Hour — Select to run the integration once every hour from the Start Time.

        By Week

        • Select the number of weeks between runs.
        • Select the day of the week.

        By Minute — Select 5-minute intervals.

      3. Select the Start Date. 
      4. Enter the Start Time. 
      5. Select the End Date. If you select Forever or leave the End Date blank, the schedule recurs indefinitely. 
      6. Click Tap Apply.
      7. Click Tap Schedule Integration Request. 
      8. Close the panel.
      9. Close the panel.
  1. Click Tap Main Menu  > Maintenance > Integrations. 
  2. Select Timeframe  or the arrows or to change the time period.
  3. (Optional) Show only scheduled integration runs. Click Tap Integrations to Manage  > Scheduled Integration Requests.
  4. Select a scheduled  integration.

    Note: Click Tap Grid view . Double-click a scheduled integration run to edit the schedule.

  5. Do one of the following:

    • Edit the schedule or other parameters
      1. Click Tap More  > Edit  or Copy .
      2. Select Edit Scheduled Integration Request to change the currently scheduled integration.
      3. Edit the dates, times, recurrence, any options to exclude groups of employees, or other parameters as needed.
      4. Select Apply.
      5. Select Schedule Integration Request.
      6. Close the confirmation.
    • Delete scheduled integrations from running in the future
      1. Click Tap More  > Delete .
      2. Click Tap Yes to confirm. The underlying integration template remains available and is not deleted.
    • Enable or disable scheduled integrations

      You can disable scheduled runs of integrations and integration sets and enable them later.

      When you create a schedule for an integration or integration set, the schedule is enabled automatically.

      When you refresh, clone, or reset a tenant, scheduled runs of integrations and integration sets are copied to the tenant but are disabled from running. You do not have to recreate these scheduled runs manually, and can enable them from the Integrations page.

      • To enable a disabled scheduled run, click tap More  > Enable .
      • To disable an enabled scheduled run, click tap More  > Disable .
  6. Close the panel.