exportdefjob
This utility has been deprecated. It is no longer enhanced and support will be discontinued in version 9.0.22. For more information, see emdef Utility Suite Deprecation.
The exportdefjob utility exports job processing definitions from a folder in the Control-M/EM database to an output file. To export jobs using the utility, see Exporting a Job from a Folder Using the exportdefjob Utility.
When exportdefjob is invoked, it processes a specified file of arguments in XML format. This file contains statements that identify existing job processing definitions. The identified definitions are exported from the Control-M/EM database to an output file. You can modify the exported job processing definitions in the output file and can import the modified definitions into the Control-M/EM database using either the defjob or updatedef utility. For more information, see exportdefjob Arguments File Rules.
For an example of the two validation processes see emdef Validation Service Error Message Example.
Exporting a Job from a Folder Using the exportdefjob Utility
This procedure describes how to export job processing definitions from a folder in the Control-M/EM database to an output file using the exportdefjob utility.
Begin
-
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
-
-
Enter one of the following commands:
-
emdef exportdefjob [-USERNAME <user> [-PASSWORD <password>] | -PASSWORD_FILE <password file>] -HOST <GUI Server Name> -ARG_FILE <args file name> -OUT_FILE <file name> [-vv 2]
-
emdef exportdefjob [-u <user> [-p <password>] | -pf <password file>] -s <GUI Server Name> -arg <arg file name> -out <file name> [-vv 2]
For Windows, you do not need to use the emdef prefix.
-
-
For details about the exportdefjob parameters and switches, see emdef General Parameters and emdef Switches.
exportdefjob Arguments File Rules
The following rules apply to the exportdefjob argument file:
-
More than one job can be specified in an exportdefjob file.
-
The arguments file is case-sensitive.
-
All parameter values must be enclosed in quotation marks (for example, 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.
For instructions about preparing this file, see XML File Rules.
The exportdefjob arguments file is checked and processed. If there are any errors, a message is displayed specifying the lines with the errors. The exported job processing definitions are saved to the output file whose name and location is specified in the -out <file name> parameter.
exportdefjob Arguments File Parameters
The following table describes exportdefjob arguments file parameters:
The first two lines of the arguments file specify the XML version, the text encoding format being used, and the location of the .dtd file.
Parameter |
Description |
---|---|
TERMS |
Indicates the start and end of the TERMS file. Only criteria that are located between the tags are considered to be part of the argument. |
TERM |
Indicate the start and the end of a group of selection criteria used to specify a job or jobs that are to be exported. Only PARAM tags that are located between the TERM tags are considered to be part of the TERM argument. |
REL |
Defines the relationship between terms. Valid values:
|
PARAM |
Determines the job definitions that are to be exported. More than one PARAM can be specified. PARAM NAME="DATACENTER" OP="E" VALUE="Center1" |
NAME |
Defines the parameter name of any job processing definition parameter. At least one of the following SMART folder parameters must be included in the arguments file: DATACENTER, OLDER_NAME, FOLDER_DSN |
OP |
Defines the relationship between the NAME and VALUE parameters of the TERM. Valid values:
|
VALUE |
Determines the value of the parameter specified in the NAME field. |
CYCLIC_TYPE |
Determines the type of cyclic job:
|
CYCLIC_TOLERANCE |
Determines the maximum delay in minutes permitted for a late submission when selecting a specific time. |
CYCLIC_INTERVAL_SEQUENCE |
Defines a list of time intervals, separated by commas, of up to 4000 characters. +30M,+2H,+1D |
CYCLIC_TIMES_SEQUENCE |
Defines a list of time intervals represented by hour of the day, separated by commas, of up to 4000 characters. 0800,1330,2300 |
Export Job Definitions Based on One or More Criteria XML File Example
In the exportdefjob XML file, export job processing definitions that either have data center name Data1 and a jobname that begins with the letter J, or have jobname Job5 and are not cyclic jobs.
<TERMS>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"VALUE="Data1"/>
<PARAM NAME="JOBNAME" OP="LIKE" VALUE="J*"/>
</TERM>
<TERM>
<PARAM NAME="JOBNAME" OP="EQ" VALUE="Job5"/>
<PARAM NAME="CYCLIC" OP="EQ" VALUE="0"/>
</TERM>
</TERMS>
Export Based on Multiple Criteria XML File Example
In the exportdefjob XML file, export all job processing definitions from either the Data1 or Data2 data center that have a JobName that does not begin with the letter R.
<TERMS>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"VALUE="Data1"/>
<PARAM NAME="JOBNAME" OP="NEQ" VALUE="R*"/>
</TERM>
<TERM>
<PARAM NAME="DATACENTER" OP="EQ"VALUE="Data2"/>
<PARAM NAME="JOBNAME" OP="NEQ" VALUE="R*"/>
</TERM>
</TERM>
</TERMS>