Scheduled Task

The scheduled task list contains all tasks which are planned to be executed at a later time or date. This includes both one time and recurring schedules.

One time scheduled tasks disappear from the list when the execution time is reached. At this time they move to the executed tasks list. Recurring executions using a cron expression stay in the scheduled list. The Scheduled time is updated to the next matching date when the execution time is reached and a new entry in the executed tasks list is created.

Concepts and more information

Using the Data Shop

Permissions

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

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.

Properties

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

Name	Type	Default	Description
Cron expression cronExpression	String	n/a	Cron is used to schedule commands at a specific time. Only recurring executions have a cron expression. A Cron expression is a string comprised of 6 or 7 fields separated by white space. Details of cron syntax can be found under Scheduling.
Cron description cronExpressionDescription	String	n/a	A converted description of the cron expression for better understanding.
Executable executable	Object	n/a	A reference to the task or workflow which was executed. The object reference consists of a link to the template and a link to the executable task or workflow.
Next trigger time nextExecutionTime	Timestamp	n/a	Indicates the date and time when XDM will start the execution of the underlying task or workflow. This only applies to executions that were scheduled with a cron expression. This field is only populated when the status of the execution is ACTIVE.
Output output	String	n/a	If XDM was unable to initiate the underlying task or workflow execution, this field may provide additional information regarding any errors that occurred during the start process. This only applies to executions that were scheduled with a cron expression.
Requested By requestedBy	PermissionRecipient	n/a	This field contains the user who requested the execution if it was scheduled by a data shop. It is only populated if a user requested a data shop order and specified a scheduled time, or if the data shop uses the time window option.
Started By startedBy	PermissionRecipient	n/a	The user who scheduled the task or workflow. If a technical user initiated the scheduled execution through a data shop, this field will display the technical user.
Start time startTime	Timestamp	n/a	If the execution is a one-time event, the start time will be indicated in this field. If the execution is scheduled regularly using a cron expression, this field will be left empty.
Status status	String	n/a	Indicates the status of the execution. Possible values are: ACTIVE The scheduled execution is currently active and will wait until the scheduled time has expired. Once the time has elapsed, XDM will initiate the underlying task or workflow execution. ERROR The execution was started, but an error occurred. The output field might contain more details about the error. This only applies to executions that were scheduled with a cron expression. PAUSED This state indicates, that XDM will not trigger an execution when the scheduled time has elapsed. This only applies to executions that were scheduled with a cron expression.

Name

Type

Default

Description

Cron expression

cronExpression

String

n/a

Cron is used to schedule commands at a specific time. Only recurring executions have a cron expression. A Cron expression is a string comprised of 6 or 7 fields separated by white space. Details of cron syntax can be found under Scheduling.

Cron description

cronExpressionDescription

String

n/a

A converted description of the cron expression for better understanding.

Executable

executable

Object

n/a

A reference to the task or workflow which was executed. The object reference consists of a link to the template and a link to the executable task or workflow.

Next trigger time

nextExecutionTime

Timestamp

n/a

Indicates the date and time when XDM will start the execution of the underlying task or workflow. This only applies to executions that were scheduled with a cron expression.

This field is only populated when the status of the execution is ACTIVE.

Output

output

String

n/a

If XDM was unable to initiate the underlying task or workflow execution, this field may provide additional information regarding any errors that occurred during the start process. This only applies to executions that were scheduled with a cron expression.

Requested By

requestedBy

PermissionRecipient

n/a

This field contains the user who requested the execution if it was scheduled by a data shop. It is only populated if a user requested a data shop order and specified a scheduled time, or if the data shop uses the time window option.

Started By

startedBy

PermissionRecipient

n/a

The user who scheduled the task or workflow. If a technical user initiated the scheduled execution through a data shop, this field will display the technical user.

Start time

startTime

Timestamp

n/a

If the execution is a one-time event, the start time will be indicated in this field. If the execution is scheduled regularly using a cron expression, this field will be left empty.

Status

status

String

n/a

Indicates the status of the execution. Possible values are:

ACTIVE: The scheduled execution is currently active and will wait until the scheduled time has expired. Once the time has elapsed, XDM will initiate the underlying task or workflow execution.
ERROR: The execution was started, but an error occurred. The output field might contain more details about the error. This only applies to executions that were scheduled with a cron expression.
PAUSED: This state indicates, that XDM will not trigger an execution when the scheduled time has elapsed. This only applies to executions that were scheduled with a cron expression.

Actions

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

List Actions

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

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

Object Actions

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

Delete
Edit
Event List
Pause Schedule
Resume Schedule

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.

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.