Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Creating a New Schedule or Opening an Existing Schedule

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 A new schedule can be created from the project pane in the Components tab, to create a new schedule, hover over the category Schedules and click the actions menu icon Image Removed to open the actions menu. From the menu, select Create New:

Image Removed

To edit an existing schedule, hover over the schedule name, then click the actions menu icon Image Removed to open the actions menu. From the menu, select View/Edit. This and other actions in this menu are covered under Schedule Actions Menu 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 Image Removed 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 Image Removed 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 Image Removed in the top right of the operation to display the Schedules tab of the operation settings:

Image Removed

...

's Components tab using the Create New option on the Schedules category (see Category Actions Menu in Project Pane Components Tab). New schedules are created with the default name New Schedule. Subsequent new schedules with default names are appended with an incremented number in parentheses.

An existing schedule can be edited from the project pane's Components tab using the View/Edit option on a schedule component (see Component Actions Menu in Project Pane Components Tab).

To edit an existing schedule that is already assigned to an operation, click the schedule icon Image Added in the operation toolbar to display the Schedules tab of the operation settings.

The Schedules tab of the operation Settings can also be accessed from these locations:

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

...

  • 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 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

    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.

      Warninginfo
      WARNINGNOTE: If  If the same schedule is assigned to other operations, the edits 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 is not deleted, but is simply unassigned from the operation.

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

    Info
    NOTE: The schedule is not created until after you have configured and saved the new schedule. After the schedule is created, you 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.

      Info

      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:ss] [AM/PM]: The schedule will activate the operation only once at the time specified. Specify the time by using the top slider to adjust the hour or the bottom slider to adjust minutes.
      • Occurs Every [#] [Minute(s)/Hour(s)] Starting at [hh:mm:ss] [AM/PM] and Ending at [hh:mm:ss] [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 by using the top slider to adjust the hour or the bottom slider to adjust minutes.
    • Duration: Configure the dates of duration for the schedule.

      Info

      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 date/time picker 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 date/time picker 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 to save and close the schedule configuration.

...

After a schedule is created, menu actions for that schedule are accessible from the the project pane in the Components tab. Hover over a schedule name and click the actions menu icon Image Removed to open the actions menu's Components tab (see Component Actions Menu in Project Pane Components Tab).

Each of these menu actions is available:

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

    Warninginfo
    WARNINGNOTE: Schedule  Schedule edits take effect on all operations they are assigned to.
  • Delete: Permanently deletes 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: Positions the cursor on the component name in the project pane for you to make any edits as necessary.
  • View Dependencies: 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: Deploys Cut: Places a copy of the schedule on your clipboard and deletes the original schedule from the project (see Component Reuse).
  • Copy: Places a copy of the schedule on your clipboard (see Component Reuse).
  • Duplicate: Creates a new, unreferenced schedule using the same configuration as the original schedule (see Component Reuse).
  • Deploy: Shows these menu actions:
    • Deploy: Deploys the schedule and any components it is dependent
    on
    • on (
    see  Opens
    •  Opens the deployment screen
    , where you can select project components to deploy (see Component Deployment
  • Rename: Positions the cursor on the schedule name for you to make any edits as necessary.
  • View Dependencies: 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).
  • Add to Group: Opens  Opens a prompt dialog to create a new custom group or to add the component schedule to an existing group . Custom groups are an organizational tool to help organize a project (see Component Groups).Duplicate: Creates a copy of the schedule as a new, unreferenced component. On creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component(see Component Groups).
  • Delete: Permanently deletes the schedule (see Component Dependencies, Deletion, and Removal).
  • Remove: This option is not currently functional.

Using Scripts to Schedule Operations

...

  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.

    Code Block
    <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:

...

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 causes the Effective Status to be disabled even if the schedule is enabled for an individual operation. For detailed instructions, see Projects (Management Console).

Warninginfo
WARNINGNOTE: 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

...

Easy Heading Free
headingIndent0
expandOptiondisable-expand-collapse
navigationTitleOn This Page
wrapNavigationTexttrue
navigationExpandOptionexpand-all-by-default

HideElements
metastrue