Run cycle group definition
You can schedule workflows based on common run cycle groups.
A run cycle group is a single, reusable item that contains one or more run cycles. The combined rules of these run cycles determine the specific dates and times when an associated workflow runs. By using a run cycle group, you define complex scheduling rules once, removing the need to maintain the same logic repeatedly within every individual workflow.
To manage these rules effectively, run cycles are organized into logical containers called subsets, which enable you to group related scheduling conditions and define how they interact with one another. For example, you can use one subset to define all inclusion dates and a second subset to define exclusion periods, ensuring a clean separation between when a task should run and when it is forbidden.
- Subsets
-
A run cycle group contains one or more subsets, which define specific criteria for the overall scheduling logic. Subset break down complex schedules into smaller and manageable sections. By grouping related run cycles together into separate subsets, you can maintain different streams of scheduling logic within a single reusable item.
Each subset consists of run cycles, which are categorized into two types:- Inclusive run cycles
- A subset requires one or more inclusive run cycles, which define the positive set of dates and times when a workflow must run.
- Exclusive run cycles
- A subset can optionally include exclusive run cycles, which define a negative set of dates and times when a workflow must not run. An exclusive run cycle defines specific exceptions to the dates generated by the inclusive cycles within the same subset.
- Logical operators
- Logical operators combine the results of multiple run cycles within a single
subset:
- Union operator:
OR - The
ORoperator merges the results of all the combined run cycles to create a single set of dates and times for the subset.- Example
- A subset contains two run cycles:
RC1, which runs every Monday, andRC2, which runs on the 27th of the month. TheORoperator ensures that the workflow runs on every Monday and every 27th of the month.
- Intersection operator:
AND - The
ANDoperator identifies the common dates and times shared among all combined run cycles.
- Union operator:
- Combining subsets
- The final schedule of the run cycle group is determined by combining the results of all the run cycle group subsets. Subsets always merge using the OR union operator. This process merges the schedules of all subsets to create a single, comprehensive set of dates and times occurrences for the entire run cycle group. If multiple run cycles identify the same date and time, for example, a monthly run cycle and a weekly run cycle both identifying a specific Monday, the associated workflow is only triggered once.
- Workflow scheduling
- To schedule a workflow by using a run cycle group, define a run cycle on the workflow that references that run cycle group. This process is similar to defining a run cycle based on a calendar, but uses the comprehensive schedule generated by the run cycle group instead.
- Configuration inheritance
- Each run cycle includes its own configuration settings. To improve efficiency,
you can also define these settings at the run cycle group level. The system
applies the following inheritance rules:
- If a setting is defined in both the run cycle and the run cycle group, the value in the run cycle takes precedence.
- If a run cycle does not specify a setting that is defined at the run cycle group level, the run cycle inherits the group-level value.
- Non-working days rule
- The run cycle group uses a designated non-working days calendar to determine how
to handle dates that fall on a non-working day. When a calculated run date falls on a non-working day defined in the Non-working days calendar, the run cycle group applies a shift rule. You can configure the following behaviors:
- Closest preceding
- Shifts the run date to the nearest workday before the non-working day.
- Closest succeeding
- Shifts the run date to the nearest workday after the non-working day.
- Ignore
- Keeps the run date on the non-working day regardless of the calendar. From the HCL Universal Orchestrator UI, you can choose this option by selecting None from the Non-working days rule drop-down menu.
- Cancel
- Suppresses the occurrence if it falls on a non-working day. From the HCL Universal Orchestrator UI, you can choose this option by selecting Do not select when non-working day from the Non-working days rule drop-down menu.
- Validity periods
- Each run cycle within a group can have an active time frame. Use the Valid
From and Valid To settings to control when a specific rule is
active. Note: The Valid To date is typically exclusive; the run cycle is no longer active starting from the beginning of that day.
Run cycle groups can be managed from the Orchestration CLI and from the UI. When defining a run cycle group from the UI, the Run Cycle Preview helps you understand their impact on the run cycle group by highlighting when instances are added or removed on specific days. For more information, see Run cycle preview.