copydefjob XML file parameters

The following table lists input file parameters for the copydefjob utility:

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.

COPYJOB

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

FOLDER_NAME

Name of the SMART Folder to which the job belongs.

NOTE: At least one of the following SMART Folder parameters must be included in the arguments file: DATACENTER, FOLDER_NAME, FOLDER_DSN

EXAMPLE: FOLDER_NAME FROM="Tbl5NYC" TO="Tbl7NYC"

FROM

Name of the SMART Folder specified in the job processing definition that is being copied. String. Mandatory.

TO

The folder name in the job processing definition copy. String. Optional.

FOLDER_DSN

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

NOTE: At least one of the following SMART Folder parameters must be included in the arguments file: DATACENTER, FOLDER_NAME, FOLDER_DSN

EXAMPLE: FOLDER_DSN FROM="Lib1" TO="Lib1_COPY"

FROM

Name of the library containing the SMART Folder in the job processing definition that is being copied. String. Mandatory.

TO

Name of the library in the job processing definition copy. String. Optional.

DATACENTER

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

NOTE: At least one of the following SMART Folder parameters must be included in the arguments file: DATACENTER, FOLDER_NAME, FOLDER_DSN

EXAMPLE: DATACENTER FROM="EM_Montreal" TO="EM_Paris"

FROM

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

TO

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

JOBNAME

Name of the job processing definition.

EXAMPLE: JOBNAME FROM="Job3"

FROM

String. Mandatory.

FILE_NAME

Name of the file that contains the job script.

EXAMPLE: FILE_NAME FROM="Mem3"

FROM

String. Mandatory.

SUB_APPLICATION

Name of the group to which the job belongs. Used as a descriptive name for related groups of jobs.

EXAMPLE: SUB_APPLICATION FROM="Grp_HR"

FROM

String. Mandatory.

APPLICATION

Name of the application to which the job’s group belongs. Used as a descriptive name for related groups of jobs.

EXAMPLE: APPLICATION FROM="App3""

FROM

String. Mandatory.

TASKTYPE

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

EXAMPLE: TASKTYPE FROM="Detached"

FROM

Mandatory. Valid values:

  • Job
  • Detached
  • Command
  • Dummy

(z/OS only) Valid values:

  • Started_Task
  • Cyclic_Job
  • Cyclic_Task
  • Emergency_Job
  • Emergency_Cyclic_Job
  • Emergency_Task
  • Emergency_Cyclic_Task

FOLDER
_ORDER_ METHOD

Optional.

EXAMPLE: FOLDER_ORDER_ METHOD FROM="Job3"

FROM

String. Mandatory.

CREATED_BY

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

EXAMPLE: CREATED_BY FROM="emuser"

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.

FROM

String. Mandatory.

FILE_PATH

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

EXAMPLE: FILE_PATH FROM="Mem1"

FROM

String. Mandatory.

CMDLINE

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

EXAMPLE: CMDLINE FROM="C:\Format"

FROM

String. Mandatory.

HOSTID

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

EXAMPLE: HOSTID FROM="Com3"

FROM

String. Mandatory.

RUN_AS

Run_As name associated with the job. This parameter is used by the Control-M/Server security mechanism. Optional.

EXAMPLE: RUN_AS FROM="emuser"

FROM

String. Mandatory.

MAXRERUN

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

EXAMPLE: MAXRERUN FROM="1"

Valid values: 0-99. Default: 0

FROM

String. Mandatory.

TIMEFROM

Indicates the earliest time for submitting the job.

EXAMPLE: TIMEFROM FROM="1430"

FROM

String. Mandatory.

TIMETO

Indicates the latest time for submitting the job.

EXAMPLE: TIMETO FROM="1600"

FROM

String. Mandatory.

DUE_OUT

Time that the job is expected to finish.

EXAMPLE: DUE_OUT FROM="1500"

FROM

String. Mandatory.

PRIORITY

Indicates Control-M job priority.

EXAMPLE: PRIORITY FROM="AA"

FROM

String. Mandatory.

CRITICAL

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

EXAMPLE: CRITICAL FROM="0"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

CYCLIC

Indicates if the job is cyclic (to be rerun at regular intervals). Optional.

EXAMPLE: CYCLIC FROM="0"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

CYCLIC_TYPE

Determines the type of cyclic job:

  • Interval
  • IntervalSequence
  • SpecificTimes

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

CONFIRM

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

EXAMPLE: CONFIRM FROM="0"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

AUTOARCH

Determines whether SYSDATA is to be archived.

EXAMPLE: AUTOARCH FROM=0"

FROM

Mandatory. Valid values:

  • 0 (Default)
  • 1

INTERVAL

Specifies the 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"

FROM

String. Mandatory.

OVERRIDE_PATH

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

EXAMPLE: OVERRIDE PATH FROM="lib3"

FROM

String. Mandatory.

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.

EXAMPLE: MAXWAIT FROM="4"

FROM

String. Mandatory.

DESCRIPTION

Free text description of the job. String.

EXAMPLE: DESCRIPTION FROM="data backup from 120399"

FROM

String. Mandatory.

DOCMEM

Name of the file containing job documentation. String.

EXAMPLE: DOCMEM FROM="mem4"

FROM

String. Mandatory.

DOCLIB

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

EXAMPLE: DOCLIB FROM="AcctFiles"

FROM

String. Mandatory.

DAYS

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

EXAMPLE: DAYS FROM="ALL"

FROM

String. Mandatory.

DAYS_AND_OR

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

EXAMPLE: DAYS_AND_OR FROM="AND"

FROM

String. Mandatory.

WEEKDAYS

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

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

FROM

String. Mandatory.

DATE

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

EXAMPLE: DATE FROM="0312"

FROM

String. Mandatory. Dates can be 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"

FROM

String. Mandatory.

WEEKSCAL

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

EXAMPLE: WEEKSCAL FROM="2"

FROM

String. Mandatory.

CONFCAL

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

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

FROM

String. Mandatory.

RETRO

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

EXAMPLE: RETRO FROM="0"

FROM

Mandatory. Valid values:

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

SHIFT

Describes how to shift the scheduling date of the job.

EXAMPLE: SHIFT FROM="PREVDAY"

FROM

Mandatory. Valid values:

  • IGNOREJOB
  • PREVDAY
  • NEXTDAY
  • NOCONFCAL

SHIFTNUM

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

EXAMPLE: SHIFTNUM FROM="-10"

FROM

String. Mandatory.

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"

FROM

Integer. Mandatory.

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"

FROM

String. Mandatory.

RERUNMEM

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

EXAMPLE: RERUNMEM FROM="Mem45"

FROM

String. Mandatory.

RETEN_DAYS

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

EXAMPLE: RETEN_DAYS FROM="5"

FROM

String. Mandatory.

RETEN_GEN

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

EXAMPLE: RETEN_GEN FROM="3"

FROM

String. Mandatory.

TASK_CLASS

Job class for the task.

EXAMPLE: TASK_CLASS FROM="Distribution"

FROM

Mandatory. Valid values:

  • Distribution
  • Decollation

PREV_DAY

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

EXAMPLE: PREV_DAY FROM="N"

FROM

Mandatory. 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="START"

FROM

Mandatory. 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"

FROM

Mandatory. 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"

FROM

Mandatory. Valid values:

  • AND
  • OR

SYSDB

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

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

FROM

Mandatory. 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"

FROM

String. Mandatory.

MINIMUM

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

EXAMPLE: MINIMUM FROM="5"

FROM

Integer. Mandatory.

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="DAILY"

FROM

String. Mandatory.

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

    EXAMPLE: PREVENTNCT2 FROM="1"

FROM

Mandatory. Valid values:

  • 0
  • 1

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

Months when the job can run. Optional.

EXAMPLE: JAN FROM="0"

FROM

Mandatory. Not including a month is the same as including a month having the value 0. Valid values:

  • 0 (Default)
  • 1

OPTION

Job output (OUTPUT) handling options.

EXAMPLE: OPTION FROM="Copy"

FROM

Mandatory. Valid values:

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

PAR

Certain OPTION FROM values (such as Release, NewDest) require additional information. The PAR parameter holds this information as a string.

EXAMPLE: PAR FROM="mem3.log"

FROM

String. Mandatory.

FROM

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

EXAMPLE: FROM FROM="5"

FROM

String. Mandatory.

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)

FROM

String. Mandatory.

APPL_TYPE

Indicates the 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"

FROM

Mandatory. String. Up to 10 characters.

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.6"

FROM

Mandatory. String. Up to 10 characters.

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"

FROM

Mandatory. String. Up to 30 characters.

CM_VER

Indicates the 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"

FROM

Mandatory. String. Up to 10 characters.

MULTY_AGENT

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

EXAMPLE: MULTY_AGENT FROM="N"

FROM

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

EXAMPLE: ACTIVE_FROM FROM="20070315"

FROM

Mandatory. Date Format: YYYYMMDD

ACTIVE_TILL

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

EXAMPLE: ACTIVE_TILL FROM="20070315"

FROM

Mandatory. Date Format: YYYYMMDD

TIMEZONE

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

EXAMPLE: TIMEZONE FROM="EST"

FROM

Mandatory. String. Default: GMT

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

FROM

String. Mandatory.

EXAMPLE: SYSTEM_AFFINITY FROM="SYS3"

REQUEST_NJE
_HOST

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

FROM

String. Mandatory.

EXAMPLE: REQUEST_NJE_HOST FROM="OS5"

SCHEDULING
_ENVIRONMENT

(z/OS only) Indicates the JES2 workload management scheduling environment that is to be associated with the job.

FROM

String. Mandatory.

EXAMPLE: SCHEDULING_ENVIRONMENT FROM="SCHD2"

CREATION
_USER

Name of the user who created the job. String.

EXAMPLE: CREATION_USER FROM="emuser"

FROM

String. Mandatory.

CREATION
_DATE

Date on which the job was created. String.

EXAMPLE: CREATION_DATE FROM="1212"

FROM

String. Mandatory.

CREATION
_TIME

Time at which the job was created. String.

EXAMPLE: CREATION_TIME FROM="1230"

FROM

String. Mandatory.

CHANGE
_USERID

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

EXAMPLE: CHANGE_USERID FROM="emuser"

FROM

String. Mandatory.

CHANGE
_DATE

Date that the job was last modified. String.

EXAMPLE: CHANGE_DATE FROM="1204"

FROM

String. Mandatory.

CHANGE_TIME

Time that the job was last modified. String.

EXAMPLE: CHANGE_TIME FROM="1650"

FROM

String. Mandatory.

Parent Topic

copydefjob