Stages

Stages are used to structure cases. They are often used to represent the different phases of a case or to logically group plan items. It is possible to nest stages.

Attributes

Group Attribute Description

General

ID

A unique ID for the element. The ID is used to refer to a model element from outside of the diagram (for example, from a CMMN Action button in a form or when referring to a model element, such as plan item ID, in a CMMN REST call). For convenience, this ID can be edited.

Name

The name of the element. This is the name displayed in the diagram. If no run-time name is specified, this name is also used in the running case.

Description

The description attribute additionally adds a description to the component.

Documentation

Documentation intended to explain concepts of its use for future reference.

Details

Required

Select this option to mark the element as required (exclamation mark decorator).

Required plan items must either be in the state COMPLETED, TERMINATED or DISABLED for their parent stage to complete.

Repetition

Select this option to mark the element as repeatable (number sign decorator).

By default, only one instance of a plan item is created at runtime. Repeatable plan items do not have that limitation.

The combination of this property, Manual activation, and no entry sentry has a special meaning called Automatic repetition: As a previous instance of the plan item completes, a new instance is automatically created and set into state 'Enabled'.

Repetition counter variable

The name of the repetition counter variable.

Completion neutral

Completion neutral influences the plan item’s parent stage completes. Plan items in the state AVAILABLE may prevent the parent stage (or case) from automatically completing. By checking this property, the plan item behaves neutral with respect to the completion of the parent container.

Auto complete

A stage with this option set to true completes more eagerly, even if there are pending non-required children in states 'Available' or 'Enabled'.

In other words: With the option set to true, a Stage completes even if it has children in states 'Available' or' Enabled' (unless they are Required).

With this option set to false, a Stage only completes if all child elements are one of the states: 'Completed', 'Terminated', or 'Disabled'.

Show state

A flag indicating whether the state of this Stage is displayed at run-time. The standard Case template includes a status bar showing the states of Stages and Milestones.

When set to true, the Stage is displayed in the status bar with colors reflecting its state: light gray for 'Available'/'Enabled'/'Terminated', red for active, dark gray for 'Completed'.

Display order

An integer value (negative, zero or positive) denoting the display order of the Stage’s state indicator relative to other elements in the status bar (see attribute 'Show state'). The smaller the number, the more to the left.

Activation

Manual activation

Select this option to mark the element to have Manual activation (right arrow 'play' decorator).

Plan items with Manual activation move from state AVAILABLE to state ENABLED once they trigger. A plan item in state ENABLED exposes an action button that allows the user to start the plan item manually.

More

Lifecycle listeners

It allows you to define lifecycle listeners for a plan item. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when a plan item transitions from one state to another.

Visual

Font weight

The font weight of the element in the diagram.

Font size

The font size of the element in the diagram.

Font color

The font color of the element in the diagram.

Font style

The font style of the element in the diagram.

Background color

The background color of the element in the diagram.

Border color

The border color of the element in the diagram.