Schedule Objects (JSCH)

Schedule objects are a powerful and flexible tool to design both time and event-driven task management. They allow you to define parameters that start tasks automatically at user-defined intervals; Schedules are the core automation objects.

Object Definition

Object class: Schedule object

Object type/Short form: JSCH

This topic provides information on the following:

• Overview
• Objects Automated via Schedules
• Schedule Statuses
• Working with Schedule Objects

Have a look at Defining a Schedule with Tasks with Time and Calendar Conditions, where you will find detailed descriptions on how to set up a Schedule object in which the tasks should meet time constrains.

Overview

Schedule objects are efficient frames to collect tasks that you want to execute at regular intervals. On the one hand, they provide options to define scheduling parameters, such as the periodicity with which the tasks in the schedule should be executed and the times at which they will be started. On the other, they allow you to modify the properties of the tasks you have included in the schedule. These changes apply to the tasks only when processed within the schedule, the objects themselves are not affected by them.

Designing schedule objects involves:

• Defining the Period Duration, that is, the time frame that determines the regularity with which the tasks will be executed.

  You define it on the Attributes Page. Tasks are executed once within a period.

• Defining specific time parameters for the tasks included in the Schedule, such as task start time and offset in relation to the period specified for the Schedule. If necessary, you can modify certain properties of the tasks. You do this in the Schedule page (see Defining Schedule Objects).
• The Period Turnaround Time, which is the time at which completed tasks are removed from the Schedule and the same tasks are reloaded for the same period. You define it on the Attributes Page.

Usually, a Schedule object is associated to a Calendar Object (CALE), which establishes pre-conditions for executing it; the Calendar defines a constraint to the period defined in the Schedule. For example, you can specify that a task in the Schedule be executed with the regularity defined in the Period Duration but only on working days.

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.

After reading the basic Schedule information available here, we recommend you taking a look at Defining a Schedule with Tasks with Time and Calendar Conditions for an example with step-by-step instructions and an explanation of how a Schedule works.

Objects Automated via 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 a
• 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 status of both the Schedule and of its tasks is visible in the Process Monitoring perspective

Working with Schedule Objects

The list below 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 midnight, each task in the Schedule will be executed once a day and loaded as a definition at midnight.

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

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

   Right after executing it, the Monitoring option is available when you select and right-click the Schedule object. This opens the Process Monitoring perspective with a pre-set filter that displays this task in the list. This helps you check whether the Schedule is performing as you expect.

5. Open the Schedule Monitor (see Monitoring Schedules). There are two possible scenarios 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. See Modifying the Schedule Definitions from the Monitor as well as Modifying the Properties of Tasks at Runtime.

   • 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, etc.

See also: