| Table of Contents |
|---|
Introduction
JobScheduler Calendars can be configured to meet a wide range of business requirements. This article first describes how to configure a basic five-day working day Calendar and then modify the Calendar so that an Order is only executed every third business day.
Article Scope
This article describes how to configure basic Calendars with the intention that users will be able to adapt the procedures described to meet a large part of their everyday needs. This article is not intended to provide a description of all the possible configuration items. An overview of the JOC Cockpit's Calendar feature is provided in the JOC Cockpit - Calendar Management article.
Configuration Steps
Create Calendar
Calendars are created in the JOC Cockpit Resources / Calendars view by clicking the Add Calendar button as shown in the first screenshot.
...
If a Valid From date is not set then the current date will be used.
Configure a Monday to Friday Working Week
The working days are configured by specifying a number of Frequencies for the Calendar. Frequencies are rule sets for weekdays, month days, recurring days etc.
...
Note that no configuration information has not yet been saved.
View the configured Frequency
Click on the Calendar icon under the Action header. This will open a preview of the Calendar.
...
Now click on the Close button to close the preview and then click on Close in the Add Frequencies modal to return to the Create Calendar window which will display the list of Included Frequencies as shown.
Exclude National Holidays from the List of Working Days
Now click on the Excluded Frequencies tab to add days for which no jobs should be executed and then on the Add Frequency button.
...
This Calendar is now ready to be used for an Order or Job.
Assigning the Calendar to an Order
Go to the Job Chains view and select an Order. The Job Chain and Order to be used for this article are shown in the screenshot below.
...
The next screenshot shows how the Edit XML button in the Set Run-time window can be used to inspect and edit individual entries in the Calendar configuration:
Configuring the Periods (Run-Times) for the Order
Periods are used to specify the time or times at which a Job or Order will run on the days that have been specified in the Calendar. Configuration of a new Period is started by clicking on the + symbol alongside the relevant calendar as shown in the screenshot above. This will open the Create Period modal window.
...
A short time after this is carried out the Next Start time for the Order should change from 00:00:00 to the correct value - in this case 24.11.2017 21:00 as shown in the screenshot below.
Inspecting the Configuration
The Show Assigned Calendars menu (ellipsis symbol shown in the previous screenshot) can be used to show which calendar(s) has or have been Assigned to an Order as shown in the next screenshot:
...
Individual Period starts are shown in the Monthly views (first screenshot below) and unspecified and excluded days are highlighted in the Yearly view (second screenshot below).
Restricting Job Starts
The situation where Jobs and Orders are not to run on every working day can also be readily incorporated in Calendars.
This section of the article describes how to extend the configuration so that the Order only runs on every 3rd working day, taking account of holidays and weekends.
Procedure
Re-open the Wkg Day - Mo-Fr Calender using the Edit Calendar menu item as shown below.
...