Page History
Table of Contents |
---|
Introduction
JS7 offers provides JS7 - Calendars for use with JS7 - Schedules:
- Calendars specify the days for which Orders on which orders for executing workflows can be created by Schedules to execute Workflows.
- Schedules can further limit the days suggested by a Calendar and specify the time for at which Orders orders are scheduled.
Calendars and Schedules are highly flexible and allow a large number of rules specifying when workflows can be executed.
- A Calendar can be used by any number of Schedules.
- As each Schedule can limit the days for workflow execution within the scope of a Calendar, there is no need for a large number of Calendars.
- Typically one to five Calendars are sufficient for an organization, for example using specific Calendars for all days, for company business days, for department business days, etc.
Manage Calendar
Add Calendar
Calendars are available from can be accessed in the Configuration->Inventory View in in the respective relevant sub-folders.
- The tree in the left panel offers an action menu to create for creating a calendarCalendar.
- The action menu is available from the any Calendars object folder.
When adding a Calendar a popup window asks for the object name:
As a result This results in an empty Calendar object becomes becoming available:
- Calendars are configured for either working days or non-working days:
- Working day Calendars specify the business days for on 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 ,or
- after end of its validity period.
...
The selection of days in a Calendar is managed by use of using Frequencies:
- Any number of Frequencies of the same or different type can be added.
- Similar to a Calendar Calendars, each Frequency can further limit the its validity period. However, a Frequency cannot anticipate or exceed its Calendar's validity period.
Typical Frequencies include for example:
...
When using the Add Frequency button for a Calendar the following popup window offers to select allows a Frequency to be selected:
- Any number of the same or different Frequencies can be added to a Calendar.
- Frequencies are merged to calculate the resulting days of for the given Calendar.
Frequency Type: Weekdays
This option offers to select allows the days of week to be selected.
Frequency Type: Specific Weekdays
This option offers to specify allows a day of in the week and its occurrence in a month to be specified.
Frequency Type: Specific Days
This option lets users freely select dates from a yearly calendar.
...
- 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 Users will find the list of available Frequencies for the Calendar object : as Frequencies are added. The following Actions are offered for each Frequency:
- The icon shows the preview of days for the given Frequency.
- The icon allows to edit editing of the given Frequency.
- The icon removes the given Frequency.
...
The Included Frequencies filter button specifying the days for workflow execution is active from the Calendar object by default.
- Users can choose to click the button for Excluded Frequencies that specifies days on which workflows should not be executed.
- A Calendar can have both Included Frequencies and Excluded Frequencies at the same time.
- Days specified in Excluded Frequencies are excluded from the resulting days when calculating resulting days for a Calendar.
Show Preview
The Calendar object view offers provides the Show Preview button:
- A This displays a preview of the merged days of all the 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 indicated by the icon and from the orange bullet.
- The draft status is in place when a Calendar has been added or modified and has not yet been released.
- In addition, a draft Calendar can be invalid as indicated by the icon. This can be due to missing input or invalid data added to the Calendar by the user.
- Invalid Calendars are automatically stored in the same ways as valid Calendars. However, they cannot be released until they have been validated.
- Validation is performed with a JSON Schema, see JS7 - Inventory Storage Format.
- Draft Calendars are ignored by the Daily Plan when creating Orders orders for Workflow workflow execution.
- The draft status is in place when a Calendar has been added or modified and has not yet been released.
- A released status is visible from the icon and from the blue bullet.
- Only Valid Schedules can be released.
- Released Calendars are used by Schedules when creating Orders orders for Workflow workflow execution with the Daily Plan.
- In addition, released Calendars are considered when manually creating the Daily Plan from the relevant view.