Workflow administration (IRPCWorkflowsAdmin)

View as Markdown

Administers workflows: reads their full definitions with states and transitions, and adds, modifies and removes them.

Use this interface to add, modify and delete workflows in a vault.

Overview

This is the administrator's side of workflows. M-Files Admin calls it; applications that move objects through workflows read them with GetWorkflowsForClient and GetWorkflowStatesAndTransitions, which need no special rights and return what the caller may do (see Workflows).

• Session and rights. Every method requires a vault session. GetWorkflows needs the vault right read_all_metadata_structure (a normal user gets "Access denied."). The write methods need manage_workflows and license_allows_modifications. Setting or changing VBScript code in states and transitions also needs a code-execution right (see AddWorkflow).
• Calls: GetWorkflows, then AddWorkflow or ModifyWorkflow with a complete WorkflowAdmin, and RemoveWorkflow or RemoveWorkflows.
• New states and transitions get negative placeholder IDs in the request (-1, -2, ...); transitions refer to new states by these placeholders. The response contains the workflow as stored, with real IDs.
• Metadata structure version. Every successful add, modify and remove increments the vault's metadata version when it commits; clients that cache workflows reload them. The methods do not send the mfiles-metadata-version-bin trailer; see Metadata structure version and caching.

Methods