updatedef XML file parameters for jobs

The following table lists the arguments file parameters for jobs:

Parameter

Description

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.

UPDATE

These tags indicate the start and end of the UPDATE argument. Only criteria that are located between the tags are considered to be part of the argument. Mandatory.

JOB

These tags indicate the start and end of each job specification. Criteria identifying the jobs to be modified and indicating the types of modifications to be made are located between these tags. Optional.

FOLDER_NAME

Name of the folder to which the job belongs. Mandatory.

NOTE: This parameter cannot be modified.

EXAMPLE: FOLDER_NAME FROM="Tbl5NYC"

FROM

String. Mandatory.

FOLDER_DSN

(z/OS only) Name of the library that contains the (scheduling) folder. Mandatory.

NOTE: This parameter cannot be modified.

EXAMPLE: FOLDER_DSN FROM="Lib1"

FROM

String. Mandatory.

DATACENTER

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

NOTE: This parameter cannot be modified.

EXAMPLE: DATACENTER FROM="CTMNYC"

FROM

String. Mandatory.

FOLDER_ORDER_ METHOD

Optional.

NOTE: This parameter cannot be modified.

EXAMPLE: FOLDER_ORDER_ METHOD FROM="Job3"

FROM

String. Mandatory.

JOBNAME

Name of the job processing definition. Optional.

EXAMPLE: JOBNAME FROM="Job3" TO="Job3_COPY"

FROM

Mandatory.

TO

Optional.

FILE_NAME

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

EXAMPLE: FILE_NAME FROM="File3" TO="File7"

FROM

Mandatory.

TO

Optional.

SUB_APPLICATION

Name of the group to which the job belongs. Optional.

EXAMPLE: GROUP FROM="Grp_HR"

FROM

Mandatory.

APPLICATION

Name of the application to which the job’s group belongs. Optional.

EXAMPLE: APPLICATION FROM="App3" TO="App1"

FROM

String. Mandatory.

TO

String Optional.

TASKTYPE

Type of the job (task) to be performed by Control-M. Optional.

EXAMPLE: TASKTYPE FROM="Detached" TO="Dummy"

FROM

Mandatory.

Valid values:

  • Job
  • Detached
  • Command
  • Dummy
  • External

(z/OS only) Valid values:

  • Job
  • Started_Task

    NOTE: In Control‑M/EM versions earlier than 6.1.00, the TASKTYPE format contained:

  • for z/OS, emergency and cyclic information
  • for other operating systems, critical and cyclic information

Control‑M/EM version 6.2.01 and higher can run jobs with the old TASKTYPE format. However, BMC recommends that, to specify this type of information when creating new job processing definitions, you use CRITICAL and CYCLIC parameters.

[for z/OS]

BMC recommends that, to specify this type of information when creating new job processing definitions, you use CRITICAL (a value of "1" indicates that the job is an Emergency job) and CYCLIC parameters.

NOTE: Critical path jobs are indicated by coding an * as the first character in the Priority parameter. There is no connection between critical path jobs and the Critical parameter.

TO

Optional. Valid values: Same as mandatory FROM values.

(z/OS only) Valid values: Same as z/OS FROM values.

CREATED_BY

Control‑M/EM user who defined the job. This parameter is used by the Control-M/Server security mechanism. String. Optional.

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.

EXAMPLE: CREATED_BY FROM="emuser" TO="em5"

FROM

String. Mandatory.

TO

String. Optional.

FILE_PATH

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

EXAMPLE: FILE_PATH FROM="File1" TO="File4"

FROM

String. Mandatory.

TO

String. Optional.

CMDLINE

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

EXAMPLE: CMDLINE FROM="C:\Format" TO="C\:CD Emnt"

FROM

String. Mandatory.

TO

String. Optional.

HOSTID

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

EXAMPLE: HOSTID FROM="Com3" TO="Acct4"

FROM

String. Mandatory.

TO

Host name of the agent computer on which the job copy is running Optional.

RUN_AS

Owner (user ID) associated with the job. This parameter is used by the Control-M/Server security mechanism. Optional.

EXAMPLE: OWNER FROM="emuser" TO="emhr"

FROM

String. Mandatory.

TO

String. Optional.

MAXRERUN

Maximum number of reruns that can be performed for the job. Optional.

EXAMPLE: MAXRERUN FROM="1" TO="3"

FROM

String. Mandatory.

TO

String. Optional.

TIMEFROM

Earliest time for submitting the job. Optional.

EXAMPLE: TIMEFROM FROM="1430" TO="1450"

FROM

String. Mandatory.

TO

String. Optional.

TIMETO

Latest time for submitting the job. Optional.

EXAMPLE: TIMETO FROM="1600" TO="1620"

FROM

String. Mandatory.

TO

String. Optional.

DUE_OUT

Time that the job is expected to finish. Optional.

EXAMPLE: DUE_OUT FROM="1500" TO="1530"

FROM

String. Mandatory.

TO

String. Optional.

PRIORITY

Indicates Control-M job priority. Optional.

EXAMPLE: PRIORITY FROM="AA" TO="1A"

FROM

String. Mandatory.

TO

String. Optional.

CRITICAL

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

EXAMPLE: CRITICAL FROM="0" TO="1"

FROM

Mandatory. Valid values:

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

TO

Optional. Valid values:

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

CYCLIC

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

EXAMPLE: CYCLIC FROM="0" TO="1"

FROM

Mandatory. Valid values:

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

TO

Optional. Valid values:

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

CONFIRM

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

EXAMPLE: CONFIRM FROM="0" TO="1"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

TO

Optional. Valid values:

  • 0 (Default)
  • 1

AUTOARCH

Determines whether SYSDATA is to be archived. Optional.

EXAMPLE: AUTOARCH FROM=0" TO="1"

FROM

Mandatory. Valid values:

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

TO

Optional. Valid values:

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

INTERVAL

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

EXAMPLE: INTERVAL FROM="3" TO="4"

FROM

String. Mandatory.

TO

String. Optional.

OVERRIDE_PATH

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

EXAMPLE: OVERRIDE PATH FROM="lib3" TO="lib4"

FROM

String. Mandatory.

TO

String. Optional.

MAXWAIT

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

EXAMPLE: MAXWAIT FROM="4" TO="3"

FROM

Integer. Mandatory.

TO

Integer. Optional.

DESCRIPTION

Free text description of the job. String. Optional.

EXAMPLE: DESCRIPTION FROM="data backup from 120399" TO="data backup from 021400"

FROM

String. Mandatory.

TO

String. Optional.

DOCMEM

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

EXAMPLE: DOCMEM FROM="mem4" TO="Mem67"

FROM

String. Mandatory.

TO

String. Optional.

DOCLIB

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

EXAMPLE: DOCLIB FROM="AcctFiles" TO="HRFiles"

FROM

String. Mandatory.

TO

String. Optional.

DAYS

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

EXAMPLE: DAYS FROM="ALL" TO="159"

FROM

String. Mandatory.

TO

String. Optional.

DAYS_AND_OR

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

EXAMPLE: DAYS_AND_OR FROM="AND" TO="OR"

FROM

String. Mandatory.

TO

String. Optional.

WEEKDAYS

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

EXAMPLE: WEEKDAYS FROM="1,2,4" TO="ALL"

FROM

String. Mandatory.

TO

String. Optional.

DATE

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

EXAMPLE: DATE FROM="0312" TO="0319"

FROM

String. Mandatory. Dates are written in mmdd format. There is no delimiter between dates. For example, January 10 is written in this manner: DATE="0110"

TO

String. Optional. Dates are written in mmdd format. There is no delimiter between dates. For example, January 10 is written in this manner: DATE="0110"

DAYSCAL

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

EXAMPLE: DAYSCAL FROM="shipping" TO="receiving"

FROM

String. Mandatory.

TO

String. Optional.

WEEKSCAL

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

EXAMPLE: WEEKSCAL FROM="w5" TO="w6"

FROM

String. Mandatory.

TO

String. Optional.

CONFCAL

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

EXAMPLE: CONFCAL FROM="cal99" TO="cal00"

FROM

String. Mandatory.

TO

String. Optional.

RETRO

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

EXAMPLE: RETRO FROM="0" TO="1"

FROM

Mandatory. Valid values:

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

TO

Optional. Valid values:

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

SHIFT

Describes how to shift the scheduling date of the job. Optional.

EXAMPLE: SHIFT FROM="PREVDAY" TO="NEXTDAY"

FROM

Mandatory. Valid values:

  • IGNOREJOB
  • PREVDAY
  • NEXTDAY
  • NOCONFCAL

TO

Optional. Valid values: Same values as mandatory FROM.

SHIFTNUM

Number of days to shift the scheduling date of the job. Optional.

EXAMPLE: SHIFTNUM FROM="-10" TO="5"

FROM

String. Mandatory.

TO

String. Optional.

MAXDAYS

Maximum number of days to retains the SYSDATA archive dataset for jobs that ended NOTOK. Subparameter of AUTOARCH. String. Optional.

EXAMPLE: MAXDAYS FROM="07" TO="14"

FROM

String. Mandatory.

TO

String. Optional.

MAXRUNS

Maximum number of job runs to retains the SYSDATA archive dataset for jobs that ended NOTOK. Subparameter of AUTOARCH. String. Optional.

EXAMPLE: MAXRUNS FROM="100" TO="250"

FROM

String. Mandatory.

TO

String. Optional.

RERUNMEM

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

EXAMPLE: RERUNMEM FROM="Mem45" TO="Mem7"

FROM

String. Mandatory.

TO

String. Optional.

RETEN_DAYS

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

EXAMPLE: RETEN_DAYS FROM="5" TO="7"

FROM

String. Mandatory.

TO

String. Optional.

RETEN_GEN

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

EXAMPLE: RETEN_GEN FROM="3" TO="4"

FROM

String. Mandatory.

TO

String. Optional.

TASK_CLASS

Optional.

EXAMPLE: TASK_CLASS FROM="Distribution" TO="Decollation"

FROM

String. Mandatory.

TO

String. Optional.

PREV_DAY

Optional.

EXAMPLE: PREV_DAY FROM="N" TO="Y"

FROM

Mandatory. Valid values:

  • Y
  • N

TO

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

EXAMPLE: IND_CYCLIC FROM="Y" TO="N"

FROM

Mandatory. Valid values:

  • START
  • END

TO

Optional. Valid values:

  • START
  • END

RULE_BASED_
CALENDAR

_RELATIONSHIP

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

EXAMPLE: RULE_BASED_CALENDAR_RELATIONSHIP FROM="AND" TO="OR"

FROM

Mandatory. Valid values:

  • AND
  • OR

TO

Optional. Valid values:

  • AND
  • OR

TAG_RELATIONSHIP

Relationship (AND|OR) between the specified Schedule Tag criteria and the job’s own basic scheduling criteria. This parameter is relevant only for jobs in a SMART Folder. Optional. This parameter is for backward compatibility.

EXAMPLE: TAG_RELATIONSHIP FROM="AND" TO="OR"

FROM

Mandatory. Valid values:

  • AND
  • OR

TO

Optional. Valid values:

  • AND
  • OR

SYSDB

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

EXAMPLE: SYSDB FROM="1" TO="0"

FROM

Mandatory. Valid values:

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

TO

Optional. Valid values:

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

PDSNAME

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

EXAMPLE: PDSNAME FROM="Lib_3" TO="Lib_5"

FROM

String. Mandatory.

TO

String. Optional.

MINIMUM

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

MINIMUM FROM="5" TO="6"

FROM

Integer. Mandatory.

TO

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.

EXAMPLE: CATEGORY FROM="*" TO="DAILY"

FROM

String. Mandatory.

TO

String. Optional.

PREVENTNC2

(z/OS only) Performs dataset clean up before the original job run. Optional.

EXAMPLE: PREVENTNC2 FROM="1" TO="0"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

TO

Optional. Valid values:

  • 0 (Default)
  • 1

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

Months when the job can run. Optional. Not including a month is the same as including a month with value 0.

EXAMPLE: JAN FROM="0" TO="1"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

TO

Optional. Valid values:

  • 0 (Default)
  • 1

OPTION

Job output (output) handling options. Optional.

EXAMPLE: OPTION FROM="Copy" TO="Release"

FROM

Mandatory. Valid values:

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

TO

Optional. Valid values: Same as mandatory FROM.

PAR

Certain OPTION values require that you supply additional information (such as Release, NewDest). The PAR parameter holds that information as a string. Optional.

EXAMPLE: PAR FROM="mem3log" TO="mem5log"

FROM

String. Mandatory.

TO

String. Optional.

FROM

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

EXAMPLE: FROM FROM="1" TO="2"

FROM

String. Mandatory.

TO

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)

    EXAMPLE: ADJUST_COND FROM="1" TO="0"

FROM

String. Mandatory.

TO

String. Optional.

APPL_TYPE

Type of external application (for example, SAP or Oracle) on which the external application job runs. Mandatory for external application jobs.

EXAMPLE: APPL_TYPE FROM="SAP" TO="OracleApps"

FROM

Mandatory. String. Up to 10 characters.

TO

Optional. String.

APPL_VER

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

EXAMPLE: APPL_VER FROM="4.5" TO="4.6"

FROM

Mandatory. String. Up to 10 characters.

TO

Optional. String.

APPL_FORM

Predefined set of external application parameters that are displayed in the Job Properties team. Mandatory for external application jobs.

EXAMPLE: APPL_FORM FROM="Default SAP 4.6" TO="Default SAP 4.5"

FROM

Mandatory. String. Up to 30 characters.

TO

Optional. String.

CM_VER

Version of external Application Add-on(for example, SAP or Oracle) that is installed in the Control-M installation. Mandatory for external application jobs.

EXAMPLE: CM_VER FROM="6.1.00" TO="6.1.01"

FROM

Mandatory. String. Up to 10 characters.

TO

Optional. String.

MULTY_AGENT

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

EXAMPLE: MULTY_AGENT FROM="N" TO="Y"

FROM

Mandatory. Valid values:

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

TO

Optional. String.

ACTIVE_FROM

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

EXAMPLE: ACTIVE_FROM FROM="20080315" TO="20080601"

FROM

Mandatory. Date Format: YYYYMMDD

TO

Optional. String.

ACTIVE_TILL

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

EXAMPLE: ACTIVE_TILL FROM="20080315" TO="20080601"

FROM

Mandatory. Date Format: YYYYMMDD

TO

Optional. String.

TIMEZONE

Global time zone used to calculate the interval for time-related conditions. Optional.

EXAMPLE: TIMEZONE FROM="EST" TO="GMT"

FROM

Mandatory. String.

Default: GMT

TO

Optional. String.

CREATION_USER

Name of the user that created the job. Optional.

EXAMPLE: CREATION_USER FROM="emuser" TO="em1"

FROM

String. Mandatory.

TO

String. Optional.

CREATION_DATE

Date that the job was created. Optional.

EXAMPLE: CREATION_DATE FROM="1212" TO="2012"

FROM

String. Mandatory.

TO

String. Optional.

CREATION_TIME

Time that the job was created. Optional.

EXAMPLE: CREATION_TIME FROM="1230" TO="1430"

FROM

String. Mandatory.

TO

String. Optional.

CHANGE_USERID

Name of the user that last modified the job. Optional.

EXAMPLE: CHANGE_USERID FROM="emuser" TO="emacct"

FROM

String. Mandatory.

TO

String. Optional.

CHANGE_DATE

Date that the job was last modified. Optional.

EXAMPLE: CHANGE_DATE FROM="1204" TO="1304"

FROM

String. Mandatory.

TO

String. Optional.

CHANGE_TIME

Time that the job was last modified. Optional.

EXAMPLE: CHANGE_TIME FROM="1650" TO="1700"

FROM

String. Mandatory.

TO

String. Optional.

Parent Topic

updatedef XML file rules