Skip to main content

Reactivate Event Listener

Introduction

Once a case complete, it can be only reactivated with case reactivation. To configure reactivation, the Reactivation Event Listener must be used. The properties below allow to specify the behavior for the event itself, however there are more configuration options on other elements available. In the guide about case reactivation a step-by-step guide is offered.

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 event listener, 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

An optional form shown when the event listener is manually activated.

A form that is shown when the reactivation is triggered. It can be used to gather data that afterwards can be used during the reactivation of the case instance.

Reactivation available for duration Expression usage possibleComplexTrigger

Defines the time period that the reactivation listener will be available after the case instance is completed.

When the capability for reactivation of a finished case instance is needed, this is often limited in time. Often this is based on regulatory rules that for example state the case instance should be allowed to reactivate under certain conditions for a certain number of years. The time is counted from the moment that the case instance finished.

Security

AttributeTypeDescriptionCategory
Permission users User Selection

Define the users which have access to the user event listener.

Not every user should be able to reactive a case instance that is finished. The Permission users* and Permission groups can be used to configure which particular users should have access to this capability.

Permission groups Expression usage possibleGroup Selection

Define the groups which have access to the user event listener.

Advanced

Details

AttributeTypeDescriptionCategory
Available condition Expression usage possibleText

Sets an available condition, which is an expression that moves the event listener into the available state after creation if true. Also returns the event listener back to the unavailable state when the condition becomes false again.

The life cycle of event listeners is simpler than that of plan items such as human tasks: an event listener stays in the available state until the event happens. There’s no active state like for other plan items.

In some use cases however, the event listener shouldn’t be available for the user to interact with unless a certain condition is true, typically based on case instance variables. The available condition serves exactly that purpose.

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 event listener when running with a history level that normally would not store details of its execution.

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 event listener instance. 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 event listener 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

Reactivation available for duration

AttributeTypeDescription
timeduration Text
technical Text

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