Skip to content

Workflow mapping

One workflow-driven co-authoring rule: entering the mapped state auto-checks the document out to co-authoring and shares it with the people referenced by the source properties; the document cannot leave the state until it is checked back in through CtrlShare. Stored at MainConfiguration.WorkflowMappings (configuration version 3.0). Member names are frozen.

Reached from Workflow Mappings on Main configuration.

Settings

NameRequired

Type
Text

A short name for this mapping, e.g. "Policy review". Shown as the entry's title in this list and used in the vault application log to identify which mapping acted on a document.

WorkflowRequired

Type
M-Files workflow

The workflow whose state entry triggers automatic check-out and sharing.

Workflow StateRequired

Type
M-Files workflow state

Entering this state auto-checks-out the document to co-authoring and shares it. The document must be checked back in (CtrlShare Check In) before it can leave the state; automatic state transitions out of this state are blocked too while co-authoring is in progress, so the workflow can never advance over stale document content.

Viewer Source Properties

Type
List of m-files property
Accepts
Multi Select Lookup

Optional. Document properties whose referenced people (person objects, users, or user groups) get read access. Each person is resolved through the matching person mapping. A person who also appears in an Editor Source Property is invited once, as an editor. Leave empty to grant no read-only access automatically.

Editor Source Properties

Type
List of m-files property
Accepts
Multi Select Lookup

Optional. Document properties whose referenced people (person objects, users, or user groups) get write access. Each person is resolved through the matching person mapping. Leave empty to grant no edit access automatically; with both lists empty the document is still checked out to co-authoring and people can be added afterwards with the Share command.

Share Message Text

Type
Text

Static message attached to the sharing invitation. Ignored when Share Message Property is set and has a value.

Share Message Property

Type
M-Files property
Accepts
Text, Multi Line Text

Optional document property whose value is used as the sharing invitation message. Overrides Share Message Text when present.

Generated from CtrlShare 2.26.8.0.