The first two lines of the arguments file specify the XML version, the text encoding format being used, and the location of the .dtd file.

DEFJOB

Indicates the XML root element. Job processing definitions are placed between the opening and closing DEFJOB tags. One or more jobs can be specified. Each individual job is enclosed by JOB /JOB tags.

JOB

Indicates the opening and closing tags of a single job definition. Parameters of the job are listed between the tags.

DATACENTER

Name of the Control-M installation to which the job belongs. String. Mandatory.

PARENT_FOLDER

Name of the parent folder to which the job’s folder belongs. String. Mandatory.

FOLDER_NAME

Name of the SMART Folder to which the job belongs. String. Mandatory.

FOLDER_DSN

(z/OS only) Name of the library that contains the SMART Folder. String. Mandatory.

JOBNAME

Name of the job processing definition. String. Mandatory.

NOTE: On a Windows computer, JOBNAME must comply with Microsoft naming conventions (for example, it cannot contain / and \ characters).

FILE_NAME

Name of the file that contains the job script. String. Optional.

SUB_APPLICATION

Indicates the name of the Sub Application where the job belongs logically. It is a sub-category of the Application parameter. For example, the Application is Finances, and the Sub Application is Payroll. String. Mandatory.

APPLICATION

Provides a logical name for sorting groups of jobs. This parameter is used to supply a common descriptive name to a set of related job groups. The jobs do not necessarily have to run at the same time. String. Mandatory.

TASKTYPE

Type of job (task) to be performed by Control-M. Mandatory.
Valid values:

• Job
• Detached
• Command
• Dummy
• External

(z/OS only) Valid values:

• Job
• Started_Task

CREATED_BY

Control‑M/EM user who defined the job. String. Mandatory.

NOTE: This argument is used by the Control‑M/Server security mechanism and, under certain circumstances, cannot be modified. For more information, see the Security chapter and the description of the AuthorSecurity system parameter in GUI Server parameters.

FILE_PATH

Name of the library/directory in which the job script resides. String. Optional.

CMDLINE

Command string supplied when the job Task Type is Command. String. Optional.

HOSTID

Host name of an agent computer or name of a host group to which the job is submitted. String. Optional.

RUN_AS

Identifies the user name with the authorization to execute the job. This parameter is used by the Control-M security mechanism. String. Mandatory.

MAXRERUN

Specifies the maximum number of reruns that can be performed for the job. Mandatory.

Valid values: 0-99. Default: 0

TIMEFROM

Indicates the earliest time for submitting the job. Format is (hhmm). Optional.

TIMETO

Indicates the latest time for submitting the job. Format is (hhmm) or (>). Optional.

DUE_OUT

Time that the job is expected to finish. String. Optional.

PRIORITY

Indicates Control-M job priority. 2 alphanumeric characters (AA-99). Optional.

CRITICAL

Indicates that the job is a critical-path job in Control-M. Mandatory.

Valid values:

• 0 (No. Default)
• 1 (Yes)

CYCLIC

Indicates whether the job is cyclic (to be run at regular intervals). Mandatory.

Valid values:

• 0 (No. Default)
• 1 (Yes)

CYCLIC_TYPE

Determines the type of cyclic job:

• C: Interval (Rerun Every)
• V: Interval sequence (Rerun using the following interval sequence)
• S: specific times (Run at)

CYCLIC_TOLERANCE

Maximum delay in minutes permitted for a late submission when selecting a specific time (for example 5 minutes).

CYCLIC_INTERVAL_ SEQUENCE

A list of time intervals, separated by commas (for example +30M,+2H,+1D), up to 4000 characters including commas.

CYCLIC_TIMES_
SEQUENCE

A list of times, separated by commas (for example 0800,1330,2300), which supports time synonym (for example 2730).

INSTREAM_JCL

(embedded script)

Defines a script exactly as it would be specified in a terminal for the specific computer and is part of the job definition.

An embedded script is marked with a &#10 indicator.

For Control-M for z/OS, the XML file is formatted with multiple lines that contain four digit numbers which state the length of the line, followed by the line’s text.

USE_INSTREAM_JCL

Indicates whether the job should use the INSTREAM_JCL.

Valid values: Y or N

CONFIRM

Indicates whether the job must be manually confirmed by the Control‑M/EM user before it runs. Mandatory. Valid values:

• 0 (Default)
• 1

AUTOARCH

Determines whether SYSDATA is to be archived. Mandatory.
Valid values:

• 0 (No. Default)
• 1 (Yes)

INTERVAL

Specifies the length of time (in minutes) to wait between reruns of a job or between cyclic runs of a job. Integer. Optional.

INTERVAL="00000M"

Default: 0.

OVERRIDE_PATH

Name of an alternate job script library/directory. String. Optional.

MAXWAIT

Number of extra days (beyond the original scheduling date) that the job is allowed to remain in the Active Jobs database awaiting execution. Integer. Optional

DESCRIPTION

Free text description of the job. String. Optional.

DOCMEM

Name of the file containing job documentation. String. Optional.

DOCLIB

Name of a library or directory containing the job documentation file. String. Optional.

DAYS

Days of the month on which to order the job. String. Optional.

DAYS_AND_OR

Indicates the relationship between specified Days values and Weekdays values. Optional.
Valid values:

• A: AND
• O: OR

WEEKDAYS

Days of the week on which to order the job. String. Optional.

DATE

Specific dates on which to order the job. String. mmdd format. Optional.

For example, January 10 is written as: DATE="0110"

DAYSCAL

Name of a user-defined calendar used to specify a set of days. String. Optional.

WEEKSCAL

Name of a calendar to be used to validate specified weekdays on which to order the job. String. Optional.

CONFCAL

Specifies a calendar that is used to validate all specified days and dates on which to schedule the job. String. Optional.

RETRO

Indicates whether the job is scheduled for possible execution after its original scheduling date (odate) has passed. Mandatory.
Valid values:

• 0 (No. Default)
• 1 (Yes)

SHIFT

Describes how to shift the scheduling date of the job. Optional.
Valid values:

• Ignore Job
• Prev Day
• Next Day
• No Confcal

SHIFTNUM

Number of days to shift the scheduling date of the job. Optional. Valid values: -62 to 62.

MAXDAYS

Maximum number of days to retain the SYSDATA archive dataset for jobs that ended NOTOK. Subparameter of AUTOARCH. Optional. Valid values: 00 – 98, or 99 to indicate that SYSDATA is retained for an unlimited number of days.

MAXRUNS

Maximum number of job runs to retain the SYSDATA archive dataset for jobs that ended NOTOK. Subparameter of AUTOARCH. Optional. Valid values: 000 – 998, or 999 to retain SYSDATA data for all runs.

RERUNMEM

Name of the JCL member to use when the job is automatically rerun. String. 1 - 8 characters. Optional.

RETEN_DAYS

(z/OS only) Number of days to retain the job in the History Jobs file. String. Optional.

RETEN_GEN

(z/OS only) Maximum number of generations of a job to keep in the History Jobs file. String. Optional.

PREV_DAY

Flag to indicate whether job scheduling is shifted to a previous working day in the CONFCAL calendar. Optional.
Valid values:

• Y
• N

IND_CYCLIC

Indicates whether the interval between further runs of a cyclic job is counted from the start or the end of the previous job run. Mandatory.

Valid values:

• S: START
• E: END
• T: TARGET

RULE_BASED_CALENDAR_RELATIONSHIP

Relationship (AND|OR) between the specified Rule-Based Calendars and the job’s own basic scheduling criteria. Optional.
Valid values:

• A: AND
• O: OR

SYSDB

Determines whether one or multiple data sets are used to catalog sysdata. Mandatory. Valid values:

• 0 (Multiple-Default)
• 1 (Single)

PDSNAME

Name of a partitioned dataset (PDS) to be checked for free space. String. Optional.

MINIMUM

Minimum number of free partitioned dataset tracks required by the library specified for the PDSNAME parameter. Integer. Optional.

CATEGORY

Name of a Control-D report decollating mission category that must be scheduled under Control-D when the job is scheduled under Control-M. String. Optional.

PREVENTNCT2

(z/OS only) Prevents dataset clean up before the original job run Optional.
Valid values:

• Blank – Does not perform data set clean up before the original job run. Default.
• N – Does not prevent clean up.
• Y - Prevents data set clean up. This value is not valid for started tasks.
• L (List) – Do not perform data set clean up before the original job run. Do generate                  messages that would be required for CDG adjustment during restart.
• F (Flush) – Halt processing of the job if any data set clean up error is detected (even if                    z/OS would not have stopped processing the job).

JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC

Months when the job can run. Mandatory.
Valid values:

• 0 (Not run. Default)
• 1 (Run)

OPTION

Job output (OUTPUT) handling options. Optional.
Valid values:

• Release
• Delete
• Copy
• Move
• File
• NewDest
• ChangeClass

PAR

Certain OPTION values (such as Release, NewDest) require additional information. String. Optional.

FROM

Limits the OUTPUT handling operation to only OUTPUTs from the specified class. String. Optional.

ADJUST_COND

Indicates whether to ignore prerequisite conditions normally set by predecessor jobs if the relevant predecessor jobs are not scheduled. This parameter is relevant only for jobs in a SMART Folder. Optional.
Valid values:

• 0 (Do not ignore. Default.)
• 1 (Ignore relevant prerequisite conditions)

CREATION_USER

Name of the user who created the job. String. Optional.

CREATION_DATE

Date on which the job was created. String. Optional.

CREATION_TIME

Time at which the job was created. String. Optional.

CHANGE_USERID

Name of the user who last modified the job. String. Optional.

CHANGE_DATE

Date on which the job was last modified. String. Optional.

CHANGE_TIME

Time at which the job was last modified. String. Optional.

JOB_RELEASE

For internal use. Do not include this parameter in your defjob input file.

JOB_VERSION

For internal use. Do not include this parameter in your deffolder input file.

APPL_TYPE

Indicates the type of external application (for example, SAP or Oracle Applications) on which the external application job runs. String. Up to 10 characters. Mandatory for external application jobs.

APPL_VER

Version of the external application (for example, SAP or Oracle) on which the external application job runs. String. Up to 10 characters. Mandatory for external application jobs.

APPL_FORM

Predefined set of external application parameters that are displayed in the Job Properties team. String. Up to 30 characters. Mandatory for external application jobs.

CM_VER

Indicates the version of external Application Add-on (for example, SAP or Oracle Applications) that is installed in the Control-M installation. String. Up to 10 characters. Mandatory for external application jobs.

MULTY_AGENT

When selected, broadcasts job submission details to all agents in a specified Host Group. Optional.
Valid values:

• Y – run as multi-agent job
• N – not run as multi-agent job. Default.

ACTIVE_FROM

(z/OS only) Indicates the start of a period of time during which the job or SMART Folder can be ordered. Optional.

Date Format: YYYYMMDD

ACTIVE_TILL

(z/OS only) Indicates the end of the time interval during which the job or SMART Folder can be ordered. Optional. Date Format: YYYYMMDD

TIMEZONE

Indicates the global time zone used to calculate the interval for time-related conditions.

String. Optional.

SCHEDULING_
ENVIRONMENT

(z/OS only) Indicates the JES2 workload management scheduling environment associated with the job. String. Optional.

SYSTEM_AFFINITY

Identity of the system in which the job must be initiated and executed (in JES2).

Identity of the processor on which the job must execute (in JES3). String. Optional.

REQUEST_NJE_HOST

Specifies the host in the JES network on which the job is to execute. String. Optional.

JOBISN

For internal use. String. Optional.

RULE_BASED_CALENDAR_NAMES

Wrapper for the Rule-Based Calendars listed with the RULE_BASED_ CALENDAR_NAME parameter. Optional.

RULE_BASED_CALENDAR_NAMES RULE_BASED_CALENDAR_NAME="rbc1" RULE_BASED_CALENDAR_NAME="rbc2"

RULE_BASED_CALENDAR_NAME

Name of the Rule-Based Calendars that apply to the SMART Folder. Mandatory.

INCOND

Defines the name of the In Condition. Optional.

INCOND NAME="Job1" ODATE ="ODAT" AND_OR="A"

NAME

Defines the name of the In Condition. String. Mandatory. 1-255 characters, case sensitive.

ODATE

Order date of the In Condition. String. Mandatory. Default: ODAT

AND_OR

Relationship between conditions. Optional.

Values:

• A: AND (default)
• O: OR

OUTCOND

Out condition. Optional.

OUTCOND NAME="Job1" ODATE="ODAT" SIGN="ADD"

NAME

Name of the Out condition. String. Mandatory.

1 - 255 characters, case-sensitive.

ODATE

Order date of the Out condition. String. Mandatory.
Valid values:

Default: ODAT

SIGN

Indicates whether to add or delete the condition. Mandatory. Valid values:

• ADD (default)
• DEL

VARIABLE

Wrapper for the Variable expression. Optional.

VARIABLE NAME="%%PARM1=%%TIME"

EXP

The Variable expression. String. Mandatory.

Example: %%PARM1=%%TIME.

QUANTITATIVE

Wrapper for the Quantitative resource. Optional.

QUANTITATIVE NAME="TAPEDRIVE" QUANT="1"

NAME

Name of the quantitative resource. String. Mandatory.
1 - 20 characters, case-sensitive.

QUANT

Quantity of the resource. String. Mandatory.
Valid values:
0 – 9999. Default: 1

CONTROL

Wrapper for the Control resource. Optional.

CONTROL NAME="Resc1" TYPE="E"

NAME

Name of the Control resource. String. Mandatory.

Valid values: 1-20 characters, case-sensitive, trailing blanks only.

TYPE

Type of resource.
Valid values:

• E (exclusive-default)
• S (shared)

SHOUT

Wrapper for the Shout message. Optional.

SHOUT WHEN="EXECTIME" DEST="workstation1" URGENCY="R" MESSAGE="Jobcompleted OK." TIME="1015"

WHEN

Condition under which the Shout message is sent. Mandatory.

Valid values:

• OK (default)
• NOTOK
• RERUN
• LATESUB
• LATETIME
• EXECTIME

DEST

Recipient of the shout message. String. Mandatory.

Valid values: 1-16 characters, case-sensitive. Mandatory.

URGENCY

Indicates the urgency of the Shout message. Mandatory.

Valid values:

• R (regular-default)
• U (urgent)
• V (very urgent)

MESSAGE

Text of the message. String. Mandatory.
Valid values: 1 - 255 characters, spaces allowed.

TIME

Time that the message is sent. String. Mandatory.

STEP_RANGE

Step range in the job that can be used in an ON PGMST statement. Optional.

STEP_RANGE NAME="cleanup" FPGMS="Defrag" TPGMS=""

NAME

Name for the range. 1-7 character string. Mandatory.

Valid values: 1 - 7 characters. Only trailing blanks are allowed.

FPGMS

Name of the program to be run. as the first program step in the range. 1 - 8 character string. Mandatory.

FPROCS

Name of the procedure to be run. as the first procedure step in the range. 1-8 character string. Mandatory.

TPGMS

Last program step in the range. 1-8 character string. Mandatory.

Subparameter TO is optional. If blank, its value defaults to the last step in the job.

TPROCS

Last procedure step in the range. 1-8 character string. Mandatory.

Subparameter TO is optional. If blank, its value defaults to the last step in the job.

ON

Optional.

ON STMT="CODE" CODE="rt5" AND_OR="AND"><ON

STMT

A character string containing a statement from the job script file. String. 1-132 characters. Mandatory for the On Statement/Code parameter.

CODE

Return codes or statuses that can satisfy the step or code event criteria if returned upon termination of the specified job steps.

String. Optional. Valid values: 1-255 characters.

PGMS

Step in the program. String. Optional.
Valid value: 1-8 characters.

PROCS

Step in the process. String. Optional.
Valid values:1-8 characters.

AND_OR

Relationship between On statements. Optional.
Valid values:

• AND
• OR

DO

Specifies a status for the job based on conditions specified in an On statement. Optional.

DO ACTION="OK"

ACTION

Mandatory. Valid values:

• OK (Changes the status of the job to OK)
• NOTOK (Changes the status of the job to NOTOK)
• RERUN (Reruns the job)
• SPCYC (Prevents further runs of a cyclic job)

DOSHOUT

Shout message wrapper. Optional.

DOSHOUT DEST="Wkstn2" URGENCY="R" MESSAGE="Job5 completed OK"

DEST

Recipient of the Shout message. String. Mandatory.

Valid values: 1 - 16 characters, case-sensitive.

URGENCY

Urgency of the Shout message.
Valid values:

• R (regular-default)
• U (urgent)
• V (very urgent)

MESSAGE

Text of Shout message. String, 1 - 255 characters, spaces allowed. Mandatory.

DOCOND

Specifies prerequisite conditions to be added or deleted. Optional.

DOCOND NAME="Cond1" ODATE="ODAT" SIGN="ADD"

NAME

Condition name. String, 1 - 20 characters, case-sensitive. Mandatory.

ODATE

Condition date. String. Mandatory. Default: ODAT

SIGN

Specifies whether to add or delete the condition.
Valid values:

• ADD (default)
• DEL

DOVARIABLE

Wrapper for the Variable expression. Optional.

DOVARIABLE EXP="%%PARM1=%%TIME"

EXP

The Variable expression. String. Required.

%%PARM1=%%TIME

DOFORCEJOB

Forces a specified job when the current job is performed. Optional.

DOFORCEJOB DSN="45446" FOLDER_NAME="Folder2" NAME="Job4" ODATE="ODAT"

DSN

(z/OS only) Library for SMART Folder. String. Mandatory.

FOLDER_NAME

Name of the SMART Folder to which the job belongs. String, 1-10 characters. Mandatory.

NAME

Name of the job. String. Mandatory.

ODATE

Original scheduling date for the job. String. Default: ODAT

DOOUTPUT

Handle job output (OUTPUT) when the job is done. Optional.

DOOUTPUT OPTION="Release" PAR="F" FROM=""

OPTION

Output handling options. Mandatory.
Valid values:

[All platforms]

• Release
• Delete

[not used with z/OS]

• Copy
• Move

[z/OS only]

• File
• NewDest
• ChangeClass

PAR

Certain OPTION values require that you supply additional information (such as Release, NewDest). String. Optional.

FROM

Limits the job output (OUTPUT) handling operation to only OUTPUTs from the specified class. String. Optional.

DOIFRERUN

Job steps to be executed during restart of a job. Available only at sites using Control-M/Restart. Optional.

DOIFRERUN CONFIRM="0" FPGMS="step1" FPROCS="proc1" TPGMS="step5" TPROCS="proc3"

CONFIRM

Indicates if job must be confirmed by user to be rerun.
Valid values:

• 0 (No confirmation. Default)
• 1 (Confirmation)

FPGMS

Step at which the job must be restarted. String. 1 - 8 characters. Mandatory.

FPROCS

Program step within the called procedure. String. 1 - 8 characters. Mandatory.

TPGMS

Step at which restarted job must terminate. String. 1 - 8 characters. Mandatory.

TPROCS

Program step within the called procedure. String. 1 - 8 characters.

Mandatory.

DOMAIL

Sends mail when the job run is complete. Optional.

DOMAIL URGENCY="R" DEST="[email protected]" CC_DEST="[email protected]" SUBJECT="OK" MESSAGE="Task completed OK."

ATTACH_OUTPUT

Specifies at the job level whether the OUTPUT should be sent as an email attachment.

URGENCY

Urgency of the message.
Valid values:

• R (regular - Default)
• U (Urgent)

DEST

Recipient of the message. String. Mandatory.

CC_DEST

Additional recipient of the message. String. Optional.

SUBJECT

Brief text description of the message contents. String. Optional.

MESSAGE

Text of the message. String. Mandatory.

DOCTBRULE

(z/OS only) Invokes a Control-M/Analyzer rule to be executed during the processing of a specific program step. Optional.

DOCTBRULE NAME="GOVTBAL" PAR="DOREPORT,10,%%ODATE"

NAME

Name of the Control‑M/Analyzer rule. String. Mandatory.

PAR

Arguments that are passed to the Control-M/Analyzer rule.

String. Optional. Maximum: 45 characters.

DOREMEDY

Opens a ticket in the Remedy Help Desk regarding the critical service.

URGENCY

The urgency level of the ticket that is opened in Remedy. Mandatory. Valid values are:

• L = Low (Default)
• M = Medium
• H = High
• U= Urgent
• C = Clear

SUMMARY

A brief summary is displayed in Remedy. By default, a summary of the problem appears using variables. For more information on the field's characteristics, see Remedy documentation.

DESCRIPTION

A detailed description is displayed in Remedy. By default, a description of the problem appears using variables. For more information on the field's characteristics, see Remedy documentation.