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.

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

Determines the name of the Control-M installation to which the job belongs.

Defines the name of the parent folder to which the job folder belongs.

Defines the name of the SMART folder to which the job belongs.

(z/OS Only) Defines the name of the library that contains the SMART folder.

Defines the name of the job processing definition.

Defines the name of the file that contains the job script.

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.

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.

Indicates the type of job (task) to be performed by Control-M.

Valid Values:

• Job

• Detached

• Command

• Dummy

• External

• (z/OS Only) Started_Task

Defines the Control‑M/EM user who defined the job.

Defines the name of the library or directory where the job script resides.

Defines the command string supplied when the job Task Type is Command.

Defines the host name of an Agent computer or name of a host group to which the job is submitted.

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

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

Valid Values: 0–99

Default: 0

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

Indicates the latest time for submitting the job.

Format: (hhmm) or (>).

Determines the time that the job is expected to finish.

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

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

Valid Values:

• 0: No

• 1: Yes

  Default: 0

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

Valid Values:

• 0: No

• 1: Yes

  Default: 0

Determines the type of cyclic job:

• C: Interval (Rerun Every).

• V: Interval sequence (Rerun using the following interval sequence).

• S: Specific times (Run at).

Determines the maximum delay in minutes permitted for a late submission when selecting a specific time.

Describes a list of time intervals, separated by commas, of up to 4,000 characters including commas.

Describes a list of times, separated by commas, which supports time synonyms.

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.

Indicates whether the job should use the INSTREAM_JCL.

Valid Values:

• Y

• N

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

Valid Values:

• 0

• 1

Default: 0

Determines whether SYSDATA is to be archived.

Valid Values:

• 0: No

• 1: Yes

Default: 0

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

INTERVAL="00000M"

Default: 0

Defines the name of an alternate job script library/directory.

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) Describes the job.

Defines the name of the file containing job documentation.

Defines the name of a library or directory containing the job documentation file.

Determines the days of the month to order the job.

Indicates the relationship between specified Days values and Weekdays values.

Valid Values:

• A: AND

• O: OR

Determines the days of the week to order the job.

Determines specific dates to order the job in mmdd format.

Defines a user defined calendar that specifies a set of days.

Defines a calendar to be used to validate specified weekdays to order the job.

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

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

Valid Values:

• 0: No

• 1: Yes

Default: 0

Describes how to shift the scheduling date of the job.

Valid Values:

• Ignore Job.

• Prev Day.

• Next Day.

• No Confcal.

Determines the number of days to shift the scheduling date of the job.

Valid Values: -62–62.

Determines the maximum number of days to retain the SYSDATA archive dataset for jobs that ended NOTOK. Subparameter of AUTOARCH.

Valid Values: 00–98, or 99 to indicate that SYSDATA is retained for an unlimited number of days.

Determines the maximum number of job runs to retain the SYSDATA archive dataset for jobs that ended NOTOK. Subparameter of AUTOARCH.

Valid Values: 000–998, or 999 to retain SYSDATA data for all runs.

Defines the name of the JCL member to use when the job is automatically rerun.

1–8 characters.

(z/OS Only) Determines the number of days to retain the job in the History Jobs file.

(z/OS Only) Determines the maximum number of generations of a job to keep in the History Jobs file.

Indicates whether a job scheduling is shifted to a previous working day in the CONFCAL calendar.

Valid Values:

• Y

• N

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

Valid Values:

• S: START

• E: END

• T: TARGET

Determines the relationship between the specified Rule-Based Calendars and the basic scheduling criteria for the job.

Valid Values:

• A: AND

• O: OR

Determines whether one or multiple data sets are used to catalog sysdata.

Valid Values:

• 0: Multiple

• 1: Single

Default: 0

Defines the name of a partitioned dataset (PDS) to be checked for free space.

Determines the minimum number of free partitioned dataset tracks required by the library specified for the PDSNAME parameter.

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

(z/OS Only) Prevents dataset clean up before the original job run.

Valid Values:

• Blank: Does not perform data set clean up before the original job run.

• 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).

Default: Blank

Determines the months when the job can run.

Valid Values:

• 0: Not run

• 1: Run

Default: 0

Determines the job output (OUTPUT) handling options.

Valid Values:

• Release

• Delete

• Copy

• Move

• File

• NewDest

• ChangeClass

Defines certain OPTION values, such as Release and NewDest, that require additional information.

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

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.

Valid Values:

0: Do not ignore.

1: Ignore relevant prerequisite conditions.

Default: 0

Defines the name of the user who created the job.

Determines the date that the job was created.

Determines the time that the job was created.

Defines the name of the user who last modified the job.

Determines the date that the job was last modified.

Determines the time when the job was last modified.

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

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

Indicates the type of external application, such as SAP or Oracle, that the external application job runs on. Up to 10 characters. Mandatory for external application jobs.

Indicates the version of the external application, such as SAP or Oracle, that the external application job runs on. Up to 10 characters. Mandatory for external application jobs.

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

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

Broadcasts job submission details to all Agents in a specified Host Group.

Valid Values:

• Y: Runs as multi-Agent job.

• N: Does not run as multi-Agent job.

  Default: N

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

Format: YYYYMMDD

(z/OS Only) Indicates the end of the time interval during which the job or SMART folder can be ordered.

Format: YYYYMMDD

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

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

• JES2: Identifies the system that initiates and executes the job.

• JES3: Identifies the processor that executes the job.

Specifies the host in the JES network executes the job.

For internal use.

Indicates the wrapper for the Rule-Based Calendars listed with the RULE_BASED_ CALENDAR_NAME parameter.

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.

Defines an In Condition.

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

• NAME: (Mandatory) Defines the name of the In Condition. String. 1–255 characters, case sensitive.

• ODATE: Order date of the In Condition.

  Default: ODAT

• AND_OR: Relationship between conditions.

  Valid Values:

  • A: AND

  • O: OR

Default: A

Defines an Out condition.

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

• NAME: Name of the Out condition.

  1–255 characters, case-sensitive.

• ODATE: Order date of the Out condition.

  Valid Values:

  Default: ODAT

• SIGN: Indicates whether to add or delete the condition.

  Valid Values:

  • ADD

  • DEL

  Default: ADD

Defines a Variable expression.

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

• EXP: The Variable expression.

  %%PARM1=%%TIME

Defines the Quantitative resource.

QUANTITATIVE NAME="TAPEDRIVE" QUANT="1"

• NAME: Name of the quantitative resource.
  1–20 characters, case-sensitive.

• QUANT: Quantity of the resource.

  Valid Values: 0–9999.

  Default: 1

Defines a Control resource.

CONTROL NAME="Resc1" TYPE="E"

• NAME: (Mandatory) Name of the Control resource. String.

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

• TYPE: Type of resource.

  Valid Values:

  • E: Exclusive

  • S: Shared

  Default: E

Defines a Shout message.

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

• WHEN:Condition under which the Shout message is sent.

  Valid Values:

  • OK

  • NOTOK

  • RERUN

  • LATESUB

  • LATETIME

  • EXECTIME

  Default: OK

• DEST: Recipient of the shout message. 1–16 characters, case-sensitive.

• URGENCY: Indicates the urgency of the Shout message.

  Valid Values:

  • R: Regular

  • U: Urgent

  • V: Very urgent

  Default: R

• MESSAGE: Text of the message. 1 - 255 characters, spaces allowed.

• TIME: Time that the message is sent. For the late submission value the format is #ddd (such as #004).

Determines the step range in the job that can be used in an ON PGMST statement.

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

• NAME: Name for the range. 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 characters.

• FPROCS: Name of the procedure to be run. as the first procedure step in the range. 1–8 characters.

• TPGMS: Last program step in the range. 1–8 character string.

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

• TPROCS: Last procedure step in the range. 1–8 character string.

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

(Optional)

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

• STMT: A character string containing a statement from the job script file. Mandatory for the On Statement/Code parameter. 1–132 characters.

• CODE: Return codes or statuses that can satisfy the step or code event criteria if returned upon termination of the specified job steps. 1–255 characters.

• PGMS: Step in the program. 1–8 characters.

• PROCS: Step in the process. 1–8 characters.

• AND_OR:

  Relationship between On statements.

  Valid Values:

  • AND

  • OR

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

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.

Shout message wrapper.

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

• DEST: Recipient of the Shout message.1 - 16 characters, case-sensitive.

• URGENCY: Urgency of the Shout message.

  Valid Values:

  • R: Regular

  • U: Urgent

  • V: Very urgent

  Default: R

• MESSAGE: Text of Shout message. 1–255 characters, spaces allowed.

Specifies prerequisite conditions to be added or deleted.

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

• NAME: Condition name. 1–20 characters, case-sensitive.

• ODATE: (Mandatory) Condition date. String. Default: ODAT

• SIGN: Specifies whether to add or delete the condition.

  Valid Values:

  • ADD

  • DEL

  Default: ADD

Defines a Variable expression.

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

• EXP: The Variable expression.

  %%PARM1=%%TIME

Forces a specified job when the current job is performed.

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

• DSN: (z/OS Only) Library for SMART folder.

• FOLDER_NAME: Name of the SMART folder to which the job belongs. 1–10 characters.

• NAME: Name of the job.

• ODATE: Original scheduling date for the job.

  Default: ODAT

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

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

• OPTION: Output handling options.

  Valid Values:

  • Release

  • Delete

  • (Not z/OS)Copy

  • (Not z/OS)Move

  • File (z/OS Only)

  • NewDest (z/OS Only)

  • ChangeClass (z/OS Only)

• PAR: Certain OPTION values require that you supply additional information (such as Release, NewDest).

• FROM: Limits the job output (OUTPUT) handling operation to only OUTPUTs from the specified class.

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

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

  • 1: Confirmation

FPGMS: Step at which the job must be restarted. 1–8 characters.

FPROCS: Program step within the called procedure. String. 1–8 characters.

TPGMS: Step at which restarted job must terminate. 1–8 characters.

TPROCS: Program step within the called procedure. 1–8 characters.

Sends mail when the job run is complete.

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

  • U: Urgent

  Default: R

• DEST: Recipient of the message.

• CC_DEST: Additional recipient of the message.

• SUBJECT: Brief text description of the message contents.

• MESSAGE: Text of the message.

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

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

• NAME: Name of the Control‑M/Analyzer rule.

• PAR: Arguments that are passed to the Control-M/Analyzer rule. 1–45 characters.

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

• URGENCY: (Mandatory) The urgency level of the ticket that is opened in Remedy.

  Valid Values:

  • L:Low

  • M: Medium

  • H: High

  • U: Urgent

  • C: Clear

    Default: L

• 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.

Indicates if the sub-folder is a reference folder.

Valid Values:

• 1: Yes

• 0: No

Default: 0