exportdeffolder

The exportdeffolder utility exports folders from the Control-M/EM database to a text file.

When the exportdeffolder utility is invoked, a file of arguments that you have created is processed. This arguments file contains statements that specify an existing folder, SMART folders and Sub Folders. The specified folders are exported to an output file. For more information, see exportdeffolder Arguments File.

The exportdeffolder utility validates the XML rule file according to the validation process in Control-M/EM version 9.0.19 and above.

For an example of the two validation processes see emdef Validation Service Error Message Example.

Output files created with the exportdeffolder utility can be used as import files with the deffolder utility.

Exporting Folders Using the exportdeffolder Utility

This procedure describes how to export folder definitions in the Control-M/EM database to an output file for use as input to other utilities using the exportdeffolder utility.

Begin

1. Do one of the following:

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

   • Windows: Open a command prompt window where Control-M/EM is installed. You do not need to be in the Control-M/EM database directory.

     For Windows client installations, open a command prompt window and navigate to the <EM Instance Name>\bin directory.

2. Enter one of the following commands:

   • emdef exportdeffolder [-USERNAME <user> [-PASSWORD <password>] | -PASSWORD_FILE <password file>] -HOST <GUI Server Name> -ARG_FILE <args file name> -OUT_FILE <File Name> [-vv 2]

   • emdef exportdeffolder [-u <user> [-p <password>] | -pf <password file>] -s <GUI Server Name> -arg <args file name> -out <File name> [-vv 2]

For more details on the exportdeffolder parameters and options, see emdef General Parameters and emdef Switches.

exportdeffolder Arguments File

Arguments are used as a selection criteria to determine which folders to export. Arguments are written to the exportdeffolder argument file.

The arguments files that you create with the exportdeffolder utility are written in XML format and saved in a text file. The format in which this file must be written is described on the following pages.

When this file is invoked, folder definitions are exported from the Control-M/EM database. For instructions for creating arguments files, see XML File Rules.

The following rules apply to the exportdeffolder arguments file:

• More than one job can be specified in an exportdeffolder file.

• The arguments file is case-sensitive.

• All parameter values (such as strings or digits) must be enclosed in quotation marks

  JOBNAME="Job1"

• More than one PARAM parameter can be used in a TERM statement.

• The relationship between PARAM parameters in a TERM statement is AND. The relationship between TERM statements is OR.

The exportdeffolder arguments file is checked and processed. If there are any errors in the file, a message is displayed specifying the lines with errors.

The exported folder definitions are saved to an output file, the name and location of which is specified in the outFileName parameter.

exportdeffolder Arguments File Parameters

The following table lists the exportdeffolder arguments file parameters:

exportdeffolder Examples

Following are examples of arguments files used with the exportdeffolder utility:

Export All Folders in the Data1 Data Center

<TERMS>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"VALUE="Data1"/>
</TERM>
</TERMS>

Export with Multiple Selection Criteria

Exported SMART folders that are located in data center Data1 and belong to the GRP_03 SMART folder, or located in data center Data1 and belong to the GRP_04 SMART folder:

<TERMS>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"VALUE="Data1"/>
<PARAM NAME="GROUP" OP="EQ" VALUE="GRP_03"/>
</TERM>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"VALUE="Data1"/>
<PARAM NAME="GROUP" OP="EQ" VALUE="GRP_04"/>
</TERM>
</TERMS>