Skip to main content

Case Diagram

Introduction​

The case diagram is the modeling area of a case. It is not part of the left hand side palette. However, it still has some overall case properties. On the case diagram there is typically exactly one Case Plan Model.

Properties​

General​

AttributeTypeDescriptionCategory
Model Key String

Model key of the case which serves as a unique ID to identify a model across different versions.

The model key is an important property, as the key is used in all kinds of API calls. When a CMMN case model is published to a runtime system a case definition is deployed. From that point on, new case instances can be started, often using the key when doing this programmatically or over REST. The key needs to be unique in a runtime system and therefor cannot be edited here.

The name is a user-readable name that is given to this CMMN case model. The documentation can be used to store free-form information about the CMMN case model. For example, it can be used to describe the business use case implemented with this model.

Name Translatable 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.

Creation date ISO8601DateString

This defines the date on which the diagram was created.

These two timestamps indicate when the CMMN case model was created and when it got last updated.

Modification date ISO8601DateString

This defines the date on which the diagram was last modified.

Case Instance Name Expression usage possibleTranslatable to different languagesText

The name of the case instance. The Case sequence variable can be used in the expression.

The Case Instance Name can be used to give the case instance a custom name. By default, the instance gets the name of the CMMN case model (in Flowable Work) or nothing (in Flowable Core). The name can be an expression that uses values from the start form.

The Case Instance Business Key is used to give the case instance a business key, which is typically some sort of business-specific identifier that can be used to easily find an instance.

The Category can be set to categorize published case definitions or filter definitions in queries.

Category Expression usage possibleText

Target namespace of the case model. This allows you to group models according to your own criteria.

Assignment​

AttributeTypeDescriptionCategory
Assignee Expression usage possibleUser Selection

User ID of the task's assignee. The assignee can see and complete a task and is usually the person responsible for it.

The assignee and owner of a case instance typically have broad set of rights to view and edit information. Using a security policy in the security tab on this CMMN case model, this can be changed.

Once an assignee or owner is set, a flag appears that can be used to disable the automatic propagation of the initiator of the case instance as an assignee and owner. This is only applicable for root instances, as child instances inherit these roles differently.

Owner Expression usage possibleUser Selection

The owner of a task can see a task and is able to delegate it to another user.

This user then becomes the assignee and can resolve the task. A resolved task will then be reassigned to the owner who can then complete the task.

Potential starter user Expression usage possibleUser Selection

A user that can start the case.

The Potential starter users or groups determine which users or groups can start case instances from a published definition of this CMMN case model.

In Flowable Work, this is automatic. In Flowable Core, this information is available as metadata to build your own filters.

Potential starter group Expression usage possibleGroup Selection

A group that can start the case.

Details​

AttributeTypeDescriptionCategory
Author Text

This holds the name of the author of the diagram.

The Author and Version are metadata fields, they have no impact on runtime execution.

Version Text

This defines the version number of the diagram.

Advanced​

AttributeTypeDescriptionCategory
Initiator variable Expression usage possibleText

The variable that holds the user that will be used as the default user who initiated the case.

The initiator is the user who started the case instance. This user id is stored by default in the 'initiator' variable. That variable name can be changed here.