The first two lines of the XML request file for this API request contain information that specifies the version of XML, the text encoding format being used, and the location of the .dtd file.

TERMS

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

TERM

The TERM tags indicate the start and the end of a group of selection criteria used to specify a folder or folders that are to be exported. Only PARAM tags that are located between the TERM tags are considered to be part of the TERM argument.

REL

Optional. Relationship between terms. Valid values:

• AND
• OR

PARAM

The selection criteria parameter used to determine those folders that are to be exported. More than one PARAM can be specified. Mandatory.

EXAMPLE: PARAM NAME="DATACENTER" OP="EQ" VALUE="Center1"

NAME

String. Mandatory.

The parameter name of any folder or SMART Folder parameter. These parameters are described in deffolder.

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

OP

Mandatory.

Describes the relationship between the NAME and the VALUE parameters of the TERM. Valid values:

• EQ
• NEQ
• NOTIN
• LIKE

VALUE

String. Mandatory.

The value of any folder, SMART Folder or Sub Folder parameter. These parameters are described in deffolder.

NOTE: Multiple values can be specified for VALUE by using the * wildcard character in place of characters at the end of an expression.

CYCLIC_TYPE

Determines the type of cyclic job:

• Interval
• IntervalSequence
• SpecificTimes

  Relevant for Control-M version 6.4.01 or later.

CYCLIC_
TOLERANCE

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

Relevant for Control-M version 6.4.01 or later.

CYCLIC_INTERVAL_ SEQUENCE

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

Relevant for Control-M version 6.4.01 or later.

CYCLIC_TIMES_
SEQUENCE

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

Relevant for Control-M version 6.4.01 or later.

MAXWAIT

Number of extra days (beyond the original scheduling date) that the jobs in the SMART Folder are allowed to remain in the Active Jobs database awaiting execution.

The value of MAXWAIT in the Rule_Based_Calendar is the value of the MAXWAIT for the jobs that use this Rule_Based_Calendar.

Integer. Optional.

REMOVEATONCE

Indicates that all jobs in the folder are not removed automatically from the Active Jobs database. Instead jobs wait for the folder to complete and are removed at the same time as the folder.

Valid values:

• Y: Yes
• N: No (default)

DAYSKEEPINNOTOK

Enables you to specify a minimum period to keep the SMART folder (and jobs) in the Active Jobs database after the folder is set to NOT OK.

Valid values:

• 0-98 (default 0)
• 99: Forever