Edit-scenario
A Scenario is the outermost object in the task hierarchy. It must exist before any Group can be created in it.
Creating a scenario requires an existing Connection if it is to use SQL-based or REST planning, because the planning query runs through one.
Contents
Creating a scenario
- Open Author → Tasks.
- Click Add scenario in the task hierarchy header.
- Fill in the fields below.
- Click Save.
To edit an existing scenario, select it in the tree.
General fields
| Field | Notes |
|---|---|
| ID | Assigned automatically; read-only. |
| Name | Mandatory and unique. Naming rules as in Authoring items#Naming rules. |
| Enabled | When cleared, no further instances are planned. Instances already planned run to completion. |
| Start date / End date | Validity, evaluated against the processing date — not the calendar date on which the run executes. |
| Description | Free text. |
Limits
| Field | Range | Meaning |
|---|---|---|
| Parallel limit | 0–999 | Maximum number of tasks in this scenario running in parallel. |
| Load limit | 1–999999 | Maximum sum of task weights running in parallel within this scenario. |
See Resource management. These are scenario-wide; groups and connections have their own limits, and the stricter one always applies.
Planning type
Selecting the Planning type changes which additional fields appear.
| Type | Additional fields |
|---|---|
| Standard daily | Schedule base, workdays only, lag, iteration prefix |
| File-based | Base directory and file name regular expression |
| SQL defined | Connection, query, polling frequency, check type |
| REST polling | Connection and the REST polling settings |
| Manual | None — the scenario is only started on request |
The behaviour of each mode is described in Planning; the fields themselves in Scenario.
Not before / Not after
These apply to every planning type. Not before delays planning until the given time; Not after prevents planning starting after it. For SQL-based planning, the query is not even executed outside the window.
Notifications
| Field | Meaning |
|---|---|
| Notify start | A single notification sent once the scenario has been planned. |
| Notify finish | A single notification sent once processing of the scenario has finished and the processing is closed. |
| Notifications | A list of notifications sent when any task in this scenario fails. |
Notify start and Notify finish each take one notification; the Notifications list takes any number. Add entries by typing into the Add... box and picking from the suggestions; remove them with the button beside each entry. Changes to this list apply immediately and are not part of Save.
See edit-notification.
Running a scenario manually
The Run... button starts the scenario on request, for a chosen date and iteration. It is disabled when the scenario contains no enabled task — the tooltip says so.
This is the only way to start a scenario whose planning type is Manual. It also works for the other types, which is useful for a one-off run outside the normal trigger.
Practical notes
- Group related work into one scenario, unrelated work into separate ones. Everything in a scenario shares a planning event, so unrelated tasks placed together are forced to wait for the same trigger.
- Set validity dates rather than deleting. A scenario that is finished with can be given an end date, preserving its history.
- Deleting a scenario is only possible when nothing references it — its groups must be removed first.
