Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: 'Restricting ... Starts' rewritten

...

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.

Enter a Start Time - here 15:00. Clicking the Save button now will cause the Period configuration to be added to the Order.

Note that the On Holiday Setting - will not function with the calendar configured in the first half of this article. On Holiday only works when a Non-Working Day calendar is used to configure holidays. Such a configuration will be described in the .... Use Case 

Status
titleLink required

The next screenshot shows that two Single Start Periods have been configured - at 15:00 and at 21:00.

...

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 and Order Starts

The situation where Jobs and Orders are not to run on every working day can also be readily incorporated in Calendarsconfigured in a number of ways.

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

Note that in the current calendar configuration (described in the first part of this article), Working Days were defined as being Monday to Friday, less the excluded Holidays. Holidays were not specifically defined. This means that every 3rd Working Day will be quite rigidly interpreted and that more complex handling of holidays (such as execution on the preceding or succeeding day) is not possible. A more flexible configuration using separate Working and Non-Working Day Calendars will be described in the .... Article. 

Status
titleLink required

Configuration Procedure

Re-open the Wkg Day - Mo-Fr Calender Set Run-time modal window for the Order using the Edit Calendar menu item as shown below.

Image RemovedImage Added

Select the Edit Frequency function (pencil icon) in the Update Calendar window as shown:

Image Removed

Click on the "+" symbol to add a new restriction for the Calendar as shown in the next screenshot:

Image Added

In the Add Frequencies modal window which will now open, Now, in the Update Frequencies window select the Recurring Days tab and , complete the fields as shown :

Image Removed

Click Add Frequency and the Frequency entry will be modified as shown in the screenshot above.

in the next screenshot and click Add Frequency.

Image Added

Click Close and the Every 3rd Day Restriction will be added Now click on Close to return to the Set Run-time window.configuration as shown below:

The final configuration, if required, is to edit the Periods and specify the behavior On Holiday.

Image Removed

The default Suppress Execution setting can be seen in the following screenshot

Image Removed

Every 3rd Day Restriction effectively functions as a filter on the wkg_day_mo-fr Calendar. It means that the Order will run on every 3rd day that has been defined as a Working Day and that all other days will simply be ignored. 

As already noted above, Holidays have been specified in the Calendar as excluded Working Days and not as Non-Working Days, effectively excluding any more sophisticated behavior around holidays, such as execution on the preceding day. See for

Status
titleLink required

Checking the Configuration

The configuration can be checked in two ways:

  • With the Edit XML function in the Set Run-time modal window:
    Image Added
  • With the Calendar View window, which is accessed using the Order's Show Calendar function:
    Image Added

The Valid From 1st Jan 2018 setting in the Restriction filters out all dates from dates for 2017 but provides a clear starting point for calculating execution dates in 2018. Note that as the 1st of January is not a Working Day, the Order will be first executed on the 2nd. Execution proceeds regularly until the 15th of January, which is a Non-Working Day (Martin Luther King day) and therefore ignored, with the next execution taking place on the 16th.

 Calculation starts with the 1st of January, which, with the 15th is a non-working day in the USA. Here the wrong values are calculated ....