Introduction
JS7 offers JS7 - Calendars for use with JS7 - Schedules:
- Calendars specify the days for which Orders can be created by Schedules to execute Workflows.
- Schedules can further limit the days suggested by a Calendar and specify the time for which Orders are scheduled.
Manage Calendar
Add Calendar
Calendars are available from the Configuration->Inventory View in in the respective sub-folders.
- The tree in the left panel offers an action menu to create a calendar.
- The action menu is available from the Calendars object folder.
When adding a Calendar a popup window asks for the object name:
As a result an empty Calendar object becomes available:
- Calendars are configured for either working days or non-working days:
- Working day Calendars specify the business days for which orders for workflow execution are scheduled.
- Non-working day Calendars specify days that are excluded from workflow execution.
- Both calendar types can be combined with precedence being given to non-working days for any overlapping days.
- Calendars can be limited by a validity period that specifies the begin and end of validity respectively. A Calendar does not calculate days that lie
- before begin of its validity period,
- after end of its validity period.
Add Frequencies
The selection of days in a Calendar is managed by use of Frequencies:
- Any number of Frequencies of the same or different type can be added.
- Similar to a Calendar each Frequency can further limit the validity period. However, a Frequency cannot anticipate or exceed its Calendar's validity.
Typical Frequencies include for example:
- Weekdays: Monday to Friday, every week,
- Specific Weekdays: every first Friday, every last Monday in month
- Specific Days: days selected from a yearly calendar
- Month Days: 3rd of month, last of month, last-3 of month
- Recurring Days: every 2nd day in every month,
- National Holidays: for a country for the particular year.
When using the Add Frequency button for a Calendar the following popup window offers to select a Frequency:
- Any number of the same or different Frequencies can be added to a Calendar.
- Frequencies are merged to calculate the resulting days of the given Calendar.
Frequency Type: Weekdays
This option offers to select the days of week.
Frequency Type: Specific Weekdays
This option offers to specify a day of week and its occurrence in a month.
Frequency Type: Specific Days
This option lets users freely select dates from a yearly calendar.
Frequency Type: Month Days
This option specifies relative days in a month:
- in ascending order from the 1st, 2nd, 3rd etc.
- in descending order from the last, last-1, last-2 etc.
Manage Frequencies
With Frequencies being added users find the list of available Frequencies for the Calendar object: Actions are offered for each Frequency:
- The icon shows the preview of days for the given Frequency.
- The icon allows to edit the given Frequency.
- The icon removes the given Frequency.
From the Calendar object by default the filter button for Included Frequencies is active that specifies days for workflow execution.
- Users can choose to click the button for Excluded Frequencies instead that specifies days for which no workflows should be executed.
- A Calendar can have both Included Frequencies and Excluded Frequencies at the same time.
- When calculating resulting days of a Calendar then any days from Excluded Frequencies are excluded from the result.
Show Preview
The Calendar object view offers the Show Preview button:
- A preview of merged days of all included Frequencies is displayed.
- The preview can further be limited by selecting from the list of available Frequencies.
Release Calendar
Calendars are not deployed to a Controller and Agent. Instead they are used by the JS7 - Daily Plan Service to create orders for workflow execution at the given days.
Calendars therefore know a draft status and a released status:
- A draft status is visible from icon and from the orange bullet.
- Draft Calendars are ignored by the Daily Plan when creating Orders for Workflow execution.
- A released status is visible from the icon and from the blue bullet.
- Released Calendars are used by Schedules when creating Orders for Workflow execution with the Daily Plan.