Appearance
Workflow Rights
Every action a user can take on a workflow, and what it needs. When a tool returns denied, or a user asks why they can't do something, find the action here and say which right it needs. Never suggest a way around a right.
The rights
| Right | Who usually has it | What it's for |
|---|---|---|
| Read on the workflow and on its workflow group | Anyone who works with it | Seeing it: the definition, its instances and their records, its alerts, its approval status. Both are needed: a user who can't read the workflow's workflow group can't see the workflow. With the UVR policy, a user sees only the workflows they can execute: Execute on both the workflow and its workflow group. |
| Execute on the workflow | People who run it | Starting it and controlling its instances. |
| Write on the workflow | Whoever owns that workflow's operation | Turning its triggers on and off, confirming its instances, deleting it. |
| Write on the workflow group | The team that owns the workflows in it | Design: submitting any change. Every change to a workflow is a submit, and needs approval before it runs. |
| The QAC policy | Operators who keep the queue running | Seeing the whole queue, every workflow and instance whatever their ACLs, and operating any workflow: triggers, pausing, continuing, canceling and confirming instances, admin holds, and setting a queue to Automatic or Manual. It doesn't allow approving. |
| Administrator | Administrators | Passes every ACL check except approval, and always has QAC. |
| Approval | The owners of the resources a workflow uses | Consent, separate from all of the above (see Approving). |
Seeing it
Every action on this page also needs the user to see the workflow: Read on the workflow and on its workflow group. Only the workflow's own workflow group is checked, not the workflow groups above it. A user with the QAC policy sees the whole queue, so these checks don't apply to them.
| Action | Needs |
|---|---|
| See the workflow in lists and search | Read on the workflow and its workflow group |
| Read its definition | Read on the workflow and its workflow group |
| See its instances, and read their workflow logs and debug records | Read on the workflow and its workflow group |
| See its approval status | Read on the workflow and its workflow group |
| See its alerts | Read on the workflow and its workflow group |
| See when it is scheduled to be executed | Read on the workflow and its workflow group |
Task logs are files on an asset. The file tools read them as the user's OS account on that asset, and the operating system decides what can be read; Situate adds no checks of its own (prefix 10.3).
Changing it
Every change is a submit. The approved version keeps running until the new one is approved.
| Action | Needs | Notes |
|---|---|---|
| Create and submit a new workflow | Write on the target workflow group | The submitter becomes owner; their default Situate group (or WAG Situate groups) becomes group owner. The submitter doesn't need access to the resources it uses. |
| Edit and submit | Write on its workflow group | Lets someone fix a workflow and submit the fix without being able to approve it. |
| Rename | Write on its workflow group | A submit: names appear in run books and procedures. |
| Move to another workflow group | Write on the target workflow group | A submit: in its new workflow group it gets different injected variables. |
| Copy | Read on the source, Write on the target workflow group | The copy gets a new ACL. |
| Import | Write on the target workflow group | Like creating; gets a new default ACL. |
| Export | Read on the workflow and its workflow group | |
| Withdraw a submission | Write on its workflow group | Deletes the submitted version. Can't be undone. |
| Delete | Write on the workflow | Can't be undone. |
| Change its ACL, owner or group owner | Owner, or an administrator |
Approving
Approving needs no right on the workflow itself. Each approval requirement names a protected resource (a user the workflow runs as, a workflow it calls, a Situate group, a policy, an asset) and the operations an approver must hold on it. An approval counts toward every requirement the approver's access meets.
- NAP policy: can't approve.
- APA policy: can approve a workflow whose run-as user or asset is a variable, so isn't known until it runs. Without APA, such a workflow needs an administrator.
- A Policy requirement is met only by an approver who holds that policy.
- Administrators get no exemption: they must meet each requirement like anyone else.
- Approve and disable is the same, with the workflow's triggers disabled.
Operating it
| Action | Needs | Notes |
|---|---|---|
| Enable or disable a trigger, or every trigger | Write on the workflow, or QAC | Instances already in the queue are unaffected. On an application, enabling or disabling every trigger starts or stops it, so from chat set_trigger_enabled refuses "*" on an application: name one trigger. |
| Set or clear an admin hold | QAC | Stops the workflow's automatic triggers from starting it, without touching its triggers' states. Manual, Action and Restart triggers, Workflow Exec tasks and notify starts still start it. |
| Change a schedule or other trigger settings | Write on its workflow group | An edit: a submit that needs approval. |
| Set a queue to Automatic or Manual | QAC | Applies to every workflow in the queue at once: while it is Manual, only manual executions start them. The mode stays set after a server restart. |
Running it
| Action | Needs | Notes |
|---|---|---|
| Start it from a Manual trigger, or a trigger with Allow Manual Execution (the Situate UX offers it on Schedule triggers) | Execute on the workflow, and seeing it | A trigger's danger level adds a confirmation, not a right. |
| Start it through an Action trigger | Execute, as the calling program's identity | REST and MCP only; not from chat. |
| Automatic start (schedule, file, event, another workflow) | Nothing at run time | Approval granted it. |
| Pause or continue an instance | Execute on the workflow, or QAC | |
| Cancel an instance | Execute on the workflow, or QAC | Can't be undone; work its tasks did is not reversed. |
| Restart a failed instance partway (another run of it) | Execute on the workflow | Discouraged. Not possible after a crash or once confirmed. |
After an instance completes
| Action | Needs | Notes |
|---|---|---|
| Confirm an instance | Write on the workflow, or QAC | The operator's sign-off. Can't be undone, and the instance can't be restarted afterwards. Someone who can only start a workflow can't confirm its failed instances. |
| Close an instance's alert | No chat tool | Under Normal or Urgent Alert Behavior, a failed or canceled instance's alert closes when the instance is confirmed. Under Periodic, the workflow's alert closes when a later instance succeeds. Someone can also close an alert in the Situate UX. |
| Remove instance history and logs | (automatic only) | Retain Logs and Cleanup. |