-APPLICATION

Provides a logical name for sorting groups of jobs. This parameter is used to supply a common descriptive name to a set of related groups of jobs.

-CREATED_BY

Control‑M/EM user who defined the job. String up to 64 characters. 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.

-END_FOLDER

Enables you to mark all folder and jobs as ended when one of its jobs marked as End Folder ended.

Valid values:

• Y: Yes
• N: No

-CYCLIC

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

Valid values:

• Y – Yes
• N – No (Default)

-CYCLIC_TYPE

Determines the type of cyclic job:

• Interval
• Interval Sequence
• Specific Times

-INTERVAL SEQUENCE

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

• Minutes: 0-64,800
• Hours: 0-1080
• Days: 0-45

-SPECIFIC_TIMES

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

-ODATE

Indicates the scheduling date (odate) to be associated with job(s).

Valid values are:

ODAT

The current working date of the computer on which Control‑M/Server is running.

This is the default value.

yyyymmdd

A specific working day in yyyymmdd format.

NOTE: The interpretation of this parameter value is dependent on the value specified for the -odate_option parameter (described below).

-ODATE_OPTION

Indicates how the specified -odate value should be used.

Valid values are:

value_date

The specified odate is the odate value for the job. However, the job should be run during the current working day.

This is the default value for the ‑odate_option parameter.

NOTE: If a time zone is specified in the job processing definition, then the job is run according to those time zones.

run_date

The jobs that are ordered by this run of the ctmcreate utility should be run only when the specified odate begins.

If the specified odate is the current working day, this job will work in the same way as value_date (described above).

If the specified odate has not begun (for example, due to time zone specifications), then the job will wait in the Active Jobs database (with WAIT_ODAT status) until the start of the specified working day.

NOTE: If the specified odate has already passed, the ctmcreate utility will not run, and an error message will be displayed.

-FOLDER_ORD

Specifies in which order of a SMART Folder to put the job. Valid values are:

<order-no>

A specific order number of the SMART Folder.

If the specified order number does not exist the command is not executed and an error message is displayed.

ALONE

The job is on its own (not in any folder).

LAST

The last order of the specified SMART Folder.

NOTE: When an order ID or LAST is specified for this parameter, the -folder parameter is mandatory and must contain the name of a SMART Folder that is currently in the Active Jobs database.

If more than one folder already exists while creating a Sub Folder in the Active Jobs database and the -FOLDER_ORD option is not specified, the folder with highest order number is chosen.

-EMBEDDED_SCRIPT

The Embedded script parameter contains the name of the file and path, which enables the embedded script to be copied from a file.

-DEBUG

Level of debug messages, 0 to 5.

Default: 0 (no debug messages).

-QUIET

Indicates, if specified, that no informational messages are displayed during the execution of the command.

-INPUT_FILE

Name and full path of a file containing parameters for the utility. In this file, each parameter and its values (if any) are on a separate line with the same syntax they would have on the command line. Using the -input_file parameter enables you to:

• Prepare and save files of utility parameters that can be reused.
• Specify utility input longer than the number of characters allowed in the command line.

  -input_file <controlm_owner>/ctm_server/data/ctmcreate_parms.txt

DOMAIL

Sends mail when the job run is complete. Optional.

DOMAIL urgency="R" destination="emuser@emuser.com" cc="barry@emuser.com" subject="OK" message="Task completed OK."

destination

Recipient of the message. String. Mandatory.

cc

Additional recipient of the message. String. Optional.

urgency

Urgency of the message.
Valid values:

• R (regular - Default)
• U (urgent)
• V (very urgent)

subject

Brief text description of the message contents. String. Optional.

message

Text of the message. String. Mandatory.

attach output

Specifies at the job level whether the OUTPUT should be sent as an email attachment.

Valid values:

• Y – Yes
• N – No
• D – default (this means take the value from the Control-M/Server configuration file)

TOLERANCE

Maximum delay in minutes permitted for a late submission when selecting a specific time (for example 5 minutes).
Valid range: 0-9991

CAPTURE

Defines the job capture definitions. This parameter can be used to search the output of a job for specified text and based on the capture parameters, extract words or characters from the output. The destination of the capture is a variable that can be set to any of the following types:

• local
• global
• named pool
• smart folder

into

Defines the target variable of the CAPTURE action. Use one of the following variable types to enter the variable name:

• %%varname - local variable
• %%\varname - global variable
• %%\\poolname\varname - named pool
• %%\\varname - smart folder

Maximum characters in variable name allowed: 38

Maximum characters in pool name allowed: 40

Default: No default, a value must be specified

search

Defines the string in the output file to begin the capture process.

Maximum characters in string allowed: 64

Default: No default, string must be specified

skiprows

Defines the number of lines to skip from the search string in the output file.

Maximum skip rows allowed: 99999999

Default: 0

skipwords/skipchars

Defines the number of words or characters to skip from the search string in the output file. Select skipwords or skipchars.

Maximum skipwords/skipchars allowed: 99999999

Default: 0

delimiter

(Only relevant for skipwords) Defines the character type that marks the beginning/end of the string.

Values:

• white space
• space
• tab

Default: white space

take

Defines the string to capture.

Values:

• <number of characters>/<number of words>
• 0 - indicates until end of line

Maximum take words/characters: 4000

Default: (skipchars) 0

Default: (skipwords) 1