Skip to main content

Schedule instances

In briefA schedule instance lets one workflow build more than once for the same date, once per named instance, each with its own property values. One PAYROLL definition runs as PAYROLL_BRANCH1 and PAYROLL_BRANCH2 side by side, and each instance has its own build numbers.

WhereInstances are defined in the workflow editor's Workflow Settings panel: turn on Allow Multi-Instance on the Overview tab, then add them on the Instance Properties tab with Add New Instance. A build names one in Processes › Schedule Workflow, in the Schedule Instance picker. A built instance appears as Workflow_Instance in the Processes grids.

When

  • The same sequence of jobs runs for several branches, regions or entities, over different data.
  • You want one definition to maintain instead of a copy of the workflow per branch.
  • You need to build one branch on its own, or rebuild it, without touching the others.

If you need one job to fan out inside a single run, use a multi-instance job instead; that is a different mechanism, named with a dot rather than an underscore.

How

  1. Turn on Allow Multi-Instance and add each instance, with a name and its properties, on Instance Properties.
  2. Read the values in job commands with the SI scope, such as [[SI.BRANCH_CODE]].
  3. Commit and deploy, then build from Processes › Schedule Workflow, choosing All instances or one by name.

The full steps are on Workflow Settings.

Notes
  • Instance names are case-sensitive, unique within the workflow, 40 characters or less, and follow the workflow-name character rules. (unnamed) is reserved.
  • Property names within one instance must differ by more than case; Create Version is blocked until a pair such as Region and region is renamed.
  • A dependency or conflict inside one workflow resolves within the same instance.
  • An event that acts on a built schedule takes an optional, last Named Instance field.
Watch out
  • An encrypted instance property is not copied onto the run, so [[SI.…]] cannot read it.
  • Changing Allow Multi-Instance after a date is built makes the next build of that date refuse with IDENTITY_CONFLICT unless you overwrite.
  • An event against a date with several instances built, or a job that exists in several, is refused unless it names the instance.