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

Attribute	Type	Description	Category
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	Text	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	Reference	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

Attribute	Type	Description	Category
Candidate users	User 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	Group 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.
Watcher users	User Selection	Defines the watcher user identity links for the task.	Watcher users - configured directly or through groups - are users which are added to the case page as watchers. The permission in the security policy (or the default one if none is set) determine the visibility rights and actions of those users.
Watcher groups	Group Selection	Defines the watcher group identity links for the task.
Assignee	User 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	User 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 Form

Attribute	Type	Description	Category
Input mapping type	Selection: Allowed Blocked	Defines the type for the mapping definitions, which can be allowed or blocked.	The data that's available to the case page form can be configured. If the 'allowed' type is selected, only variables that match the mappings will be passed to the case page form. Alternatively, using the 'blocked' option, all variables are available except those which match the mappings.
Input mappings to form	List	Defines the input mappings that are allowed or blocked for the task form.
Output mapping type	Selection: Allowed Blocked	Defines the type for the mapping definitions, which can be allowed or blocked.
Output mappings to form	List	Defines the output mappings that are allowed or blocked for the task form.

UI Configuration

Attribute	Type	Description	Category
Header configuration	Selection: No header Small Medium Large	Choose a header configuration or fill-in a custom header config value.	With the Header configuration, it is possible to change the default header of Flowable Work. A case page can get a custom icon and ordering, depending on the index value. Lastly, The Hide save button checkbox determines whether or not the save button will be available to end-users. If unchecked, the case page form will only be able to contain read-only data and/or actions.
Icon	Icon	Choose an icon for the runtime display of this element
Index	Text	Define an index for the ordering in the runtime display of this element
Hide save button	Boolean	Hides the save button for the case page
Available / enabled	Selection: Full access Read only Disabled Hidden	Define how the element should be rendered in a state of Available / enabled	The case page can be rendered in Flowable Work differently depending on the state of the stage or plan model where the case page is residing in. For example, the page typically is Hidden when the parent stage is Terminated.
Active	Selection: Full access Read only Disabled Hidden	Define how the element should be rendered in a state of Active
Completed	Selection: Full access Read only Disabled Hidden	Define how the element should be rendered in a state of Completed
Terminated	Selection: Full access Read only Disabled Hidden	Define how the element should be rendered in a state of Terminated
Page elements	List	Defines the static page elements for a case view.	A list of page elements can be defined that will be shown in the case page view when the Case Page element is active. The ordering of the navigation elements is determined by the index value of the element. The navigation elements are sorted in ascending order based on a numeric index value. Each element can have a specific icon that is used to render the navigation element. If a specific Header configuration value is needed for the case page and the page elements it can be defined here as well. Lastly, the default save button can be configured to be hidden with the Hide save button property. If this property is enabled, there will not be save button rendered for the case page form.

Advanced

Execution

Attribute	Type	Description	Category
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

Attribute	Type	Description	Category
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

Attribute	Type	Description	Category
Direct activation condition	Boolean	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	Boolean	Condition that expresses if the plan item should be ignored when a case instance is reactivated.
Default condition	Boolean	Condition that expresses if the plan item should trigger when a case instance is reactivated.

Visual

Attribute	Type	Description	Category
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	Color	The background color of the element in the diagram.
Border color	Color	The border color of the element in the diagram.

List Attribute Details

Input mappings to form

Attribute	Type	Description
Mapping value	Text	Variable name

Output mappings to form

Attribute	Type	Description
Mapping value	Text	Variable name

Page elements

Attribute	Type	Description
Type	Selection: Internal link External link Predefined page Custom page Custom React Component	The page element type
Sub type	Selection: Open Tasks Work Form Chat Comments People Sub Items Documents Audit Trail Diagram	The page element sub type
Name	Text	The page element name
Header size	Selection: Default value No header Small Medium Large	Configure the header size value for the page
Hide save button	Boolean	Hides the save button on the page
Label	Text	The page element label
Icon	Icon	The page element icon
URL	Text	The page element URL
URL Target	Selection: Select Target Same window / tab New window / tab Parent frame Full body of window	The page element URL target
Props	BasicFormList	Properties which will be used as properties for the custom react component
Index	Text	The page element index

Props

Attribute	Type	Description
Name	Text	The name of the element. This is the name displayed in the diagram.
Value	Text	Value.

Lifecycle listeners

Attribute	Type	Description
Source state	Selection: Any Available Active Enabled Disabled Completed Failed Suspended Closed Terminated Waiting for repetition Async active Async active leave
Target state	Selection: 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