< Back
Print

Job-related Tasks

Job-related tasks enable you to execute certain actions at the start or end of an export job.

They can be found here.

The following article explains all base settings of the job-related tasks but it is advised to read the specific article of your intended task for further information.

Disabled

Whether the task is disabled and shall not be executed. Disabling a task collapses its editor but without losing the configured settings.

Job event

Specifies when to export the task. job finished is most commonly selected.

Task to do

Specifies the task to execute. The list of tasks can be found in the same category as this article on this site. Each selected task adds settings of their own to the editor. The task specific settings are explained in their according articles.

After the task

Specifies how the job shall fare after the task is completed. continue job is most commonly selected.

Conditions

The execution of tasks can be limited to certain conditions.

Type

Specifies the type of the condition.

Error Count

The number of errors the job had. Useful for only sending a mail if the export job had export errors.

Job context (User- or Play-Button)

(Since version 1.13)

You can control whether, for example, task plugins should be executed when jobs were started by using the play button and not if they were started from the PIM/MAM. The shown example does only execute the task, if an user started the Job by using the play buttons.


Job Context Value
Job was started in the Normal Mode or Detail Mode by a user using the play buttons / Job was started by an automation like an ActiveJob Above 0
Job was started by using the context export dialog in the PIM, MAM or Deep Search Portal Below 0

Job start mode

(Since version 1.13)

You can control that tasks are not executed in development job mode.

Job Typ Constant
Job Normal Mode 0
Job Detail Mode 1
Job Pilot Mode 2

Operator

Specifies the comparison operator.

Value

Specifies the value to type is compared to.

Placeholders & Job Parameters

Most text settings of job-related tasks support placeholders.

Example: File Name = export-{JOB:EndDateUnformatted}.xlsx

This is the list of natively supported placeholders.

Placeholder Description
{JOB:StartDate} Start date of the job
{JOB:EndDate} Finish date of the job
{JOB:StartDateUnformatted} Start date of the job in the format <<YYYYMMDD_HHMMSS>>
{JOB:EndDateUnformatted} Finish date of the job in the format <<YYYYMMDD_HHMMSS>>
{JOB:RootID} RootID of the job
{JOB:RecordCount} Package count of the job
{JOB:ErrorCount} Error count of the job
{JOB:All} All Log Messages
{JOB:Errors} All Error Log Messages
{JOB:Warning} All Notice Log Messages
{JOB:Plugins} Selected Actions of the Job
{STATION:Name} Name of the station
{STATION:StationType} Type of the station
{STATION:Url} URL of the station
{STATION:ConnectorUrl} URL to the API of the Application
{USER:UserID} ID of the user
{USER:UserName} Username of the user

Job Parameters can be used as placeholders, too.

Job-related tasks in the Job Pilot

By default, the Job Pilot does not execute job-related tasks, since it is only intended for small test exports. You can re-activate them though, by disabling this checkbox in the context editor.

As with everything in the context editor, this setting is only temporary and will not be stored in the job itself, meaning also, that this checkbox needs to be disabled again once the Job Pilot is opened anew.

Was this article helpful?
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents