Skip to main content

Case Page

Introduction

Case pages allow to specify dedicated pages specifically for the case. They can be used integrated in the Flowable Work application, as well as embedded in a web application.

To use case pages, it is required that case pages are configured on a case level with the appropriate permissions. Also, the case page task needs to have an identity link to be visible for the user.

Properties

General

AttributeTypeDescriptionCategory
Model Id Text

Model Id identifies the element within the process model.

The model id, name and documentation properties are used to uniquely identify the case page, 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.

Form reference Expression usage possibleReference

Reference to the form that will be displayed when opening this task.

Create or link a form to this case page. The form will be shown when the user navigates to the page. Unlike the form of a human task, the form is not submitted.

A form reference can be unlinked to allow another form to be linked in its place. Note that unlinking a form does not delete the form model itself.

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 case page 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.

Assignment

AttributeTypeDescriptionCategory
Candidate users Expression usage possibleUser Selection

By selecting one or more candidate users, the task might be taken by one of those users.

If the task is not specifically assigned to one of the users directly, it will show up in all of the selected candidate users tasks list until assigned directly.

A case page can get candidate users and/or candidate groups

Depending on the permission configuration in the security policies (or the default one if none is set), this will influence the visibility and available actions for those specific users.

Candidate groups Expression usage possibleGroup Selection

By selecting one or more groups as the candidate groups, shares the task with all users belonging to at least one of the groups.

If there is no specific assignee specified but the task has candidate groups, the task will show up in all users task list belonging to at least one of the groups until the task is assigned to a specific user.

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.

A case page can get an owner and/or an assignee. This assignee can be a user identifier or you can also use an expression that resolves to the identifier of the user when the case instance is running.

Depending on the permission configuration in the security policies (or the default one if none is set), this will influence the visibility and available actions for those specific users.

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.

Control

Repetition

Advanced

Execution

AttributeTypeDescriptionCategory
Include in history Boolean

When the history level is set to "instance" or "task" level with this property it can be configured if this plan item instance should be included in the historic plan item instance data.

The Include in history flag can be used to store the historical entry of this case page when running with a history level that normally would not store the execution of the plan item.

Note that this flag has no effect when running with history level 'none'.

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 page plan item instance. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when the plan item instance transitions from one state to another.

Reactivation

AttributeTypeDescriptionCategory
Direct activation condition Expression usage possibleBoolean

Condition that expresses if the plan item should be directly activated when a case instance is reactivated.

Case reactivation is the the ability to reopen a finished case instance and continue with its execution. Case reactivation needs to be modeled using a reactivation listener and specific behavior can be configured for each plan item in the case model.

The Direct Activation Condition is the first condition to be evaluated during case reactivation. If checked or if there is an expression evaluating to true, the case page immediately gets activated, regardless of any entry sentry or condition which might be necessary to restart at a certain state of the case (e.g. a stage).

The Ignore Condition, if checked or if there is an expression evaluating to true, means that the case page is ignored on reactivation.

The Default Condition only gets evaluated, if the previous ones are either not checked or evaluated to false. If so, the case page behaves like a regular one as if the case instance was started from scratch. This means that any necessary entry sentry is considered and evaluated and the engine proceeds as normal.

Please check the Flowable documentation for more details.

Ignore condition Expression usage possibleBoolean

Condition that expresses if the plan item should be ignored when a case instance is reactivated.

Default condition Expression usage possibleBoolean

Condition that expresses if the plan item should trigger when a case instance is reactivated.

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 page 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