The following rules apply when using this utility:
More than one parameter can be specified on a line.
The odate parameter specifies the date to use as the job’s scheduling date. Specify a date in yyyymmdd format, or specify ODAT to accept the Control‑M system date.
The %%NEXT, %%$NEXT, %%PREV, and %%$PREV variables cannot be specified for the ctmcreate utility. These variables refer to the next or previous scheduling date and are not relevant for a utility that places jobs directly in Active Jobs.
The length of the command line, after decoding, must not exceed 999 characters.
Although most parameters are optional, certain parameters are required depending on the value specified for ‑tasktype.
On computers that support Disk Clustering, the -hostgrp parameter is required (including either a host group name, or the virtual name of the Control‑M/Agent).
All parameter fields (as specified in the syntax) must contain values. If no value is required, specify a null string "" in the relevant position in the parameter specification.
EXAMPLE: The -domail parameter has the following syntax: -domail <destination> <cc> <severity> <subject> <message>
To specify this command without a value for the cc field, include a null string in the appropriate location.
For more information, see information about setting Control-M/Server e-mail configuration parameters in Email parameters.
JOB and DETACHED require file name and file path parameters.
COMMAND requires the cmdline parameter.
Strings containing blanks must be enclosed in quotation (for example, ‑cmdline "ctmudlst list payroll").
A UNIX metasymbol (that must be enclosed in quotation marks) appearing in a command line string should be enclosed in single quotation (for example, ‑cmdline "ctmcontb list ‘*’ ").
If a parameter value begins with a $ sign, the operating system will try to replace the value. For example, -jobname $USER will cause the shell to substitute the current user. If a parameter value should contain a $ sign, enclose the value in single quotation marks. For example, -jobname ‘test$’ will set the jobname parameter to test$.
A variable that does not contain a $ sign can be enclosed in single or double quotation marks. A variable that does contain a $ sign should be enclosed in single quotation marks. A variable containing a $ sign cannot be resolved if it is enclosed in double quotation marks.
Condition dates are specified in mmdd format. Time is specified in hhmm format.
A parameter requiring more than one entry can be repeated as many times as necessary (for example, if a job must wait for several prerequisite conditions, specify a separate ‑incond parameter for each prerequisite condition).
The following special characters are disabled when they occur in prerequisite condition names: ( ) | [blanks]
An ‑on parameter must be followed by at least one ‑do... parameter. ‑do... parameters are dependent upon the last ‑on parameter preceding them. Normally, when a -dorerun parameter is implemented, the current run of the job ends with NOTOK status. To ensure that the job will have OK status even though it is rerun, specify a -do ok parameter immediately after the -dorerun parameter.
The -dorerun parameter cannot be specified for a cyclic job.
The order of the parameters does not affect the outcome of the job, with the exception of ‑on and ‑do... parameters.
When using ‑doforcejob to force an entire folder, <job name> must be specified as a blank enclosed in quotation marks (that is, " ").
When the ctmcreate utility is invoked from a script, to use the **** option for a ‑incond date parameter, specify the parameter as \"****\"
If a single character is specified for the priority parameter, the first character is assumed to be A. For example, priority 1 is interpreted as priority A1.
A maximum of 99 prerequisite conditions can be specified for docond parameters.
EXAMPLE: -incond pk_oly_ok "****"
When the UNIX symbol ~ is used in parameter ‑filepath, -override path, or ‑doclib to represent the user’s home directory, the entire parameter should be enclosed in double quotation marks. The quotation marks ensure that the ~ symbol will be translated by the agent before submission, and not by the server before transmission to the agent computer.
