logo
logo

Enable definitions for state flows

To use state flows, you must enable the target content and add an operation to the target entity definition portal page.

Note

You can only apply state flows to block type jobs.

Enable the target content

To enable the target content:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Schema.

  3. On the Schema page, in the left pane, select an item.

  4. In the top corner of the right pane, click Actions and, from the menu, select Enable/Disable.

  5. In the Enable/Disable dialog box, click the State flow switch to make it active.

    You can enable the state flow component for any entity. You can also enable the entity definition from the entity definition configuration page.

  6. In the Enable for state flow dialog box, define the following and click Confirm:

    • Enable assignees - use to set the state flows to pre-defined user assignees for state transitions.
    • Detail page - use to specify the detail page that is used to send out notifications to auto-assignees at state transitions. The links of the targets in the target search of a state flow is also determined by the selected detail page.
    • Fields - use to enable a property or relation that belongs to the entity definition so that target values are modified at state transitions. The update strategies for the selected fields are keep, overwrite or clean.

Add an operation to the target entity definition portal page

After you enable a definition for the state flow, you must add an operation to the definition detail page. You must also add the state flow operations to the target detail page. This makes the transition buttons visible on the page.

To add an operation to the target entity definition portal page:

  1. On the menu bar, click Manage .

  2. On the Manage page, click Pages.

  3. In the left pane, select a page and, on the Layout tab, click Add component .

  4. In the Add component dialog box, select Entity operations, define a name for the component, click the Visible switch to make it active, and then click Add.

  5. On the Layout tab, next to the Entity operation component, click More options and select Edit.

  6. On the component detail page, click Add operation and select State flow transitions.

  7. In the OPERATION SETTINGS section, from the Display options list, specify which state flows are applicable for the target definition objects.

    When there are no specific state flows selected, all existing state flows are available.

  8. Click Save.

After you enable the definition for the state flow and add the operations to the entity detail page, you must:

  1. Create a state flow for the dedicated content.
  2. Link the state flow with target entities.
Warning

Merging drafts into the original is state flow driven. Therefore, the current security of this merge action relies on state flows. It is enabled for any definition that uses the draft functionality. The out-of-the-box draft state flow allows only M.Builtin.Approvers or Superusers to approve a draft entity. The merging logic is invoked when a DraftLifeCycleToDefinition relation is set to the Done state by a M.Builtin.Approver or Superuser. This relation is defined as allow_update= false, which means you can only update it through the draft state flow. Only Administrators can change the schema. If there is a use case where you want to change the DraftLifeCycle relation definition of allow_update = true, then you need to contact your Sitecore account manager.

Can we improve this article ? Provide feedback