Skip to content

case-state-machine.md

Latest commit

 

History

History
100 lines (57 loc) · 5.89 KB

case-state-machine.md

File metadata and controls

100 lines (57 loc) · 5.89 KB
tags Case Management; Case Management framework;
summary Learn how to define allowed case status transitions using a case state machine in OutSystems 11 (O11).
guid 9afd417a-9688-49f3-a968-06dd8c96bfd9
locale en-us
app_type traditional web apps, mobile apps, reactive web apps
platform-version o11
figma https://www.figma.com/file/iBD5yo23NiW53L1zdPqGGM/Developing%20an%20Application?node-id=4376:1853

Defining allowed case status transitions with a case state machine

A case state machine defines what transitions between case statuses are allowed. For example, you can use the case state machine to allow a case status change from "Under Analysis" to "Resolved", but not from "Submitted" to "Open".

Diagram illustrating allowed transitions between case statuses in a case state machine

A case state machine is important when status updates aren't done programmatically, and the end user of the app can choose between the different possible status.

To use a case state machine with the Case Management framework, you start by setting up the case state machine, and then you add all the allowed case status transitions. If a status transition isn't defined in the case state machine, it's considered invalid and an exception is thrown when an end user tries to do that status transition.

Create the case state machine

Before you start make sure you set up your app to work with the Case Management framework.

To define a case state machine, follow these steps:

  1. In the <business-entity>_CS module, open Manage Dependencies, and add the CaseStateMachine_CreateOrUpdate and CaseStateMachine_GetByTransition actions from the CaseConfigurations_API producer.

  2. In the Data tab, create a CaseStateMachineConfiguration Static Entity with the following attributes:

    • Id, with the Data Type set as Integer and Is AutoNumber set to Yes.

    • FromCaseStatusId, with the Data Type set to CaseStatusConfiguration Identifier.

    • ToCaseStatusId, with CaseStatusConfiguration Identifier data type.

    • IsActive, with boolean data type.

    Screenshot of the CaseStateMachineConfiguration static entity with attributes in the development environment

  3. In the Logic tab, open the Timer_SetupApplication server action.

  4. In the action flow, drag the CaseStateMachineConfiguration static entity before the End, to add an aggregate that fetches all records in CaseStateMachineConfiguration.

  5. After the aggregate created in the previous step, add a For Each to the flow.

  6. Set the Record List of the For Each as GetCaseStateMachineConfigurations.List (the output list of the aggregate).

  7. Add a CaseStateMachine_GetByTransition action next to the For Each.

  8. Connect the For Each to the CaseStateMachine_GetByTransition action.

  9. Set the CaseStateMachineTransitionRec of the CaseStateMachine_GetByTransition as GetCaseStateMachineConfigurations.List.Current.CaseStateMachineConfiguration.

  10. Set the inputs of the action with the data from the aggregate as follows:

    • Set CaseStatusId as TextToIdentifier(FromCaseStatusId).
    • Set NextCaseStatusId as TextToIdentifier(ToCaseStatusId).

Screenshot showing the CaseStateMachine GetByTransition action in the development environment

  1. Add a CaseStateMachine_CreateOrUpdate action next to the CaseStateMachine_GetByTransition, and connect the CaseStateMachine_GetByTransition to the CaseStateMachine_CreateOrUpdate action.

  2. Connect the CaseStateMachine_CreateOrUpdate to the For Each.

  3. Connect the For Each to the End.

  4. Expand the CaseStateMachineRec input of the CaseStateMachine_CreateOrUpdate action by clicking +, and then set the attributes as follows:

    • Set Id as CaseStateMachine_GetByTransition.CaseStateMachineDetails.Id.
    • Set CaseStatusId as TextToIdentifier(GetCaseStateMachineConfigurations.List.Current.CaseStateMachineConfiguration.FromCaseStatusId).
    • Set NextCaseStatusId as TextToIdentifier(GetCaseStateMachineConfigurations.List.Current.CaseStateMachineConfiguration.ToCaseStatusId).
    • Set IsActive as GetCaseStateMachineConfigurations.List.Current.CaseStateMachineConfiguration.IsActive.

Screenshot displaying the CaseStateMachine CreateOrUpdate action with expanded inputs in the development environment

  1. Publish the module by selecting 1-Click Publish.

After these steps you can add the allowed status transitions.

Add allowed status transitions

After creating the case state machine, add the allowed status transitions to the state machine by following these steps:

  1. Still in the <business-entity>_CS module, add a record to the CaseStateMachineConfiguration static entity.

  2. Set the FromCaseStatusId as the CaseStatusId of the starting status.

  3. Set the NextCaseStatusId as the CaseStatusId of the ending status.

  4. Set IsActive as True.

  5. Repeat the previous steps for every allowed case status transition.

  6. Publish the module by selecting 1-Click Publish.

After these steps the bootstrapping action loads the allowed status transitions and associates them with the case definition.

Whenever you update the status of a case, CMf automatically validates the transition for you.