Skip to end of metadata
Go to start of metadata

Introduction

Each operation can be configured to run automatically by applying a schedule. Schedules contain information about when an operation will automatically be activated. You can define virtually any type of schedule you need, such as every Friday at 5 pm, the last Friday of each quarter, or every hour of a single day.

If an operation running on a schedule has configured operations actions, any downstream operations will also be executed accordingly. If a previously scheduled instance of a scheduled operation is still running when it becomes time for it to be executed by a schedule, the operation will be skipped. 

Schedules can be created and applied directly in Cloud Studio, as covered on this page, or they can be created and applied from the Projects page in the Management Console, where you can also see a list of all schedules assigned to operations within a project, or enable or disable schedules.

When deploying a schedule that has already been deployed in the Harmony cloud, you will be presented with options for selecting which schedules to use. This is covered under Selecting Schedules and Project Variables in Project Deployment.

Other ways to execute operations include executing operations manually or using an API trigger, as covered under Operation Deployment and Execution.

Accessing Operation Schedules

Operation schedules can be accessed from the project pane, the operation settings, or the design canvas depending on if you are creating a new schedule or editing an existing schedule. After creating a schedule or opening an existing schedule to edit, see Configuring Operation Schedules later on this page for configuration.

Project Pane

From the project pane in the Components tab, to create a new schedule, hover over the category Schedules and click the actions menu icon  to open the actions menu. From the menu, select Create new:

To edit an existing schedule, hover over the schedule name, then click the actions menu icon  to open the actions menu. From the menu, select View/Edit. This and other actions in this menu are covered under Accessing Menu Actions later on this page.

Operation Settings

Operation schedules can be accessed from the operation settings that are accessible from the project pane or the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an operation name and click the actions menu icon  to open the actions menu. From the menu, select Settings to open the Schedules tab of the operation settings.
  • Design Canvas: In the top right of an operation, click the actions menu icon  to open the actions menu. From the menu, select Settings to open the Schedules tab of the operation settings.

Design Canvas

To edit an existing schedule that is already assigned to an operation, click the schedule icon  in the top right of the operation to display the Schedules tab of the operation settings:

WARNING: Schedule edits take effect on all operations they are assigned to.

Configuring Operation Schedules

In the Schedules tab of the operation settings, existing schedules that have been created either in Cloud Studio or in the Management Console can be applied to operations. From here you can also create new schedules, edit existing schedules, and dissociate schedules from operations. Each option is described below.

  • Condition: The first dropdown should already show the selection as On Schedule, indicating that the condition on which the operation will trigger is a schedule. There are no other conditions able to be set at this time.
  • Schedule: Use this dropdown to select the existing schedule that you want to apply to the operation. If the schedule you want to use does not yet exist, click on the link Create New Schedule to create a new schedule. This option is covered below.
  • Assign: Click Assign to apply the selected schedule to the operation. Note that only one schedule can be applied to each operation, and that the assigned schedule will not take effect until the project has been deployed.

    When an operation has a scheduled assigned, the Schedule field changes to Assigned Schedule with the details of the assigned schedule displayed, and the options to Assign or Create New Schedule are hidden. In addition, a schedule icon  appears on the operation on the design canvas, which when clicked re-opens the operation schedules screen.

    TIP: When you apply a schedule to an operation, it is a recommended best practice to set an On Fail operation action to trigger an email notification on the scheduled operation.

    • Edit: To edit the assigned schedule, click the edit icon  to open the schedule configuration screen and make any needed changes. Existing schedules can also be accessed from the project pane. In the Components tab, to edit an schedule, hover over the schedule name, then click the actions menu icon  and from the menu select View/Edit.

      WARNING: If the same schedule is assigned to other operations, the edits will affect the schedule for all operations it is assigned to.
    • Remove: To dissociate the schedule from the operation, click the remove icon . Note that the schedule itself will not be deleted, but will simply be unassigned from the operation.

  • Create New Schedule: To create a new schedule, click the link to Create New Schedule. This will open the schedule configuration screen.

    NOTE: The schedule will not be created until after you have configured and saved the new schedule. After the schedule is created, you will then need to select it from the Available Schedule dropdown and click Assign to apply it to the operation.

    • Schedule Name: Enter a name for the schedule. You may want to give the schedule a name that is reflective of the schedule frequency or, if used for a specific operation, reflective of the purpose of the schedule (e.g. "Every 5 Minutes" or "Contact Sync"). The name must not begin or end with a space.
    • Occurrence: Use the dropdown to select one of three options for the days on which the schedule should kick off the operation(s) on which it is assigned:
      • Daily: The schedule will activate the operation every day, or every few days. When this option is selected, these fields become available to configure:
        • Every [#] day(s): Enter a number of day(s) in between operation runs.
      • Weekly: The schedule will activate the operation during a specified set of days of the week. When this option is selected, these fields become available to configure:
        • Every [#] week(s): Enter a number of week(s) in between operation runs.
        • [Sun, Mon, Tue, Wed, Thu, Fri, Sat]: Click to select the day(s) of the week on which you want the operation to run. At least one day must be selected.
      • Monthly: The schedule will activate the operation on a monthly basis. When this option is selected, choose one of two options that become available to configure:
        • Day [#] of every [#] month(s): Enter the day of the month and number of month(s) in between operation runs.
        • The [1st, 2nd, 3rd, 4th, or Last] [Day of Week] of every [#] month: Use the dropdowns to select which day of the month and enter the number of month(s) in between operation runs.
    • Frequency: Select one of two options for the times at which the schedule should kick off the operation on the days that it runs.

      NOTE: The time zone depends on the agent running the operation:

      • Cloud Agents: All Cloud Agents are in UTC.
      • Private Agents: Private Agent time zones may vary based on the time zone of the operating system of the Private Agent. It is highly recommended for all agents in a Private Agent Group to be running on the same time zone, or the times at which a configured schedule kicks off the operation may be unpredictable depending on the specific agent being used.
      • Occurs once at [hh:mm] [AM/PM]: The schedule will activate the operation only once at the time in the text box to the right, which can be specified either using the dropdown or by manually editing the time.

      • Occurs every [#] [Minute(s)/Hour(s)] Starting at [hh:mm] [AM/PM] and Ending at [hh:mm] [AM/PM]: The schedule will repeatedly reactivate the operation for the specified period of time throughout the day. Specify the times throughout the day that you want to limit the operation to run within either using the dropdown or by manually editing the time.
    • Duration: Configure the dates of duration for the schedule.

      NOTE: Start and end dates in a schedule are inclusive.

      • Start Date: By default, the schedule will be active starting on the current date. If you want the schedule to start on another day, use the arrows or the calendar datepicker to select the desired start date.
      • Add End Date: By default, the operation(s) on which the schedule is assigned will run indefinitely according to the schedule. If you want specify an end date, first click the link to Add End Date to add the End Date field. Then use the arrows or the calendar datepicker to set a date that you want the schedule to end.
      • Remove End Date: This link appears once the End Date field is added. To remove the End Date field, click the link to Remove End Date.
    • Save: Click this button to save and close the schedule configuration.

Accessing Menu Actions

After a schedule is created, menu actions for that schedule are accessible from the project pane in the Components tab. Hover over a schedule name and click the actions menu icon  to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the schedule for editing in the Schedules tab of the operation settings (see Configuring Operation Schedules earlier on this page).

    WARNING: Schedule edits take effect on all operations they are assigned to.
  • Delete: This is used to permanently delete the schedule. If there are other project components that are dependent on the schedule (such as an operation that the schedule is currently assigned to), the schedule cannot be deleted (see Component Dependencies, Deletion, and Removal).
  • Rename: This positions the cursor on the component name in the project pane for you to make any edits as necessary.
  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the schedule is dependent on (see Component Dependencies, Deletion, and Removal).
  • Deploy: This deploys the schedule and any components it is dependent on (see Component Deployment).
  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy (see Component Deployment).
  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group. Custom groups are an organizational tool to help organize a project (see Component Groups).
  • Duplicate: This creates a copy of the schedule as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Using Scripts to Schedule Operations

If the options available in the user interface as described in Configuring Operation Schedules do not meet your needs, you can create more complex schedules using scripting.

As an example, a common use case might be to create a schedule to run the operation on the last day of the month. These steps walk through this use case:

  1. Create an operation containing a single script as a project component.
  2. Configure the script as a Jitterbit Script containing script logic that checks for the last day of the month and runs an operation if true. Make sure to replace the operation reference with that of the operation you want to run on the schedule.

    <trans>
    if(DayOfMonth(LastDayOfMonth(Now()))==DayOfMonth(Now()),
    RunOperation("<TAG>operation:Scheduled Operation</TAG>");
    );
    </trans>
  3. Create a schedule that runs every day at the desired time and apply it to the operation containing the script you just created.

  4. The operation chain should look similar to this once these steps are complete:

Enabling or Disabling Schedules

When you create and apply a schedule to an operation, it is enabled by default. Using the Management Console, you can choose to disable or re-enable a schedule (if disabled) remotely from the Projects page.

On the Projects page, this can be done from either the Operations or Schedules tab using the toggle in the Operation Status column to enable or disable a schedule on a single operation, or using the toggle in the Schedule Status column to enable or disable a schedule across all operations that have the schedule applied. Note that disabling a schedule at the project level will cause the Effective Status to be disabled even if the schedule is enabled for an individual operation. For detailed instructions, see Projects (Management Console).

WARNING: In the Cloud Studio interface, there is no indication as to which schedules are enabled or disabled, and it is not possible from Cloud Studio to disable a schedule or re-enable a schedule that has been disabled. Therefore it is important to remember if you disable a schedule, as the only way to tell that it is disabled or to re-enable it is through the Management Console.

Troubleshooting Schedules

If a schedule is not working as expected, check these items when troubleshooting the issue:

  • Have you deployed the operation the schedule is assigned to?
    In Cloud Studio, schedules must be assigned to an operation and then deployed for them to trigger. Once you have assigned a schedule to an operation in Cloud Studio, it will not take effect until it has been deployed. (In contrast, schedules assigned to an operation through the Management Console take effect immediately without needing to redeploy the project to Harmony.)
  • Is the schedule enabled?
    Schedules can be disabled and re-enabled only from within the Management Console. Check the Projects page within both the Operations and Schedules tabs to make sure the schedule is enabled.
  • Do you know what time zone the schedule is in?
    The time zone depends on the agent running the operation.
    • Cloud Agents: All Cloud Agents are in UTC.
    • Private Agents: Private Agent time zones may vary based on the time zone of the operating system of the Private Agent. It is highly recommended for all agents in a Private Agent Group to be running on the same time zone, or the times at which a configured schedule kicks off the operation may be unpredictable depending on the specific agent being used.
  • If you are using a Private Agent, is the scheduling service running?
    On the machine where the Private Agent is installed, check that Jitterbit Scheduler and Jitterbit Scheduler Service are running. On Windows this can be checked through the Task Manager under Processes.
  • If you are using a Private Agent, are aggressive schedules overloading the Agent Group?
    If using Private Agents, additional evaluation should be made to ensure that too many schedules within a short time period will not overload the Agent Group, causing an operation backlog.

    Private Agents default to being able to execute up to two times the CPU count for each agent machine. For example, if the Private Agent machine has 4 CPU cores, you will be able to process up to 8 concurrent operations.

    When evaluating the requirements, some of the operations may be more time-dependent than others. If several non-critical operations were to backlog the agent queue, then more critical operations could be affected. To avoid this, determine the number of operations the Agent Group can process concurrently (using the CPU count calculations described above), and then balance that against the business priority and runtime duration of the scheduled operations.

On This Page

Last updated:  Apr 15, 2020

  • No labels