The ctmdefine utility can be used when converting job scheduling information from other job control components to Control‑M/Server. The function performed by this utility is equivalent to the manual process of creating job processing definitions, as described in Job definition.
The ctmdefine utility can be invoked using the -input_file parameter:
-ctmdefine -input_file <fullPathFileName>
The referenced file contains all the required parameters. Most of the parameters are described in Control-M Parametersand ctmdefine parameters.
The ctmdefine utility can also be used to define jobs for specific applications, for example, SAP and Oracle Applications (OAP).
When creating new SMART Folders or job processing definitions using this utility, consider the following:
If the job name specified already exists in a job processing definition in the SMART Folder, the new job processing definition does not overwrite the existing one. Both job processing definitions appear in the folder, each with a different internal job number.
If the SMART Folder does not exist, the utility creates it.
After using this utility to create one or more job processing definitions, download the modified SMART Folders to the Control‑M/EM database.
A newly created SMART Folder can be assigned an Order Method parameter using Control‑M client after the folder is downloaded to the Control‑M/EM database or by using the ctmpsm utility.
Values for a creation/modification timestamp and the user ID of the user who created or modified the job processing definition are automatically added to the communication protocol between Control‑M/EM and Control-M/Server and are stored in the Control‑M/EM database. These values are initialized by the ctmdefine utility and are sent to Control‑M/EM when the SMART Folder is downloaded. When the SMART Folder is uploaded, Control‑M/EM sends these values to Control-M/Server.
When defining a job in a nested folder, a folder path to the intended nested folder must be specified (-FOLDER option). The folder path starts from the outermost folder name and is similar to operating system files and directories path. When a folder name is used and the folder does not exist, a folder is created.
If you define a new Rule-based calendar with the ! character at the beginning of the Rule-based calendar name, the Rule-based calendar is excluded. If this feature is disabled, an error message is displayed that you cannot define a Rule-based calendar with the ! character. For more information, see DefaultCTMExcludeRBC in General parameters.
