Show TOC

Background documentationJobs Raising Events Locate this document in the navigation structure

 

Jobs can be used to raise events when they reach a specific job status, this allows you to trigger other jobs.

When a job raises an event, the Raiser Comment field contains information on the raiser, this can be further customized.

The default raiser comment is the following:

Event raised by Job:${jobid} (${jobdescription}) going to status ${jobstatus}.

The following substitution parameters are available for raiser and clearer comments in job definitions and job chains:

  • ${jobid} - The job id of the raiser job

  • ${jobdescription} - the raiser job name, as displayed by the job monitor at the time of raising the event.

  • ${jobstatus} - The status of the job at the time it raised the event.

Values

Tab

Field

Description

Default Value

Raise Events

Event Definition

The event definition the job will raise once it has finished.

Raise Events

Raise Comment

The comment the raised event will have.

Event raised by Job:${jobid} (${jobdescription}) going to status ${jobstatus}.

Raise Events

Status To Raise On

The job status that makes the job raise the event once it reaches that state.

Completed

Raise Events

Error Code

The error code of the job.