Command Name

Description

Example

STARTJOB <JOBTYPE> NAME='<name>' [UID='<uid>'] [AFFINITY='<affinity>'] [ARGS='<args>'] [EXEC_INTERVAL='<execInterval>'];

Starts the Job using arguments: - Affinity, UID and other arguments are optional inputs. - Jobtype, BROADWAY, PROCESS, USER_JOB - Name, Job’s name. - ARGS, a string represeting a JSON that passes additional arguments to the **start Job** command. For example, {"jobName":"jobTest"}. - EXEC_INTERVAL, definition of Jobs scheduling execution interval that supports three formats: - Timestamp, yyyy-MM-dd HH:mm:ss, a one time only timedatetime that schedules a Job's execution. - Time interval, HH:MM:SS to run the Job every X time. - Cron, combined **crontab** command. For example, 23 0-20/2 03 12 2. At minutes 23 past every 2nd hour from 0 through 20 on day-of-month 3 and on Tuesday in December.

STARTJOB USERJOB NAME=’CUST-TestJob1' UID='CUST-TestJob1' AFFINITY='10.21.1.85' ARGS={"testName":"Test"} EXEC_INTERVAL='00:00:30';

STOPJOB <JOBTYPE> NAME='<name>'

Stops all Jobs matching this name and type.

STOPJOB PROCESS NAME='CUST-TestJob2';

STOPJOB <JOBTYPE> NAME='<name>' UID='<uid>'

Stops a specific Job matching an UID.

STOPJOB PROCESS NAME='CUST-TestJob2' UID='CUST-TestJob2';

RESTARTJOB <JOBTYPE> NAME='<name>'

Restarts all matching Jobs with this name and type.

RESTARTJOB USERJOB NAME='CUST-TestJob1';

RESTARTJOB <JOBTYPE> NAME='<name>' UID='<uid>'

Restarts a specific Job matching an UID.

RESTARTJOB USERJOB NAME='CUST-TestJob1' UID='CUST-TestJob1';

RESUMEJOB <JOBTYPE> NAME='<name>' UID='<uid>'

Resumes a specific matching Job. This command applies only to an existing Job.

RESUMEJOB PROCESS NAME='CUST-TestJob2' UID='CUST-TestJob2';

UPDATEJOB <jobType> NAME='<name>' [UID='<uid>'] [AFFINITY='<affinity>'] [ARGS='<args>'] [EXEC_INTERVAL='<execInterval>'] [RESET_END_TIME=true/false]

Updates properties of an existing Job: - AFFINITY, combined comma-separated list of DCs and IPs. For example, DC1,DC2...,IP1,IP2... - EXEC_INTERVAL, definition of Job's scheduling execution interval, supports three formats: - Timestamp, yyyy-MM-dd HH:mm:ss a one-time only datetime for scheduling the Job's execution. - Time interval, HH:MM:SS, run every X time. - Cron, crontab command: e.g. 23 0-20/2 03 12 2. At minute 23 past every 2nd hour from 0 through 20 on day of month 3 and on Tuesday in December. - ARGS, string representing a JSON that passes additional arguments to the update Job command. For example {"userJobName":"userTest"} - RESET_END_TIME, only when using the recurring CRON job mode: - set to TRUE - the next execution immediately. - set to FALSE - the next execution as previously scheduled. NOTE that to update a cron job to a one-time job, use EXEC_INTERVAL=''

UPDATEJOB USERJOB NAME=’CUST-TestJob2' UID='CUST-TestJob2' AFFINITY='10.21.1.85' ARGS={"userJobName":"userTest"} EXEC_INTERVAL='00:00:30';

Command Name

Description

Example

JOBSTATUS [x days ago]

When days are not provided, returns all active (not archived) Jobs.

When days are provided, returns the status of all Jobs that have been executed over the last X days, including archived Jobs.

JOBSTATUS;

JOBSTATUS 2 days ago;

JOBSTATUS <JOBTYPE>

Returns the status of all Jobs running according to the jobType.

JOBSTATUS TestJob1;

JOBSTATUS USER_JOB

Returns the status of all running Jobs that match the given type and name.

JOBSTATUS USER_JOB 'TDM.fnValidateAndRebuildRefTables';

JOBSTATUS <JOBTYPE> '<NAME>' WITH UID='<UID>'

Returns the status of all Jobs that match the give type, name and UID.

JOBSTATUS PROCESS TestJob2 WITH UID='CUST-TestJob2';