-FOLDER

Either a folder name, SMART folder name (name of the SMART Folder containing the jobs) or the path (including the folder name) to the folder. This value might contain wild characters within the folder path. Wild characters in the outermost folder name are also valid.

UNIQUE

Adds a unique suffix to every conditional name.

• y Add a unique suffix to every condition name.
• n Do not add a unique suffix to every condition name. Default

-NAME

Job name (or mask) of the job(s) to order or force. Mandatory.

You can order a SMART Folder, but you cannot order an individual job, or selection of jobs, from a SMART Folder.

The job name can include the following wildcard characters:

• *: Represents any number of characters (or none). Specify * by itself to include all jobs in the folder.
• ?: Represents any single character.
• $: Represents any single character.

  NOTE: Any parameter that includes a wilcard character must be enclosed in double quotation. Whether the *, ?, and $ characters act as wildcards or as ordinary characters in a job name is determined by the presence or absence of a -seqno parameter:

The *, ?, and $ characters only acts as wildcards in the -jobname parameter if no -seqno parameter is specified.

The *, ?, and $ characters only acts as ordinary characters in the -jobname parameter if a -seqno parameter is specified. In this case, the specified job name must exactly match the name of the job in the indicated sequence, or the job will not be ordered.

-odate

Indicates the scheduling date (order date) to be associated with job(s). Valid values:

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 depends on the value specified for the -odate_option parameter (described below).

-force

Add the specified jobs to the Active Jobs database regardless of scheduling criteria. If -force is not specified, jobs are added to the Active Jobs database only if their scheduling criteria are satisfied (known as order). Use -INTO_FOLDER_ORDERID to force a job or Sub Folder into a folder or Sub Folder that has already been ordered.

y

Force the specified jobs.

n

Order the specified jobs. Default.

-hold

Place the specified jobs in the Active Jobs database in Hold status.

y

Hold the specified jobs.

n

The specified jobs are not held. Default.

-seqno

A counter identifying the row number of the job in the SMART Folder. The first job in each SMART Folder is numbered 1 and each subsequent job increments the counter by one. If this parameter is not specified, the first job in the specified folder is ordered. Optional.

NOTE: If this parameter is specified, any *, ?, and $ characters in the -jobname parameter are assumed to be ordinary characters rather than wildcards. Therefore:

Do not specify a -seqno parameter if you are specifying wildcards in the -jobname parameter.

If you are specifying *, ?, or $ characters as ordinary characters (not wildcards) in the -jobname, you must specify the appropriate -seqno parameter (and the specified job name must exactly match the actual job name).

-INTO_FOLDER_ORDERID

NOTE: This parameter is relevant only for jobs in a SMART Folder. If the folder being ordered is not a SMART Folder, this parameter is ignored.

SMART Folder order id

Order ID of an existing SMART Folder.

LAST

Jobs are added to the last ordered instance of their SMART Folder in the Active Jobs database.

ALONE

Jobs are ordered individually. They are not associated with any SMART Folder.

NEWF

A new folder is created and the specified jobs are ordered to that SMART Folder. Default.

NOTE: The SMART Folder order id, last, alone and newt options can only be used when the -force parameter is set to y.

-noduplication

Allow jobs to be ordered and added to an existing ordered SMART Folder only if those jobs have not already been ordered in that instance of the SMART Folder.

This parameter can be specified only if last or <SMART Folder order id> is specified for the -INTO_FOLDER_ORDERID parameter.

NOTE: This parameter is relevant only for jobs in a SMART Folder.

-debug level

Activates a debug trace at the specified level.
Valid levels: 0 – 5. Default: 0

Performance is somewhat slower when operating in debug mode. BMC recommends that you activate debug mode only when requested by Technical Support.

-quiet

Suppresses display of the utility output. If specified, no information messages are displayed during execution of the command.

-variable

Adds a variable expression to each job, SMART Folder, or SMART Folder that is ordered by the utility.

For more information, see Control-M Variable facility. The following information must be specified for each new variable.

<varName>

Name of the variable.

<expression>

Value assigned to the variable.

-odate_option

Indicates how the specified -odate value should be used.
Valid values, specify one of the following:

value_date

The specified odate is the odate value for the job(s). The jobs should be run during the current working day. Default.

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

run_date

Jobs ordered by this run of the ctmorder utility should be run only when the specified odate begins.

If the specified odate is the current working day, the job will run as described in value_date 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 ctmorder utility will not run and an error message will be displayed.

-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_run_as name>/ctm_server/data/ctmorder_parms.txt

  NOTE: If neither ORDER nor FORCE is included in the command, the specified jobs are ordered.