StateMachine viewer

The StateMachine viewer component displays the entity status, which is retrieved from the associated state flows. It can only be added to details pages.

In this example, the Content detail page, which is associated with the Ideation state flow, includes a StateMachine viewer in the SIDEBAR ZONE that displays the current state of the item.

StateMachine viewer example

To see the full workflow and its details, an Info button is added.

View full workflow info button to display state flow details

To add a StateMachine viewer component:

  1. On the menu bar, click Manage cog icon.

  2. On the Manage page, click Pages.

  3. On the Pages page, select the page you want to modify.

  4. On the Layout tab, add the page component.

  5. Click the component to open its details page.

  6. In the SELECTION OPTIONS section, select one of the following options:

    Option

    Description

    All state flows

    Every state flow associated with the page’s definition is shown.

    Select a state flow

    Only one of the state flows associated with the page definition is shown. Use the field provided to select the desired state flow.

  7. In the DISPLAY OPTIONS section, select one of the following options:

    Option

    Description

    Current state only

    Only the current step in the state flow is displayed (for example, In review).

    Horizontal steps

    The steps of the state flow are displayed horizontally in a horizontal sequence, with the current status highlighted.

    Vertical steps

    The steps of the state flow are displayed in a vertical sequence, with the current status highlighted.

  8. Turn the Show description or the Show assignee switch on or off to show or hide the description or assignees of the respective state flow without having to hover over it.

  9. Click Save and close.

Note

The Horizontal steps and Vertical steps display options can show a maximum of five steps. If more than five steps are available, only the current step is shown. Complex state flows cannot be displayed as horizontal and vertical steps; instead the current state is displayed alongside an Info button.

Do you have some feedback for us?

If you have suggestions for improving this article,