Workflow Settings
- Synopsis
- Full Details
In briefThe Workflow Settings panel, on the right of the workflow editor, is where you create a workflow: you name it and choose its workspace. Its Overview tab decides which days are working days, which holidays are skipped, when the workflow starts, and, with Auto Build on, which dates are built. Its Instance Properties tab defines named schedule instances, so one workflow can run once per branch, region or entity.
- A new workflow starts in the General workspace. A name is required and must be unique.
- Start Time is what every job offset counts from.
- With Allow Multi-Instance on, each date builds once per named schedule instance, and dependencies stay within one instance.
- Built runs are not removed automatically: a run stays in Processes until you delete it or a rebuild replaces it.
- Overwrite Existing across a date range replaces every matching run in it.
Every workflow has a Workflow Settings panel on the right of the workflow editor. It is where you name a new workflow and choose its workspace, and where you set the workflow-wide rules: which days it works, which holidays it skips, when it starts, and whether its runs are built for you. Set these before you add jobs. The jobs' own timing, on each job's Frequencies tab, is covered in Add jobs to a workflow.
A workflow scheduled wrong (wrong days, no holiday handling, or built too early) either runs when it shouldn't or isn't ready when the business needs it.
Create the workflow
You need the Workflows Create permission in at least one workspace. Without it, New Workflow is not available.
To create a workflow, complete the following steps:
- Go to Workflows.
- Open the Workflow Name list at the upper left of the editor and select New Workflow.
- In the Workflow Settings panel, enter a Workflow Name. A name is required, and it must be unique.
- Choose the Workspace. A new workflow starts in General, and the list offers the workspaces you can create or edit workflows in.
The new workflow opens on an empty canvas. Your changes are kept as a temporary draft in your browser until you commit a version: see Version and deploy a workflow.
The panel has four tabs:
| Tab | What you set there |
|---|---|
| Overview | Working days, holidays, the start time, multi-instance, and the automatic build. See Set how the workflow builds. |
| Instance Properties | The named schedule instances, and the property values each one carries. See Run one workflow per branch, region, or entity. |
| Event Trigger | Events that fire once, when the whole workflow completes. See Workflow completion events. |
| Documentation | Free-text notes about the workflow. |
Set how the workflow builds
In the workflow's Workflow Settings panel, on the Overview tab, set how the day's run is created:
- Under Workflow Schedule, Working Days, Use Master Holiday Calendar and Additional Holidays exclude days the workflow shouldn't run. Use Master Holiday Calendar is on for a new workflow and applies your organization's Master Holiday Calendar; Additional Holidays adds a calendar of holidays for this workflow alone. Start Time is what the job offsets count from.
- Under Multi-Instance, Allow Multi-Instance builds each date once per named schedule instance rather than once — see below.
- Under AutoBuild Settings, turn on Auto Build to give the workflow build settings. With it
off, the workflow has none and every run of it is built by hand. Turning it on fills in 7 Days in
Advance and 1 Days to Build, with the two switches off; the fields can be changed only while
it is on. A workflow marked Sub-Workflow has no AutoBuild Settings section.
- Days in Advance and Days to Build: which dates are created. Days in Advance is the offset
of the first date —
0is today — and Days to Build is how many consecutive dates follow it. - Overwrite on Build: let a rebuild replace an existing run for the same date.
- Build on Hold: build the run held, so it won't start until you release it.
- Days in Advance and Days to Build: which dates are created. Days in Advance is the offset
of the first date —
Built runs are not removed automatically. A run stays in Processes until you delete it or a rebuild replaces it. A rebuild with overwrite is refused while any job in the run, or in a sub-workflow nested inside it, is still running or finishing, or while the platform is starting one of its jobs; try again a moment later.
The platform can build these dates for you once a day, but that daily build is off unless it's been enabled for your environment — until it is, someone starts each build. Two things behave differently when it is on: there is no per-workflow build time (one pass builds everything, at a time set for the environment), and an unattended rebuild never replaces a completed or cancelled run. See Automatic daily build.
Run one workflow per branch, region, or entity
If the same sequence of jobs has to run several times a day over different data — one run per branch,
per region, per legal entity — you don't need a copy of the workflow for each. Turn on Allow
Multi-Instance and define a named schedule instance per variant, each carrying its own
property values. One PAYROLL definition then builds as PAYROLL_BRANCH1 and PAYROLL_BRANCH2 for
the same date.
- Open the workflow's Workflow Settings panel.
- On the Overview tab, under Multi-Instance, turn on Allow Multi-Instance.
- On the Instance Properties tab, select Add New Instance, name it, and add the properties whose values differ for this variant. Repeat per variant.
- Reference those values from your jobs with the
SIscope —[[SI.BRANCH_CODE]]. - Save and deploy as usual.
To build them: Processes → Schedule Workflow, pick the workflow, then use the Schedule Instance picker — All instances builds every one, or pick a single instance to build just that one (which also lets you override its property values for that build).
Schedule Date takes a range, so you can build several days in one pass — up to 31 days, opening on today. Each date is built in turn and reported on its own, and one date the workflow isn't deployed for no longer abandons the rest. Your instance choice, the property overrides and both check boxes apply to the whole range, which matters most for Overwrite Existing: one tick across a week of a two-instance workflow deletes fourteen runs. See Scheduling a workflow across a date range.
- Instance names are case-sensitive and must be unique in the workflow.
[[SI.InstanceName]]always resolves to the instance being run, so you can use it in job parameters and log paths. - A property marked Encrypted is deliberately not carried onto the run, so
[[SI.…]]can't read it back. Don't put a value your jobs need there. - Dependencies inside the workflow stay within one instance —
BRANCH1's jobs are not held byBRANCH2's. If two branches really do share something, use a Resource dependency. - Turning Allow Multi-Instance back off keeps only the first instance: the editor removes the others in the same save. It does not un-build instances already built for a date.
- Turning the setting on without defining any instance is fine — the workflow builds as one
implicit instance named
Default, and because it declares no properties, every build adds another run rather than colliding with the last. Earlier builds refused the second one.
Building the same instance twice for one date
You can build one instance more than once for a date, and what decides whether you get a second run or a rebuild of the first is the instance property values the build carries:
- Override a value so the set differs from every run already built, and you get a new run —
displayed as
PAYROLL_BRANCH1$0002. - Build with the same values as an existing run and it is that run: without Overwrite Existing you're told it already exists, and with it that run is replaced.
- A workflow with the setting on that declares no instances has no property values to compare,
so every build of it adds a run — the second reads
PAYROLL_Default$0002.
Two things to know before you rely on it:
- An overwrite against an instance holding several runs replaces only the matching run. If none matches, the build is refused rather than guessing — delete the runs you don't want, or build without overwrite to add one alongside.
- One instance is capped at 100 live runs per date. Deleting a run makes room.
Schedule instances is the full reference — naming rules, repeat builds, what overwrite deletes, the per-request and per-instance limits, and how events target one instance.
- A job appears in a day's run only when its frequency matches that date and the day isn't excluded by a calendar or working-days rule. When several of its frequencies match, the first in its Frequencies list decides — see When more than one of a job's frequencies matches.
- The late-to-start, late-to-finish, and max-run-time settings drive the matching job statuses you (and Operators) can act on.
- Build on Hold is the safe way to stage a workflow without it running until you're ready.
Related topics
- Scheduling and the run — full configuration reference and troubleshooting
- Schedule instances — named instances of one workflow, in full
- Order jobs with dependencies (Builder)
- Define a frequency (Builder)