Skip to main content

Case Plan Model

Introduction​

On the case diagram there is typically exactly one case plan model. This represents the execution behavior of the case.

Properties​

General​

AttributeTypeDescriptionCategory
Model Id Text

Model Id identifies the element within the process model.

The model id, name and documentation properties can be found on any element. They are used respectively to uniquely identify the business rule task, to give it a user-friendly name and to add a free-form description.

Name Expression usage possibleTranslatable to different languagesText

The name of the element. This is the name displayed in the diagram.

Documentation Multiline Text

The documentation attribute additionally adds a description to the component.

Start form Expression usage possibleReference

Start form for the case.

A start form is used whenever a new case instance for this model is started manually through the Flowable Work UI.

It helps you define the necessary starting data used to initialize the case properly. Keep in mind that starting the same case through the REST- or Java-API will not take this form into consideration.

In same deployment Boolean

Set it to true if the referenced definition should be referenced from within the same app deployment. Set it to false to always use the newest definition.

The Same deployment flag is used to indicate that the form model that is used is part of the same app deployment package as where the current CMMN model is in. If unchecked, the latest version is used which can come from an app that is deployed at a later point in time.

Inbound event inboundstarteventconfiguration

A reference to an event model.

Defining a start event for a case plan model might automatically start a new case instance whenever this event is received in the defined inbound channel.

Whether or not a new case instance is created can be defined in the payload mappings section.

Inbound channel Expression usage possibleReference

Configures the channel on which the event is received

Defining a start event for this case also needs an inbound channel where the event is received in order to register this case plan model as a subscriber on the channel.

If such a start event is received on this channel, a new case instance might be created according the specific payload mappings defined in the start event property of the case plan model.

Advanced​

Details​

AttributeTypeDescriptionCategory
Auto complete Expression usage possibleBoolean

A Stage with this option set to true will complete 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 will complete even if it has children in states Available or Enabled (unless they are Required).

With this option set to false, a Stage will only complete if all child elements are in states {Completed, Terminated, Disabled}.

The case plan model is the root container for the case where you can add stages, plan items and listeners to build up the case model.

If the case plan model completes, the case instance is completed as well. You might want to consider to use the auto-complete option for this case model.

If activated, the case will be completed automatically as soon as there is no more active or required plan item to be worked on (e.g. stages or tasks, etc).

Listeners​

AttributeTypeDescriptionCategory
Lifecycle listeners List

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.

With lifecycle listeners it is possible to react to state changes of the case plan model. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when the plan model transitions from one state to another.

Visual​

AttributeTypeDescriptionCategory
Font size Selection:
  • 8
  • 9
  • 10
  • 11
  • 12
  • 14
  • 18
  • 20
  • 24
  • 36
  • 48
  • 72

The font size of the element in the diagram.

Visual properties that determine how the case task is shown in the diagram.

This has no impact on the runtime execution.

Font weight Selection:
  • Normal
  • Bold

The font weight of the element in the diagram.

Font style Selection:
  • Normal
  • Italic

The font style of the element in the diagram.

Font color Color

The font color of the element in the diagram.

Background color RequiredColor

The background color of the element in the diagram.

Border color RequiredColor

The border color of the element in the diagram.

List Attribute Details​

Lifecycle listeners​

AttributeTypeDescription
Source state RequiredSelection:
  • Any
  • Available
  • Active
  • Enabled
  • Disabled
  • Completed
  • Failed
  • Suspended
  • Closed
  • Terminated
  • Waiting for repetition
  • Async active
  • Async active leave
Target state RequiredSelection:
  • Any
  • Available
  • Active
  • Enabled
  • Disabled
  • Completed
  • Failed
  • Suspended
  • Closed
  • Terminated
  • Waiting for repetition
  • Async active
  • Async active leave
Class Text

Fully qualified classname of a class to be invoked when executing the task. The class must implement either PlanItemJavaDelegate or CmmnActivityBehavior.

Expression Text

JUEL Expression to be executed when the task is started. Expressions allow you to interact with the backend by calling services, making calculations etc. You can find more information about expressions in the documentation.

Delegate expression Text