Server

Workflow Instance Properties

Updated: December 5, 2024

This page describes information that is persisted on a workflow instance.

Workflow Variables

A workflow instance can persist some custom variables that can be used all along the workflow life.

These are properties of the document of type 'DocumentRoute' stored on a dynamic facet, in a schema named as following:

  • the name of the schema (and its prefix too): var_$WorkflowModelName,

Usual property types are available beside complex properties that are currently disabled.

Workflow variables can be accessed from the automation context during the execution of the process using the context variable WorkflowVariables["my_variable"]. They can be updated using the Automation operation Set Workflow Variable.

Availability

The workflow availability information is stored on the workflow instance. This filter is actually an action filter used to control the visibility of workflow models in the list of workflows displayed by the widget type "Workflow Process" (the widget that displays the list of workflows that can be started). Note that it is not currently used at low level for controlling the right for a user to execute a workflow.