RenameInstanceHandler

The ActionHandler RenameInstanceHandler renames the current instance by any text that can contain variables.

com.dooris.bpm.actionhandler.RenameInstanceHandler

Parameter name	Default value	Description	Valid examples

Parameter name

Default value

Description

Valid examples

instanceName mandatory

N/A

instanceName will determine the name of the process instance.

Variables are specified as ${variablename}

Onboarding of ${nameOfTheEmployee}

writeNameInVariable

N/A

Specify the name of the process variable where the new instance name will be stored.

newInstanceName

keepInstanceName

false

If enabled, the instance's old name is kept, and the new name is appended to the current name, separated by a dash ( - ).

Example result: “oldName - newName"

true

Example:

In this example, we will use a form for a new employee which has a field with a variable called nameOfTheEmployee.

Parameter name	Description	Example Values

Parameter name

Description

Example Values

instanceName

The variable nameOfTheEmployee is used here with the fixed text 'Onboarding of' to create employee specific onboarding forms.

Onboarding of ${nameOfTheEmployee}

The name of the process instance will be changed when ‘Rename Instance Handler’ is started after entering the employee name as John Doe.

Process instance with the updated name:

Related content