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 .xsd file.

DEFTABLE

Indicates the beginning and end of the deffolder utility. Folder definitions are placed between the opening and closing DEFTABLE tags. One or more jobs can be specified. Each individual job is enclosed by the <SMART_FOLDER ENFORCE_VALIDATION></SMART_FOLDER> tag.

SMART_FOLDER

Closing tags of a SMART Folder definition.

SMART_FOLDER ENFORCE_VALIDATION

Determines if validation is either an error or a warning.

Valid Values: Y or N

NOTE: Relevant for Control-M Workload Change Manager only.

JOBISN

For internal use. String. Optional.

NOTE: JOBISN is the JOB_ID field in the def_job folder. Many jobs can have the same JOBISN number. However, the JOBISN number is unique in each Folder. Select the job in the Monitoring domain to see jobs IDs.

FOLDER_NAME

Defines the name of the SMART Folder to which the job belongs. String. Mandatory.

NOTE:

• The following SMART Folder parameters must be specified for each folder: DATACENTER
• FOLDER_NAME
• FOLDER_DSN (z/OS only)

FOLDER_ORDER_ METHOD

Defines the New day or User daily name. String. Optional.

DATACENTER

Name of the Control-M installation to which the SMART Folder belongs. String. Mandatory.

NOTE: The following folder parameters must be specified for each folder:

• DATACENTER
• FOLDER_NAME
• FOLDER_DSN (z/OS only)

FOLDER_DSN

(z/OS only) Library for the folder. String. Optional.

NOTE: The following folder parameters must be specified for each folder:

• DATACENTER
• FOLDER_NAME
• FOLDER_DSN (z/OS only)

REAL_FOLDER_ID

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

CYCLIC

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

Valid values:

• 0 (No Default)
• 1 (Yes)

CYCLIC_TOLERANCE

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

CYCLIC_TYPE

Determines the type of cyclic job:

• C: CYCLIC_TOLERANCE
• V: CYCLIC_INTERVAL_SEQUENCE
• S: CYCLIC_TIMES_SEQUENCE

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

LAST_UPLOAD

Date of the last folder upload. String. 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. Relevant for all jobs in the SMART folder including jobs that complete ok. Jobs are not automatically removed, but wait for the folder to complete.

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.

PARENT_FOLDER

Defines the name of the parent folder to which the job's SMART Folder belongs. String. Mandatory.

JOBNAME

Name of the job processing definition. String. Optional.

FILENAME

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

APPLICATION

Name of the application to which the SMART Folder belongs. Used as a descriptive name for related groups of SMART Folders. String. Mandatory.

SUB_APPLICATION

Name of the group to which the jobs in the SMART Folder are assigned. String. Mandatory.

CREATED BY

Control‑M/EM user who defined the SMART Folder. String. Mandatory.

NOTE: This argument is used by the Control‑M 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.

RUN_AS

User (user ID) associated with the SMART Folder. This parameter is used by the Control-M/Server security mechanism. String. Optional.

CRITICAL

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

Valid values:

• 0 (No Default)
• 1 (Yes

SYSDB

Determines whether one or multiple data sets are used to catalog sysdata. Mandatory. Valid values:

• 0: Multiple
• 1: Single (default)

IND_CYCLIC

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

Valid Values:

• S: Start
• E: End

APPL_TYPE

Indicates the type of external application (such as SAP or Oracle) on which the external application job runs. Mandatory for external application jobs

USE_INSTREAM_JCL

Indicates whether the job should use the INSTREAM_JCL.

Valid values: Y or N

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

INTERVAL

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

CONFIRM

Indicates that the SMART Folder must be manually confirmed by the Control‑M/EM user before it runs. Valid values:

• 0 (No confirmation. Default.)
• 1 (Requires confirmation.)

PRIORITY

Indicates Control-M SMART Folder priority. String. Optional.

TIMEFROM

Indicates the earliest time for submitting the SMART Folder. String. Optional.

TIMETO

Indicates the latest time for submitting the SMART Folder. String. Optional.

DUE_OUT

Time that the jobs in the SMART Folder are expected to finish. String. Optional.

DOCMEM

Name of the file containing SMART Folder documentation. String. Optional.

DOCLIB

Name of the DOCMEM library. String. Optional.

DESCRIPTION

Brief text description of the SMART Folder. String. Optional.

CREATION_USER

Name of the user who created the SMART Folder. String. Optional.

CREATION_DATE

Date on which the SMART Folder was created. String. Optional.

CREATION_TIME

Time at which the SMART Folder was created. String. Optional.

CHANGE_USERID

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

CHANGE_DATE

Date on which the SMART Folder was last modified. String. Optional.

CHANGE_TIME

Time at which the SMART Folder was last modified. String. Optional.

MULTY_AGENT

If set to Y, job submission details are broadcast to all agents within an Application. The agent with available resources runs the jobs in the SMART Folder. Optional.

Valid values:

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

ACTIVE_FROM

(z/OS jobs and SMART Folders, only) Indicates the start of a period of time during which the job or SMART Folder can be ordered. Optional. Date Format: YYYYMMDD

ACTIVE_TILL

(z/OS jobs and SMART Folders, only) Indicates the end of a period of time during which the job or SMART Folder can be ordered. Optional. Date Format: YYYYMMDD

JOB

Opening and closing tags of a single job definition. Parameters of the job are listed between the tags. For a complete listing of deffolder parameters, see defjob.

SITE_STANDARD_NAME

Defines the name of the site standard that is applied to the folder and all of its entities. For more information see Site standards management

NOTE: Relevant for Control-M Workload Change Manager only.

BUSINESS_PARAMETER_NAME

Defines the name of the Business Parameter name that is applied to the folder and all of its entities. For more information, see Site standards management

NOTE: Relevant for Control-M Workload Change Manager only.

VALUE

Defines the value of a customer defined business field. String.

NOTE: Relevant for Control-M Workload Change Manager only.