Schedules (JSCH)

Schedule objects are powerful and flexible tools to design time and event-driven task management. Schedules are frames where you collect tasks that you want to execute automatically at regular intervals. Schedule objects determine scheduling parameters, such as the periodicity with which the tasks are executed and the times at which they start. Schedules let you modify the properties of the tasks that they contain. Such changes apply to the tasks only when processed within that particular Schedule; the objects themselves are not affected.

Object class: Schedule object

Object type/Short form: JSCH

This page includes the following:

Main Concepts

Designing Schedule objects involves:

  • Defining the Period Duration

    Time frame that determines the regularity with which the tasks are executed. Tasks are executed once within a period. You define it on the Attributes page of the object definition.

  • Defining specific time parameters

    Schedules let you define the start time of each task whose execution you want to automate through them. They also allow you to define an offset in days in relation to the period duration specified for the Schedule.

  • Defining the Period Turnaround Time

    Time at which completed tasks are removed from the Schedule. The same tasks are reloaded for the same period.

    You define it on the Attributes page of the object definition.

For more information, see:

Period Duration and Calendars

Usually, a Schedule object is associated to a Calendar that establishes pre-conditions for executing it. The Calendar defines a constraint to the period that is defined in the Schedule.

Example: A task is executed with the regularity that is defined in the Period Duration but only on working days.

By assigning a Calendar to the Schedule, you combine the period duration definition and the Calendar definition. For more information, see Calendars (CALE)

Period Duration, Period Turnaround Time and Start Times

The period duration and the period turnaround time are cyclical tools that are specific to the Schedule as a whole. Start times and Calendars are defined specifically for each child task.

Tip: Have a look at Example: Scheduling Tasks with Time and Calendar Conditions: This example describes how to set up a Schedule object in which the tasks should meet time constrains.

Objects Automated through Schedules

Schedule objects can handle the automatic processing of the following object types and their sub types:

  • Notifications
  • Events
  • File transfers
  • Groups
  • Workflows
  • Remote Task Manager
  • Jobs
  • Scripts

Schedule Statuses

Schedule objects typically have one of the following statuses:

  • Active, when the Schedule is enabled.
  • Stopped, if you select the Suspend option for the Schedule.

The statuses of both the Schedule and of its tasks are visible in the Process Monitoring perspective.

Working with Schedule Objects

This list provides a quick overview of the steps to carry out when working with schedule objects and of the available functions:

  1. Create a Schedule and add executable objects to it.

  2. Define a Duration Period and a Period Turnaround Time for the entire Schedule.

    For example, if the duration is one day and the turnaround time is midnight, each task is executed once a day and loaded again at midnight.

    3. Optionally, specify individual start times, offsets, and calendars for specific tasks. This parameter allows or denies their execution.

  3. Execute it manually for the first time to activate it, see Activating Schedule Objects.

    Immediately after executing it, the Monitoring option is available when you select and right-click the Schedule object. This option opens the list of Tasks in the Process Monitoring perspective. A filter is pre-set so that only this particular task is displayed in the list. This function helps you check whether the Schedule is performing as you expect.

    4. Open the Schedule Monitor (see Monitoring Schedules). Two scenarios are possible here:

    • The schedule is still running

      You can restart tasks, open their monitor (reports and execution data) and call their details. You can also modify some of its parameters. These modifications apply to only this execution. For more information, see Modifying Active Schedules and Modifying Task Properties in an Active Schedule.

    • The schedule has already finished

      The properties of the tasks are in read-only mode and cannot be modified. You can restart tasks, open the Schedule monitor, access its reports and execution data, and so on.

Tip: Schedules can contain many tasks. Use the export to CSV functionality to get an overview, sort and compare data, and so on. For more information, see Exporting Tables to CSV.

See also: