StateMachine viewer
The StateMachine viewer component provides details on the entity status in the associated state flow.
Warning
A StateMachine viewer can only be added on detail pages with an associated state flow, such as Content detail page which is associated with the Ideation stateflow.
Note
For more information about state flows, see the State flows section.
From the component detail page, three levels of configuration are available:
General settings
The General settings parameters are:
| Field | Type | Description | Value | Mandatory/Optional |
|---|---|---|---|---|
| Title | Toggle switch | If enabled, displays the component title. | Enabled/Disabled | Optional |
| Show | Drop-down list | Displays an option to either select all or select none. | Show specific state flow / All state flows | Mandatory |
| State flow | Selection list | Selects a specific state flow. Required when Show specific state flow is selected. | All available state flows for the entity. | Optional |
Linear state flow
The Linear state flow parameters are:
| Field | Type | Description | Value | Mandatory/Optional |
|---|---|---|---|---|
| Display mode | Drop-down list | Defines the display mode of the state flow. | Horizontal steps / Vertical steps / Current state only | Mandatory |
| Description | Toggle switch | If enabled, includes a description of each state displayed in the state flow. | Enabled/Disabled | Optional |
| Assignee | Toggle switch | If enabled, show the user assigned to complete each state. | Enabled/Disabled | Optional |
| Collapsible | Toggle switch | If enabled, allows collapsing the state flow details using the arrowhead icon. | Enabled/Disabled | Optional |
| Collapsed by default | Toggle switch | If enabled, collapses the state flow details by default. | Enabled/Disabled | Optional |
| Enable detail pop-up | Toggle switch | By enabling it and clicking on the information icon, this option provides a pop-up window showing the whole state flow. | Enabled/Disabled | Optional |
Note
- The Collapsible and Collapsed by default options are only available in the Current state only or Vertical steps display modes and when at least Assignee or Description option is enabled.
- The Enable detail pop-up option is only available in the Current state only display mode.
Complex state flow
For a Complex state flow, only the Current state only display mode is available. However, the same display parameters as the Linear state flow, described in the previous section, can be configured.
Can we improve this article ? Provide feedback