Hook usage

A Hook Usage defines which task stage hook will be executed during a task execution. It also defines at which position the stage hook applies in the execution process. It is not possible to specify any single hook usage twice in a task.

The hook usage list is ordered. If two hook usages are set at the same place in the task template, they are executed in the order specified in the hook usage list. If such hook usages are set for the same stage and origin in both task template and task, then the stage hook in the template hook usage is executed first.

Concepts and more information

Properties

The table below documents the available properties for task stage hook usages. The 'name' column displays the property name as it can be used in Groovy and Java Scripts.

Name

Type

Default

Description

Active

active

Boolean

true

Specifies whether the rule is active and therefore used, or inactive and therefore ignored, when a task is executed.

Description

description

String

n/a

An optional description for this object. The description can contain multiple lines to give more context on the configured object. The description is not used in a technical context.

Hook phase

origin

Origin

PRE

Displays whether the Stage Hook is executed before (PRE) or after (POST) the stage.

POSt

The hook is executed after the specified stage.

PRE

The hook is executed before the specified stage.

Parameters

parameters

List

n/a

Parameters can be defined on a task stage hook, and with the task stage hook usage they receive their final values. For each existing parameter in the task stage hook, another parameter is created with its name suffixed by the string ValueType. For example, an additional parameter SeedValueType is created for the parameter Seed.

This specifies the type of the associated parameter.

Constant

Indicates that the value of the parameter is a constant. If this is selected, any value can be specified.

Custom Parameter

Specifies that the associated parameter is a custom parameter. The user can select from all custom parameters of the desired data type specified on the task template. When the hook executes, the current value of the custom parameter is used.

Stage

stage

String

n/a

This defines in which stage the task stage hook currently resides. The Stage it resides in can originate from either a task or a workflow. The stage must be specified using the full name (e.g. "Stage1", "Stage2", etc.), otherwise the stage cannot be found and the hook will not be executed.

Tags

tags

Tag

n/a

Contains the tags that apply to this object. These tags can be used in the search to find objects quickly and effortlessly.

Task stage hook

taskStageHook

TaskStageHook

n/a

Specifies the Stage Hook that is to be used.

Actions

The available actions are described below. Some actions apply to the list, while others are specific to selected task stage hook usages.

List Actions

The following actions are available on the task stage hook usages list. If the action is disabled a tooltip will provide the exact reason for the deactivation. The required permissions are described in detail for each action.

  • Bulk Delete

  • Create

  • List History

  • Ordering

Delete the selected objects.

The following options are available:

Cascade

Recursively delete depending objects.

When using cascade, dependent objects are deleted first also with cascade enabled. Thus, a cascade deletion is a recursive function that deeply searches for dependent objects and deletes them first. There is only a confirmation for the first object. The dependent objects are deleted without confirmation but only when the user has the DELETE permission.

This feature is only available in development mode. More information about development mode can be found in the chapter User Settings. It should be used with caution.

An object in the result list can have two different states, these are:

DELETED

The object could be deleted.

NOT_DELETED

The object could be not deleted. This may be because the executing person does not have a delete permission on the object or the object is still referenced by others. A detailed reason can be determined with the help of the error message. If the object is still in use, these objects are also displayed.

The following permissions are required on the list:

  • READ

  • WRITE

Creates a new object in the current list. Depending on the object type either a popup dialog is shown for the most important settings, or the complete object is shown in edit mode. The dialog provides the option to create the object and remain in the current list or to switch to the newly created object in edit mode to perform further changes.

The following permissions are required on the list:

  • CREATE

The history list tracks all modifications made to objects within it. A new record is added each time an object is created, edited, or deleted. A record indicates who made the change, which object was affected, and when the change was made.

For more information about the concept of the history refer to the history concepts.

The following permissions are required on the list:

  • READ

Opens a new view on the list that allows the user to specify the ordering of the elements using drag and drop. Confirm the new ordering with Save Changes.

The following permissions are required on the list:

  • READ

  • WRITE

Object Actions

The following actions are available on specific task stage hook usages. In order to execute the action, the user must possess the necessary permissions for the object. The permissions required for each action are described individually. If the user does not have these permissions, the action will be disabled and the tooltip will provide the exact reason for the deactivation.

  • Copy

  • Delete

  • Edit

  • Object History

The copy action creates an identical copy of the object. A new entry is created in the object list and all properties in the new object are set identical to the copied object.

The following permissions are required:

  • READ

  • WRITE

Delete the object. If the object is still used by another entity, an error message is displayed, and the object is not deleted. The delete operation must be confirmed in a separate popup.

The following options are available:

Cascade

Recursively delete depending objects.

When using cascade, dependent objects are deleted first also with cascade enabled. Thus, a cascade deletion is a recursive function that deeply searches for dependent objects and deletes them first. There is only a confirmation for the first object. The dependent objects are deleted without confirmation but only when the user has the DELETE permission.

This feature is only available in development mode. More information about development mode can be found in the chapter User Settings. It should be used with caution.

The following permissions are required:

  • READ

  • WRITE

Opens the current entity in edit mode.

The following permissions are required:

  • READ

  • WRITE

The history displays all changes made to the respective XDM object, including any changes made to its rules.

Each change record includes information about the operation performed (e.g. CREATE, UPDATE, DELETE), the timestamp, and the user responsible for the change.

For more information about the concept of the history refer to the history concepts.

The following permissions are required:

  • READ