Executed Task

Description

The executed task list shows all executed tasks and workflows which are running or finished. This includes executions directly started, started by a data shop, started via plugins or the public REST API.

Detail visualization

The detail view of a task execution in the user interface is structured as follows:

  • At the beginning, a circle with a color indicates whether the task execution succeeded or failed.

  • To the right of this there is general information, such as the executable, i.e. the task or the workflow that was executed. Furthermore, there is the information by which user this execution has been started and from when to when it has been executed.

  • The area of Task Runtime Information contains a summary of the significant values of the task execution, like the number of selected tables or the extracted rows.

  • Below that is a listing of stages that have been executed including the duration of each stage. If there was an error on a stage, it is prominently displayed. This information is only shown if the current user has DIAGNOSE permission on the executed task.

  • In addition to the indication of how long a single stage was executed, there is the possibility to view the reports and logs of each stage via a button.

Permissions

Executions 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.

DIAGNOSE

This permission controls access to diagnostic data of a task execution. The diagnostic data consists of the stages, their outputs and the batch reports.

EXECUTE

Specifies that the grantee may execute the object, or schedule the object for later execution. This permission only applies to objects that are executable, i.e. tasks, task templates, workflows, workflow templates, and data shops.

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.

Properties

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

Name

Type

Default

Description

Current progress

currentProgress

Number

n/a

Shows the progress in percent of an execution. Valid values are in the range from 0 to 100 and is only valid during execution.

Current progress message

currentProgressMessage

String

n/a

Defines a message to show together with the progress value. This message can be up to 1024 character and is only valid during execution.

Duration (HH:MM:SS)

duration

Number

0

Duration of a task execution in seconds

End time

endTime

Timestamp

n/a

End time of the task execution.

Error message

errorMessage

String

n/a

Exit description of the task execution.

Executable

executableName

String

n/a

Name from Executable. This is either the name of a task or a workflow.

Executable path

executablePath

String

n/a

Link to Executable. This is either a task or a workflow.

Exit code

exitCode

Number

n/a

Exit code of the task execution.

Requested By

requestedBy

PermissionRecipient

n/a

Name of the user who has requested the task execution. If the task execution has no requester, the field remains empty.

Started By

startedBy

PermissionRecipient

n/a

Name of the user who started the task execution.

Start time

startTime

Timestamp

n/a

Start time of the task execution.

Status

status

Enum

UNKNOWN

Shows the current status of the execution. The status is displayed as colored circle with a description when holding the mouse cursor over the circle. Displayed values are:

CANCELED (CANCELED)

Execution was aborted

COMPLETE (COMPLETE)

Successful finished executions

ERROR (ERROR)

Not completed but failed with an error

REJECTED (REJECTED)

The same task is already running

RUNNING (RUNNING)

Still in execution

WAITING (WAITING)

Not started yet. The execution is waiting for a free execution slot, because too many executions run at the same time, or in the case the execution uses the same mapping table container as a currently active execution for WRITE access.

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.

Dir. size (kB)

workingDirectorySize

Number

0

Shows the size of the task working directory on disk in KB (1024 byte blocks). For workflows this value shows the summarized size of each task working directory executed within the workflow.

Actions

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

List Actions

The following actions are available on the executions 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

  • Delete older than

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

This action deletes executions that are older than the specified period. The action is available on the execution list. The user can specify a duration, for example older than 30 days and the action will delete all task executions that are older than the specified duration. The duration has to be specified according to the duration syntax. The action only considers these executions on which the current user has READ permission.

Be careful when using this action. It does not check whether the user performing the action has DELETE permissions on the individual execution. Permitted users can delete other users' executions, even if they don’t have explicit access to those executions.

The following permissions are required on the list:

  • DELETE on execution list

  • READ

Object Actions

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

  • Abort Execution

  • Cleanup Execution

  • Data Preview

  • Delete

  • Event List

  • Export Execution

  • Internal Log

  • Reorder

  • Restart

  • Resume

Stops the running task execution. Completed or failed executions do not have this action.

The following permissions are required:

  • EXECUTE

  • READ

This action deletes all files of a task execution to free the used disk space. This affects files which are placed in the mounted task directory, like reports and logs. The task execution itself will be preserved. This cleanup can be done manually or automated with the property Delete execution files on success.

The following permissions are required:

  • EXECUTE

  • READ

XDM offers a data preview feature for RLP and table copy tasks, allowing to view the extracted data during task execution. This helps prevent the insertion of incorrect data into the target and ensures that necessary data is not accidentally deleted.

It is particularly useful when designing RLP or modified table copy tasks, as it allows for verification of extracted data before insertion or deletion in the target environment.

More details about the concepts and required permissions of the data preview can be found here Using data preview in RLP and TC tasks

The following permissions are required:

  • BROWSE permission on the connections of the source and/or target environment

  • READ permission on the connections of the source and/or target environment

  • READ permission on the task or the task template

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

This list shows all registered events for the object. It includes events that are specific to the object, or for that type.

The following permissions are required:

  • READ

The export action generates a zip file of this task execution. The export file contains all information produced during a task execution. This information can be used to analyze the cause of the failed execution. In addition, all logs and reports are written to the export file. The task execution can be exported even if the task did not run successfully, then all logs and reports are available, which were available up to this stage.

The following permissions are required:

  • DIAGNOSE

  • READ

This action can be used to view the internal log of a task or workflow execution. This is useful for troubleshooting if the execution did not start correctly.

The following permissions are required:

  • READ

This action restarts the execution of a task or workflow which was previously ordered by a data shop. This results in a new execution with the same set of parameters as in the original execution.

The following permissions are required:

  • EXECUTE

  • READ

This action restarts the execution of a task or workflow. This results in an execution of the same stages as in the original execution. For instance, if the original execution was a resumed task and started at stage 3 then the restart also begins with stage 3. There is no option to select other stages in the restart action. If the same task or workflow is already running, the execution will be rejected. Before execution commences, a number of consistency checks are performed. If these checks return no errors, then the task/workflow is restarted immediately. The progress can be followed under the menu point Executed Tasks. Any errors produced by the consistency checks are displayed immediately and the task/workflow is not executed.

The following permissions are required:

  • EXECUTE

  • READ

This action continues a partially executed task.

For resume, the user is also given the option of specifying which stages should be executed. All stages which either failed or were not started in the previous task execution will be offered for selection. If the task execution is completed, the resume action will not be available. Workflows have no resume action.

If a task execution is continued, the mapping table containers are deleted from the task directory of the previous execution. This serves to optimize memory usage in the xdm-tasks directory and prevents unnecessary space consumption. Due to this behavior, however, it is only possible to continue the last task execution.

It is not necessary to run all remaining stages with the resume action. The resumed execution can itself be resumed.

The following permissions are required:

  • EXECUTE

  • READ

Reports

List all reports referenced under Report Options for the executed object, which is either based on a task template or a workflow template. The report data is based on the query specified in the task execution report

The following operations are available for task execution reports:

Filter

Displays all rows containing the filter expression in any of the columns.

Download as CSV

Triggers a download of a CSV file containing the report data.