Skip to content

case-state.md

Latest commit

 

History

History
63 lines (37 loc) · 2.99 KB

case-state.md

File metadata and controls

63 lines (37 loc) · 2.99 KB
tags Case Management; Case Management framework;
summary Explore how OutSystems 11 (O11) manages case statuses within its Case Management framework.
guid fc30b404-7533-4e75-9e88-392cf3f454b6
locale en-us
app_type traditional web apps, mobile apps, reactive web apps
platform-version o11
figma

Case status

A case can go through several statuses during its lifecycle. For example, on creation a new case instance can start with the "Submitted" status, and depending on the manual task of the end user, it can change to the "Approved" status or to the "Rejected" status.

The Case Management framework lets you define a set of statuses associated with a case definition, and each case definition must have one initial status associated.

The case status set as initial is automatically assigned to a case upon the initialization of the case, unless another status is set using the non-mandatory CaseStatusId input field of the Case_Initialize action, from the CaseServices_API module.

A case must be initialized with a case status, otherwise an exception is thrown.
If there isn't a case status set as initial, you must set a CaseStatusId when you initialize a case.

After you set up your app to work with the Case Management framework, the CaseStatusConfiguration static entity from <business-entity>_CS module, contains the case statuses for the case definition in that module.

Define a case status

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

To define a new case status follow these steps:

  1. In the <business-entity>_CS module, add a <state> record to the CaseStatusConfiguration static entity. Replace <state> with the state of the case definition, for example, Approved.

  2. Generate a GUID and paste that GUID into the value field of the CaseStatusId attribute of the <state> record.

    A Globally Unique IDentifier, or GUID, is used as a unique identifier to ensure integrity across environments.
    You can use an online GUID generator to create a GUID for each record.

    Check the RFC 4122 for more information on GUIDs.

  3. Set the remaining attributes.

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

After these steps, the bootstrapping action loads the new case status and associates it with the case definition.

Update the status of a case

To update the status of a case, use the Case_UpdateStatus action from the CaseServices_API module.

A case status update is successful if the following conditions are met:

  • The Case Identifier exists.

  • The case status is valid for the given case.

  • If you defined a state machine, the change between the previous state and the new status is valid for the case.