AddRecurringJob

Use this action to add a new recurring job.

Required parameters

Parameter Key Value Type Parameter Description
jobOwner Alphanumeric string

The owner of the job in the appropriate format. For example, in Windows, the format might be: DOMAIN\user.

This is a key field. Cannot be blank.

Maximum length for strings is 10

jobName Alphanumeric string

The name of the Job.

Maximum length for strings is 10

gracePeriod Integer

The waiting time for the currently running job before the next job will be executed.

Minimum length for strings is 1. Maximum length for strings is 99.

status Integer

The status of the job during create.

Fixed values are 0,1.

startTime Time

Defines the time the system submits the job.

The value must be later than current time (if startDate is today).

stopDate Date

Defines the date the system is to stop running the job.

Must be greater or equal to the startDate.

Optional parameters

Parameter Key Value Type Parameter Description
jobQueue Alphanumeric string

The job queue on which you want the recurring job to run.

Maximum length for strings is 10.

frequency Fixed values

The frequency with which the system is to run the batch job.

Fixed values are halfHourly, hourly, daily, weekly, monthly, annually, weekDays, biWeekly, endOfMonth. Default value is halfHourly.

lateFlag Integer

The action to occur when the gracePeriod has been met.

Fixed values are 0,1 (0=Hold,1=Run). Default value is 0.

startDate Date

Defines the date the job is to start running.

Must be greater or equal to the current date. Default value is the current date.