ctmimptb

The ctmimptb utility imports folders (including SMART folders and Rule-Based Calendars) containing job definitions that were exported from Control-M/EM by the exportdeffolder utility. To run the ctmimptb utility, see Importing folders using the ctmimptb utility.

The ctmimptb utility gets the exported XML file that was created by exportdeffolder in Control‑M/EM, and imports the folders into the Control-M/Server database. This utility can overwrite existing folders when overwrite mode is specified.

The ctmimptb utility works at the folder level only and cannot import a specific job or jobs from a folder. The utility can import Sub Folder entities and Sub Folders jobs, but cannot import Sub Folders individually. The Sub Folders must be imported as part of SMART folders.

The Control-M/EM exportdeffolder utility cannot define an empty folder. Therefore, the ctmimptb utility cannot perform an action that will cause folders to become empty. If you duplicate SMART folders in the XML input file, when overwrite mode is specified, the last SMART folder is considered and overwrite mode is not specified and the SMART folder does not exist in the database, the first defined SMART folder is considered.

When a job definition folder in the input XML file is large, importing this folder is performed by a few transactions. The number of jobs within each transaction is specified by the CTMIMPTB_ENT_IN_TRANS parameter that is defined in the

~controlm/ctm_server/data/config.dat file. If the CTMIMPTB_ENT_IN_TRANS parameter is not specified in the config.dat file. The value range is 5–10,000 jobs and the default value 1,000 jobs.

The following describes the results of the import procedure:

• In the event of a successful import, the utility exits with a success return value. If the utility was invoked without overwrite mode and the utility encounters rejected folders during the import process, an appropriate message is issued for the partial import.

• In the event of a failure, the utility exits with an error return value and a partial import might occur. If a commit was already made, an appropriate message is issued for the partial import.

The ctmimptb utility is run by using the Control-M/Server security authorization of the invoking user.

The permissions that are required to run the ctmimptb utility on Control-M/Server SMART folders are Read, Write, and Delete.

If permission is denied for a specific SMART folder, the ctmimptb utility ignores the folder, continues processing the input XML file, and (if no other errors are encountered) exits with a success return value.

BMC recommends that you avoid updating job definition folders while the ctmimptb utility is running.

Importing Folders Using the ctmimptb Utility

This procedure describes how to run the ctmimptb utility, which enables you to import folders (including SMART folders and Rule-Based Calendars) containing job definitions that were exported from Control-M/EM by the exportdeffolder utility.

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:

   ctmimptb

   -PATH <full path to the output XML file exported by exportdeffolder EM utility>

   [ -OVERWRITE ]

   [ -DEBUG <debug level 0-5 ]

   [ -MODULE <debug module 0-3 ]

   [ -H | -Help ]

3. For more details about the ctmimptb utility, see ctmimptb and ctmimptb parameters.

ctmimptb Parameters

The following table lists the ctmpimptb utility parameters:

-PATH	Indicates the full path to the file that holds the job definition folders to be imported. This file is in XML and is generated by the exportdeffolder utility in Control-M/EM.
-OVERWRITE	Determines how the utility responds when a folder that already exists in Control-M/Server is imported: When this parameter is specified, the current folder in the Control-M/Server database is replaced with the imported folder, and a message similar to the following message is issued: "Schedule folder already exists in the database and overwrite was specified. Overwriting this folder" When this parameter is not specified, the imported folder is rejected, leaving the current folder in the Control-M/Server database unchanged, and a message similar to the following message is issued: "Schedule folder already exists in the database and overwrite was not specified. Skip importing this folder." After either using the imported folder to replace the current folder in the Control-M/Server database or rejecting the imported folder, the ctmimptb utility continues processing the file.
-DEBUG	Activates a debug trace at the specified level. Valid values: 0-5 Default: 0 NOTE: Performance is slower when Control-M/Server is operating in debug mode. BMC recommends that you activate debug mode only when requested by Customer Support.
-MODULE	Indicates which components are to be traced for diagnostic purposes Valid values: 0: all components 1: common functionality flow (default) 2: event manager 3: database layer
-H | -Help	Displays the usage of the utility