Locking a workflow

Lock a workflow when its configuration must not change, for example a Production workflow that has been reviewed and released. A locked workflow keeps running: documents still arrive, runs still start, and reviews still work. What stops is every change to how the workflow is built. A lock covers one environment. Locking the Production workflow leaves its Development sibling editable, so you can keep building in Development and copy a reviewed graph across once you unlock Production.

​

Lock a workflow

1. Open the workflow in the editor.
2. Open the toolbar’s More actions menu and select Lock workflow.
3. Optionally add a Note saying why it is locked. Everyone who opens the workflow sees it.
4. Confirm.

You need the Core.Workflow.Update permission to lock or unlock. See roles and permissions.

​

What a lock blocks

While a workflow is locked:

• The canvas is read-only. You cannot add, move, connect, or delete nodes, and node settings open read-only.
• Save, Import, and renaming are unavailable.
• Restoring a version and creating a version are disabled on the versions page.
• Workflow settings are read-only, except the self-learning toggle.
• New breakpoints cannot be set. Clear all breakpoints still works, so a workflow locked mid-debug can stop pausing runs.
• Classify samples cannot be added or removed.
• The workflow cannot be moved to another group or deleted. On the workflows list these actions show (locked).
• Copying another environment onto it is refused. Copying from a locked workflow to another environment still works, because the copy only reads it.
• Its workspace cannot be deleted.

​

What still works

• Documents arriving through every trigger, and the runs they start.
• Uploading documents and running test steps in the editor.
• Activating and pausing the workflow.
• Reviews, approvals, and self-learning.
• Duplicating the workflow. The copy starts unlocked.
• Exporting the workflow and saving it as a template.
• The in-app assistant can still answer questions, but its proposed changes cannot be applied.

​

Locked while you were editing

If someone locks the workflow while you have unsaved changes, your edits stay on screen but cannot be saved. A banner says who locked it and offers Discard changes, which reloads the saved version.

​

Unlock a workflow

A banner above the canvas reads Locked in by on , followed by the note if one was given. Click Unlock in that banner. The workflow becomes editable again immediately. Locking and unlocking are recorded in the security audit log as Workflow locked and Workflow unlocked.

​

Related