State Models#

Administration.StateModels

State models provide access to all the system state models and are accessible in the State Models page of the Administration page group.

Browsing State Models#

State Models are associated and organized by Entity Type and the list can be filtered using the appropriate dropdown selection.

The default page in the Administration page group lists all the available State Models.

Clicking on any of the entries opens the details of the state model, together with information on the states, transitions and attributes associated to each of the objects within the selected state model.

Creating a State Model#

StateModel.Create

To create a new State Model, press Create and then follow the Wizard as described below.

1. Select a name for the State Model
2. Optionally, provide a description for the State Model.
3. Select the Entity Type for which the State Model will apply.
4. Press the Create button and the system will open the visual editor in the Flowchart view.

Flowchart view#

When the visual editor in the Flowchart view is opened, you can see details for every state and transition in the State Model.

In the right side panel, there are three main sub-panels, each of them containing pertinent information for easier understanding and editing of the State Model.

Info#

This panel displays general information on the selected object in the State Model

Navigator#

A scaled view of the canvas can be useful to narrow down on small details while editing big State Models

View#

You can filter which information to display in the State Model in order to make it more or less outright informative:

Editing a State Model#

StateModel.Edit

You can edit the State Model states and transitions by pressing the Edit button in the ribbon above.

In the main window it is possible to:

• Add a new state by dragging the State icon from the right-side panel button. Double-clicking on the state it's possible to change the name and description of a state, and specifying whether the state is a Initial or Final state. It's also possible to define a security role for the state that when defined indicates that only users belonging to that role can transition the object from that state.

  Info

  A State Model must have one initial state defined.

• Add a transition to connect two states. This can be done by pressing on the triangle pointing away from the (source) state and dragging it into another state (target). There is also the possibility of creating self-transitions by carrying out the same procedure but ensuring that the state area is left before entering it again. To edit a transition name and description, the user can double-click on the object or right-click on it and select Settings. It's also possible to define a lookup table with the transition reasons to be used (in the case that a reasons lookup table is defined, it is also necessary to define a default reason). In addition, if a role is defined for the transition, only users that belong to that role will be allowed to perform that transition.

• Remove an existing state or transition by right-clicking on the object and selecting Delete from the context menu.

• It is possible to add specific Attributes to States with a wide range of possible types. To edit the State or to add an attribute to it, you can double-click the State box or select the menu dots at the top right corner of the State box that can be selected and selecting Settings will open a configuration wizard.

Pressing the Save button to make the changes effective.

Cloning a State Model#

StateModel.Clone

To clone a new State Model, press the Clone button and then follow the Wizard as described below.

1. Select a name for the State Model
2. Press Clone to complete the transaction and a new object will be created.