updatedef XML file parameters for SMART folders

The following table lists the arguments file parameters for SMART folders:

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 located between the tags are considered to be part of the argument. Mandatory.

SMART_FOLDER

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

FOLDER_NAME

Name of the SMART Folder.

NOTE:

  • This parameter cannot be modified.
  • At least one of the following folder parameters must be included in the input file: DATACENTER, FOLDER_NAME, FOLDER_DSN

    EXAMPLE: FOLDER_NAME FROM="Tbl42"

FROM

String. Mandatory

DATACENTER

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

NOTE:

A TO subparameter cannot be specified for this parameter.

  • At least one of the following folder parameters must be included in the input file: DATACENTER, FOLDER_NAME, FOLDER_DSN

    EXAMPLE: DATACENTER FROM="CTMNYC"

FROM

String. Mandatory

FOLDER_DSN

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

NOTE:

  • A TO subparameter cannot be specified for this parameter.
  • At least one of the following folder parameters must be included in the input file: DATACENTER, FOLDER_NAME, FOLDER_DSN

    EXAMPLE: FOLDER_DSN FROM="CTMNYC"

FROM

String. Mandatory

FOLDER_ORDER_ METHOD

Optional.

NOTE: A TO subparameter cannot be specified for this parameter.

EXAMPLE: FOLDER_ORDER_ METHOD FROM="CTMNYC"

FROM

String. Mandatory

SUB_APPLICATION

Name of the group to which the SMART Folder belongs. Used as a descriptive name for related folders. Optional.

EXAMPLE: GROUP FROM="Grp_HR" TO="Grp_ACCT"

FROM

String. Mandatory.

TO

String. Optional.

USED_BY

Optional.

EXAMPLE: USED_BY FROM="fff" TO="ffg"

FROM

String. Mandatory.

TO

String. Optional.

USED_BY_CODE

Optional.

EXAMPLE: USED_BY_CODE FROM="C***" TO="D***"

FROM

String. Mandatory.

TO

String. Optional.

MODIFIED

Optional.

EXAMPLE: MODIFIED FROM="1101" TO="1102"

FROM

String. Mandatory.

TO

String. Optional.

LAST_UPLOAD

Date of the last folder upload. String. Optional.

EXAMPLE: LAST_UPLOAD FROM="1101" TO="1102"

FROM

String. Mandatory.

TO

String. Optional.

CHECKSUM

Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

FOLDER_ID

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

EXAMPLE: FOLDER_ID FROM="Tbl001" TO="Tbl002"

FROM

String. Mandatory.

TO

String. Optional.

REAL_FOLDERID

Optional.

EXAMPLE: REAL_FOLDERID FROM="43556" TO="43557"

FROM

String. Mandatory.

TO

String. Optional.

JOBNAME

Name of the job processing definition. Optional.

EXAMPLE: JOBNAME FROM="Job3"

FROM

String. Mandatory.

TO

String. Optional.

FILE_NAME

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

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

FROM

String. Mandatory.

TO

String. Optional.

APPLICATION

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

EXAMPLE: APPLICATION FROM="App3""

FROM

String. Mandatory.

TO

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

ADJUST_COND

Indicates whether to ignore prerequisite conditions normally set by predecessor jobs if the relevant predecessor jobs are not scheduled. Optional. Valid values:

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

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

FROM

String. Mandatory.

TO

String. Optional.

CONFIRM

Indicates whether 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

PRIORITY

Indicates Control-M job priority. Optional. Two-character alphanumeric from 00 to ZZ.

EXAMPLE: PRIORITY FROM="AA" TO="BB"

FROM

String. Mandatory.

TO

String. Optional.

TIMEFROM

Indicates the earliest time for submitting the SMART Folder. Format: hhmm. Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

TIMETO

Indicates the latest time for submitting the SMART Folder. Format: hhmm. Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

DUE_OUT

Time that the job is expected to finish. Optional.

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

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.

DESCRIPTION

Free text description of the job. String. Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

CREATED_BY

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

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

NOTE: The New Day Procedure compares the Author and Owner for each job to check if the job’s user has authorization to submit the job. Control-M/EM security levels determine who can edit the Author value (any user or administrators only). For more information, see the Security chapter and the description of the AuthorSecurity system parameter in GUI Server parameters.

FROM

String. Mandatory.

TO

String. Optional.

CREATION_USER

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

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

FROM

String. Mandatory.

TO

String. Optional.

CREATION_DATE

Date that the SMART Folder was created. String. Format: ddmm. Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

CREATION_TIME

Time the SMART Folder was created. String. Format: hhmm. Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

CHANGE_USERID

Name of the user that last modified the SMART Folder. String. Optional.

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

FROM

String. Mandatory.

TO

String. Optional.

Parent Topic

updatedef XML file rules