Job Structure

Use the Job structure to contain information about jobs.

The Job structure is used in the SchedulerService Service.

Some Job properties are optional, and may not be present if not relevant to the Job (for example, depending on the Job Trigger type).

Job Structure Fields

Fields Description

Job Reference

A unique reference for the job associated with an instance.

Name

A short descriptive name for the job.

Description

The text description of the job that describes its actions to end users.

User ID (author ID)

The user ID that created the job.

Script Type

The type of script used to run the job (VBScript, JScript, Java, or NQCmd).

Script ID (Path of Agent)

The path to the script that runs the job.

Use to call the WebCatalogService API to return the agent definition. For more information, see Example - Finding and Displaying all Agents in the WebCatalogService.

Max Run Time (in ms)

The maximum time in milliseconds that the job can run.

Running Instances Count

The total number of currently running instances of this job.

Max Concurrent Instances

The maximum number of concurrent running instances. For an unlimited number of concurrent instances, set this value to zero.

Time Zone

The time zone that is used to execute the job. If missing the timezone is assumed to be the scheduler local timezone.

Last Run Date Time

The last date and time the job started to execute.

Next Run Date Time

The next date and time the job will execute.

Begin Date

The date when the first recurrent interval runs.

Start Time

The time the job starts.

End Date

The date when the first recurrent interval ends.

End Time

The time the job completes.

Interval Minutes

The number of minutes between subsequent executions of a job during the recurrent interval.

Disabled

Specifies that a job script does not execute when the trigger expires.

Delete Job When Done

Specifies whether to delete a job after it completes.

Execute When Missed

Specifies whether to execute a job if running it has failed to occur at the scheduled time.

Job Trigger (with details depending on type)

Specifies what triggers a job including details that depend on job type.

A Job Trigger can be one of the following values:

RunNever, RunOnce, RunDaily, RunWeekly, RunMonthlyByDate, RunMonthlyByDayOfWeek.