CoreAgentJobs
Name: Core Agent Jobs
Type: Core
Description: List of jobs to be executed on predefined schedules
| Field | Documentation |
|---|---|
| JobId | Unique identifier for jobs. |
| Name | Job name. |
| AgentName | Name of the service that will execute the job. (Example: PassScheduleAgent.) |
| Priority | Priority of job. Lower numbers take precedence over higher numbers. |
| Enabled | Allows job to be temporarily disabled without deleting the job record. (1 = enabled, 0 = disabled) |
| FromDate | Job will only run on dates >= StartDate. Zero or null indicates infinite into the past. |
| ToDate | Job will only run on dates <= EndDate. Zero or null indicates infinite into the future. |
| StartTime | Job will only run at times of day >= StartTime. If -1 or null then it assumes the job does not start automatically by itself, however it may be started by another job if it is specified in the other job's NextJobId. Value is in seconds from midnight. |
| EndTime | Job will only run at times of day < EndTime. If -1 or null then it assumes job ends by 23:59:59. Value is in seconds from midnight. |
| WeekTemplate | 7-digit flag to schedule jobs within a week. 1 for schedule, 0 for unscheduled. 1st digit represents Sunday. For example: 1001001. |
| Interval | Time interval in seconds that the job will be re-run, counting from the StartTime up to < EndTime. For example, if StartTime is 9:00, EndTime is 18:00 and Interval is 3600 then the job will run at 9:00, 10:00, 11:00...,17:00, but not at 18:00. If Interval is zero or null then the job is run only at the StartTime. If a currently running job has not completed by the next interval, then that interval is skipped. Value is in seconds from midnight. |
| MaxLength | Maximum length of time that a job can run. If > 0 the job can only run for this amount of time once it is started. The job will be cancelled if it has not completed in this time. If MaxLength is zero or null then there is no time limit and the job will run to completion. Value is in seconds from midnight. |
| RepeatCount | Number of times to repeat the job once started at each Interval. If zero or null, then the job runs only once per Interval. The count resets at each new Interval; however, if a series of repeating jobs does not complete by the next interval then it may cause the next interval run to be skipped. |
| RepeatDelay | Delay time interval to repeat a job. If > 0 then the job will pause for this number of seconds between each repeat run. Value is in seconds from midnight. |
| NextJobId | JobId of another job which is to be started as soon as this job completes. The other job will not be started if this job was stopped due to reaching its MaxLength. |
| Comments | User provided description of the job. |
| JobData | An XML parameter string that is passed to the job's agent service when it is started. The format of the contents is specific to each unique job AgentName. |
| LoginName | The identityId to be used when calling the job agent service. |
| LoginPassword | Identity password to be used when calling the job agent service. |
| Clone | if 1, indicates this is a temporary copy of another job and is only to be executed once. Cloned jobs are automatically deleted after being run once. |
| jobType | Description type name of job used for display purposes. |