ctmexdef

The ctmexdef utility exports job processing definitions from the Control-M/Server database to a flat (ASCII) file. This file can then be used as input for either the ctmcreate utility or the ctmdefine utility.

The ctmexdef utility can be used to:

• Modify existing job processing definitions in batch mode (together with the ctmdefine utility). The job processing definitions in the file exported by ctmexdef can be edited offline and then returned to the Control‑M/Server database by using ctmdefine. For more information, see ctmdefine.

• Creating specific purpose jobs to be inserted in the Active Jobs database based on previously defined jobs. Together with the ctmcreate utility, the ctmexdef utility can copy and modify job processing definitions in batch mode that can then be sent directly to the Active Jobs database by using ctmcreate. See ctmcreatefor a complete description of the utility.

When working on UNIX, the utf8 file stores the script. No translation is performed by the utility when being read into memory. In Windows, that store the script is native. Translation to utf8 needs to be performed by either the ctmcreate or ctmdefine when being read into memory.

The output of ctmexdef on Windows cannot be used as input on UNIX installations and the other way around.

For more information on ctmexdef syntax rules, see ctmexdef Syntax Rules.

Exporting Jobs Using the ctmexdef Utility

This procedure describes how to run the ctmexdef utility, which enables you to export job processing definitions from the Control-M/Server database to a flat (ASCII) file

Begin

1. Do one of the following:

   • UNIX: Log in to a Control-M/Server account

   • Windows: Open a command prompt window where Control-M/Server is installed.

2. Type the following command:

   ctmexdef

   -FOLDER <name>

   -JOBNAME|-FILE_NAME <name>

   [ -ACTION <DEFINE|CREATE> ]

   [ -FILE <filename> ]

   [ -WORKING_DIR <working directory> ]

ctmexdef Parameters

The following table lists debug, quiet, and input_file parameters for the ctmexdef utility. All other parameters, such as cyclic job parameters, are described in Control-M Parameters.

Parameter	Description
-ACTION	DEFINE: Exports the file to a ctmdefine format. CREATE: Exports the file to a ctmcreate format. Default: Define
-FILE	Defines the full path name of the file to contain the exported job specifications. If this parameter is not specified, the output is routed to the default output device.
-JOBNAME	Defines the name of the job.
-FILE_NAME	Defines the file name of the job.
-FOLDER	Defines the name of the SMART folder or of the job. Either the JOBNAME or FILE_NAME parameter is required.
-WORKING_DIR	Contains embedded script files. The name of each file consists of a SMART folder name, job name, and time stamp. The embedded script only appears for jobs that have the in-line script turned on.

ctmexdef Syntax Rules

The <name> and <file_name> parameters can include the following wildcard characters:

• Represents any number of characters, including none. Any parameter including * should be enclosed in quotation marks. See the example below.

• Represents any single character.

To export all job processing definitions from SMART folder PROD to file tabprod, specify the following command:

ctmexdef -FILE /tmp/tabprod -FOLDER PROD -JOBNAME "*"