Show TOC

Background documentationSetting Job Definition Properties Locate this document in the navigation structure

 

On the job definition tab of job definitions and job chains you can specify standard object properties like Name and Application as well as scheduling properties like Default Queue and Priority.

Naming and Location

Every job definition requires a unique name and should be part of an application. Applications are there to store your job definitions in containers along with other objects, that belong together. This allows you to migrate your processes or back them up easily with the Import/Export module.

Job Keep

Every job definition that is to be deleted automatically needs to have a keep clause. The keep clause defines how many jobs or how long jobs will be kept in the system. The default is to keep all jobs.

Scheduling Parameters

You can also set the default values of scheduling parameters, which are also available in the submit wizard.

  • Default Queue - the queue that should be used by default

  • Priority - the default priority of the job

  • Resource - the resource of the job, will be used when selecting the process server in the queue, only process servers with the same resource are allowed to execute the job.

  • Hold On Submit - the default value for the scheduling parameter Hold on Submit which defines the status of the job after the submit. Can be true, false (the default), or   =<expression→   in job chain jobs, which should be a boolean RedwoodExpressionLanguageexpression.

When a job definition has missed its window for execution, it is set to overdue, you may configure the reaction here.

  • Act when jobs are overdue - When a job has missed its window, change the status and/or raise an event.

    • Set overdue jobs to status

      • Scheduled - job will be executed the next time the window opens.

      • Overdue - marks the job as overdue, requires operator intervention.

      • Canceling - cancels the job, may require operator intervention.

      • Held - holds the job, requires operator intervention.

    • Raise event for overdue jobs

Format

Jobs can potentially generate output files. These can be log files that are guaranteed to contain log records in standard format, text files containing freely formatted information or error messages, or more complex files such as PDF or HTML files. Which files can be generated is dependent on the type of job that is executed.

The system will set the Format of the files created by the job.

Values

Field

Description

Default Value

Partition

The partition of the job definition

GLOBAL

Name

Name of the job definition

Application

The name of the application

Keep

The number of jobs to keep in history

All

Restrict to Time Window

The time window at which the job should run

Time Zone

The time zone used to interpret the time window and/or submit frame

Default Queue

The default queue of the job definition, the queue can be changed at submit time.

Priority

The priority of the job, value from 1-100, 100 having the highest priority

Resource

The resource of the job definition, used to determine on which process server the job will be run

Default Output Format

The format of the job output files when the extension can not be mapped

Text

Default Log Format

The format of the job log files when the extension can not be mapped

Text

Hold On Submit

Should the job be submitted on hold by default?

No.

Maximum Restarts

If the job is automatically restarted, how many times may this happen

Act when jobs are overdue

Should the system alert you when a job is outside of its time window because it could not start on time?

No

Set overdue jobs to status

The status an overdue job should be set to

Raise event for overdue jobs

The event that is raised when the job is late.

Returncode Map To Completed

The return code that represents a successful execution of the job, this field must contain all successful returncodes if it is set, including 0.

0