Event

An XDM event object is definition for a situation that is triggered by a user action. Events allow the user to integrate with XDM processing and execute custom code in specific situations. An event definition includes a type that determines when the event is triggered, such as when a data shop is requested or a task execution is finished. It also includes a custom script that is executed when the event is triggered. The scope of the event can be limited to a specific type of object or even specific objects.

Permissions

Events have specific permissions to manage user access. The table below displays the available permissions and their purposes.

For more details about the concept of XDMs permission management refer to Permission Management.

Permission

Description

ADMINISTRATION

Specifies that the grantee can grant and revoke permissions to and from other users.

A user that creates an object automatically receives the ADMINISTRATION permission on that object.

DELETE

Specifies that the grantee can delete objects of the selected types.

READ

Specifies that the grantee has read permission on the object. The grantee is able to see the object in lists and can see all of the object’s details, such as rules or access permissions.

In addition, the grantee can reference this object. For example, a user who has READ permission on a credential object can refer to this credential object when creating a new database connection.

WRITE

Specifies that the grantee has the permission to change the settings and attributes of an object. This also includes modifying any rule lists that might be associated with the object (for example, the selection rules of a task template).

Properties

The table below documents the available properties for events. 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

Specify whether the event is active or inactive. The event script will only be executed if the event type is triggered and the event is active.

Executing user

credential

Credential

n/a

This credential defines a technical user. If a credential is specified, the script context will run with the privileges of that user. If no credential is specified, the event will run with the privileges of the user who triggered the event.

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.

Name

displayName

String

n/a

Specifies the name of the object. The name is used to display and identify the object in lists. The name can contain any valid UTF-8 characters. This field is mandatory.

Event type

eventType

Enum

ON_OBJECT_CREATE

The trigger when the event script is executed.

The following list shows the supported types:

ON_CASC_FINISHED (ON_CASC_FINISHED)

This event is triggered when the configuration-as-code job finishes its work. The script has access to the scheduled execution object and therefore to the status of the last run and its output.

ON_DATASHOP_APPROVED (ON_DATASHOP_APPROVED)

This event is triggered when a data shop request is approved. The script provides access to the requested execution, data shop, and the user who made the request, as well as the approving user.

ON_DATASHOP_REJECTED (ON_DATASHOP_REJECTED)

This event is triggered when a data shop request is rejected. The script provides access to the requested execution, data shop, and the user who made the request, as well as the approving user.

ON_DATASHOP_REQUESTED (ON_DATASHOP_REQUESTED)

This event is triggered when a user requests a data shop and requires approval from another user. The script can access the requested execution and has access to the data shop and the requesting user.

ON_EXECUTION_FINISHED (ON_EXECUTION_FINISHED)

This event is triggered when an execution finishes, either successfully or in an error state. The script has access to the execution object, which provides all information about the execution, including its status.

ON_EXECUTION_STARTED (ON_EXECUTION_STARTED)

This event is triggered when a new task or workflow execution begins. The script can access the execution object, which provides access to the task template, workflow template, or data shop, as well as information about the user who started and requested the execution. The event will not be triggered if the execution is queued in the WAITING state. It will only be fired after the execution status has reached the STARTING state.

ON_EXPORT (ON_EXPORT)

This event is triggered when an object is exported. When using zip export this event is triggered for each main xdm object. The script has access to the exported objects and can modify them and thus the exported YAML. It also has access to the user who initiated the export. NOTE: Many event execution logs are generated by the zip export, for this it is advisable to set the execution log retention period.

ON_IMPORT (ON_IMPORT)

This event is triggered when an object is imported. When using zip import this event is triggered for each object yaml file. The script has access to the imported objects and the user who triggered the import. The event can be used to modify imported objects before saving. NOTE: Many event execution logs are generated by the zip import, for this it is advisable to set the execution log retention period.

ON_OBJECT_CREATE (ON_OBJECT_CREATE)

This event is triggered when a user presses the 'create' button in the user interface to create a new object. The script has access to the object and can modify its settings before it is displayed to the end-user.

ON_OBJECT_CREATED (ON_OBJECT_CREATED)

This event is triggered when a new object is created. The script has access to both the created object and the user who triggered the event.

ON_OBJECT_DELETE (ON_OBJECT_DELETE)

This event is triggered before an object is deleted. The script has access to both the object and the user performing the deletion.

ON_OBJECT_DELETED (ON_OBJECT_DELETED)

This event is triggered after an object was deleted. The script has access to both the object and the user who triggered the event.

ON_OBJECT_UPDATED (ON_OBJECT_UPDATED)

This event is triggered after an object has been updated. The script has access to both the updated object and the user who triggered the update event.

ON_SCHEDULE_EXECUTION_TRIGGERED (ON_SCHEDULE_EXECUTION_TRIGGERED)

This event is triggered when a scheduled execution becomes active. The result of the execution could be a running task or workflow, or it could have been failed. If it failed, no task execution is initiated, and the user must check its state. The script has access to the scheduled execution and can read its last status.

Execution log retention period

executionLogRetentionPeriod

String

-1

Specifies how long execution logs are kept for the event. If an execution log is older than the specified retention period, the XDM service will remove it. If the execution logs should not be deleted automatically, the retention period must be set to -1. Otherwise, the input must start with P for a date period or with PT with a time period.

A detailed description of the period syntax can be found here.

Libraries

libraries

File

n/a

A list of files that can be accessed in the script code. When editing the event, all XDM files of the specified script language are made available for selection. The content of the selected XDM files is automatically added to the script context. All methods, variables, and classes in the selected files can be accessed in the event script.

Script

script

String

n/a

The script executed when the event is triggered. It has access to various parameters. The exact list parameters can be found here.

The script is executed with the privileges of the user who triggered the event. If a credential is specified, the script will be executed with the privileges of that user.

Script language

scriptLanguage

Enum

JAVA_SCRIPT

This script language specifies in which language all scripts of the object are written. Currently the following languages are supported:

Groovy (GROOVY)

specifies that the code is written in Groovy.

JavaScript (JS)

specifies that the code is a JavaScript.

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.

Target type

targetClass

String

n/a

Limit the scope of the event trigger to a specific type. The event script will only be executed if the event is triggered for the type specified in this event definition. If this field is left empty, the event script will be executed for all objects regardless of their type.

Target objects

targetObjects

List

n/a

Limit the scope of the event trigger by providing a list of XDM objects. The event will only be executed if the event type is triggered for one of the objects in the list. If the event type is triggered for other objects, the script of this event definition will not be executed.

Only objects of the specified target type can be selected.

Actions

The available actions are described below. Some actions apply to the list, while others are specific to selected events.

List Actions

The following actions are available on the events 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 Create Permission

  • Bulk Delete

  • Bulk Export

  • Check

  • Create

  • List History

Create a new permission on the selected objects. Shows in the result list whether the permission could be granted on the respective object. Only these permissions can be granted that are existing on the underlying object.

A permission in the result list can have three different states, these are:

CREATED

The permission successfully granted on the object.

MERGED

The granted permission already exists on the object and merged with the new permission.

SKIPPED

The permission could not be granted, because of missing administration permission on the object.

The following permissions are required on the list:

  • ADMINISTRATION

  • READ

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:

  • DELETE

  • READ

Exports the selected objects.

YAML

Generates a YAML file containing all the object’s settings. The user has the option to download the export file, or to paste the content in the import dialog. The YAML export is particularly suitable for importing the exported objects again via the XDM UI.

ZIP

This export writes several individual YAML-files. Each YAML-file is stored in a directory according to its type. For example, when exporting a native table backup task template named 'A backup template', a YAML-file 'A backup template.yaml' is created inside the directory /TaskTemplate/native-table-backup-task-template/ of the ZIP-file. This kind of export is suitable for usage in git-repositories together with XDM’s configuration as code feature.

Related and dependent objects can optionally be included in the export. The export dialog has the following options:

Include dependent objects

Dependent objects only belong to the exported object like rules and tasks.

Include permissions

Permissions of each exported object, only when the object supports permissions. Some objects like rules don’t have permissions.

Include referenced objects

Referenced objects exist by their own and are used in the exported object like connections and environments.

Include objects that depend on referenced objects

Also include the dependent objects of the referenced objects. E.g. the rules of a modification set or the rules in an application model version.

Objects on which the user does not have READ permission are not exported. This includes dependent and referenced objects. However, the reference to an object will be exported. For example a connection object would refer to the credential, even if the user does not have READ permission on the credential. The definition of the credential object itself will not be part of the export file. This can lead to issues during the import, because the connection cannot be created without an existing credential.

The following permissions are required on the list:

  • READ

This action validates the object and its dependencies, reporting configuration errors that could cause issues during task or workflow execution. The validation will cascade through the child objects of the checked objects and objects referenced by them.

For instance, if an installed application of an environment is checked, the check will process the application model, the specified version, the connection, modification sets, and involved modification methods. If an object has rules, all active rules will be checked. The modeling connection and version, including their modification sets and methods, will also be checked. Deactivated objects will not be included in recursive checks, but can be checked individually if the check is executed on the object itself.

Checks often require additional information from the context of the objects being checked, such as necessary connections or custom parameter values. The check will gather information from the objects being checked and use it to perform checks on child objects. Any required additional information must be provided before the check begins. The check queries the user to provide these missing information.

Database object checks

For all rules which reference database objects such as tables, columns, etc, the check verifies that the those objects exist in the database system. If a connection can be inferred from the context, then this connection is used. If no connection is available in the context, it must be specified before the check is executed.

Connection checks

For objects which configure access to external systems, such as connections or storage locations, the configuration check verifies that access can be established using the given credentials. Furthermore, additional operations on database connections are performed to check whether the credential user has the necessary authorization to access relevant database objects. In particular, the credential user’s permission to read source tables and write to target tables is verified. Similarly, for storage locations the check verifies that the credential user has permission to write to the working directory.

Code checks

For all entities containing code segments, such as modification methods or condition scripts, the syntax for the code is checked. This does not check, however, whether at run time all necessary variables are likely to be available.

The following permissions are required on the list:

  • READ

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

Object Actions

The following actions are available on specific events. 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.

  • Delete

  • Duplicate

  • Edit

  • Export

  • Object History

  • Permission Check

  • Usage

  • Uses

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:

  • DELETE

  • READ

Will create an exact copy of the current object with a different display name in the same list. Users can decide whether they want to copy child objects like rules, permissions or tasks. It is only possible to select complete classes of objects and not to select individual child objects. Copied child-objects will preserve their display name. The default is to copy all child objects.

The following permissions are required:

  • CREATE

  • READ

Opens the current entity in edit mode.

The following permissions are required:

  • READ

  • WRITE

This action allows to export XDM objects in different formats in order to import them via export or CasC in another environment.

Refer to configuration of export for more information.

Related and dependent objects can optionally be included in the export. The export dialog has the following options:

Include dependent objects

Dependent objects only belong to the exported object like rules and tasks.

Include permissions

Permissions of each exported object, only when the object supports permissions. Some objects like rules don’t have permissions.

Include referenced objects

Referenced objects exist by their own and are used in the exported object like connections and environments.

Include objects that depend on referenced objects

Also include the dependent objects of the referenced objects. E.g. the rules of a modification set or the rules in an application model version.

Include implicit created objects

Implicit created objects are tasks or workflows which were automatically created for execution. These objects won’t be exported by default, but can be included by setting this flag. When exporting implicit objects, make sure that the Include dependent objects flag is also enabled.

Objects on which the user does not have READ permission are not exported. This includes dependent and referenced objects. However, the reference to an object will be exported.

For example a connection object would refer to the credential, even if the user does not have READ permission on the credential. The definition of the credential object itself will not be part of the export file. This can lead to issues during the import, because the connection cannot be created without an existing credential.

The following permissions are required:

  • READ

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

The check verifies that the current user has the authorization to access the object. The check can also be performed for a specific user or role, if needed. By default, the check is performed using the current user’s credentials. It is then applied to child and referenced objects.

Additional permission checks are applied when these can be inferred from the context in which the check was started. For example, if the check is performed on a table copy task, the referenced source and target connections are checked to determine whether the given identity has source or target usage permission respectively.

The following permissions are required:

  • READ

The Usage List shows all objects that refer to the current object. It provides an overview of the relationships and makes it easy to track these relationships.

The following permissions are required:

  • READ

The Uses List shows all objects that the current object uses. It provides an overview of the relationships and makes it easy to track these relationships.

The following permissions are required:

  • READ

License Options

This object is available if the following license option is enabled:

  • COMPONENT:EVENT

The object is also available if the license package is at least: PREMIUM.