You are here: Configuration Analysis > Launching Configuration Analysis > Command Line Operation

Command Line Operation

A command line interface to the Configuration Analysis functionality is provided in the OEDQ tools directory. In addition to running configuration comparisons, the command line interface can also be used to import projects from package (.dxi) files or from other servers in order to perform comparisons locally.

This topic describes, in detail, how to:

Perform configuration analysis from the command line;
Import projects from package (.dxi) files;
Import projects from other servers;

In order to use the command line interface to Configuration Analysis, start by changing your command line working directory to the tools directory of your OEDQ installation.

Configuration Comparison

A script called diff.js is used to perform configuration comparisons from the command line. The results of the comparison will be written to a file which is specified by one of the parameters to the script. It is invoked as follows where the full command needs to be written on one line:

java -jar jshell.jar scripts/diff/diff.js
-server <SERVER:PORT> [-user <username> -pw <password>] -lproj <LHS project> [-lnode <LHS node> [-lname <LHS name>]] -rproj <RHS project> [-rnode <RHS node> [-rname <RHS name>]] [-dependencies] [-summary] -filename <filename> [-preserve]

Note: Arguments enclosed in square brackets are optional. Where nested set of square brackets are used, enclosed within the inner set are optional adjuncts to the optional argument enclosed by the outer set.

The parameters to diff.js are described below:

-server <SERVER:PORT>

The server containing the components to be analyzed. The port that should be supplied is the port specified by management.port.

-user <username>

The user name to use to access the server.

-pw <password>

The password to use to access the server.

-lproj <LHS project>

Name of the project to be used as the 'original' version in the comparison. This is equivalent to the project selected in selection pane A (see the selection panes topic for further details).

-lnode <LHS node>

Name of the node to use as the 'original' version in the comparison. This is equivalent to selecting a node in selection pane A (see the selection panes topic for further details), and should be either 'Processes' or 'Jobs'.

-lname <LHS name>

Name of the component to use as the 'original' version in the comparison. This is equivalent to the component selected in selection pane A (see the selection panes topic for further details)

-rproj <RHS project>

Name of the project to use as the 'updated' version in the comparison. This is equivalent to the project selected in selection pane B (see the selection panes topic for further details).

-rnode <RHS node>

Name of the node to use as the 'updated' version in the comparison. This is equivalent to selecting a node in selection pane B (see the selection panes topic for further details), and should be either 'Processes' or 'Jobs'.

-rname <RHS name>

Name of the component to use as the 'updated' version in the comparison. This is equivalent to the component selected in selection pane B (see the selection panes topic for further details).

-dependencies

If this flag is specified, it indicates that the dependencies of the specified objects will be included in the comparison. This is particularly useful when comparing jobs.

-summary

If this flag is specified, it indicates that the detailed reports should not be included in the output file.

-filename <filename>

The name for the output file. This filename is specified relative to the configuration analysis output directory.

Note: The configuration analysis output directory is controlled by the diff.output.dir property in the director.properties file. The configuration analysis output directory is specified relative to the config directory, and must be a subdirectory of it.

If no value is specified for diff.output.dir, or if an invalid value is specified for diff.output.dir, it will default to config/diff.

-preserve

If this flag is set and the output file already exists, an exception will be thrown. If this flag is not set then any existing output file with the same name will be overwritten.

Examples

Comparing two projects

The following command line can be used to compare two projects (one named 'My Project' with one named 'My Edited Project'). The projects are both located on the localhost server on the default port, and the username and password are both 'dnadmin'. The results will be written to a file named out.html in the default output directory:

java -jar jshell.jar scripts/diff/diff.js -server localhost:8090 -user dnadmin
-pw dnadmin -lproj "My Project" -rproj "My Edited Project" -filename out.html

Comparing two jobs and their dependencies

The following command line can be used to compare two jobs, (both named 'Overnight Job', one from 'My Project'and the other from 'My Edited Project'). The projects are both located on the localhost server on the default port, and the username and password are both 'dnadmin'. The results will be written to a file named out.html in the default output directory:

java -jar jshell.jar scripts/diff/diff.js -server localhost:8090 -user dnadmin -pw dnadmin -lproj "My Project" -lnode jobs -lname "Overnight Job" -rproj "My Edited Project" -rnode jobs -rname "Overnight Job" -filename out.html -dependencies

Importing Projects from Package Files

A script called transferfile.js is used to import projects from package files from the command line. It is invoked as follows:

java -jar jshell.jar scripts/transfer/transferfile.js -server <SERVER:PORT> [-user <username> -pw <password>] -filename <package file name> [-projectname <project name>] [-preserve]

The parameters to transferfile.js are described below:

-server <SERVER:PORT>	The server to import the project to. The port that should be supplied is the port specified by management.port.
-user <username>	The user name to use to access the server.
-pw <password>	The password to use to access the server.
-filename <filename>	The name of the package file to import from. The file name can be specified as an absolute or as a relative file name. If a relative file name is specified, it will be resolved against the config directory.
-projectname <project name>	The name of the project to import. If no value is specified for this parameter, all projects in the package file will be imported.
-preserve	If this flag is set and a project with same name as the project being imported already exists, an exception will be thrown. If this flag is not set then any existing project with the same name will be overwritten.

Importing Projects from Remote Servers

A script called transferserver.js is used to import projects from other servers from the command line. It is invoked as follows:

java -jar jshell.jar scripts/transfer/transferserver.js
-server <SERVER:PORT> [-user <username> -pw <password>] -rserver <SERVER:PORT> [-ruser <username> -rpw <password>] -projectname <project name> [-preserve]

The parameters to transferserver.js are described below:

-server <SERVER:PORT>	The server to import the project to. The port that should be supplied is the port specified by management.port.
-user <username>	The user name to use to access the server.
-pw <password>	The password to use to access the server.
-rserver <SERVER:PORT>	The remote server to import the project from. The port that should be supplied is the port specified by management.port.
-ruser <username>	The user name to use to access the server.
-rpw <password>	The password to use to access the server.
-projectname <project name>	The name of the project to import.
-preserve	If this flag is set and a project with same name as the project being imported already exists, an exception will be thrown. If this flag is not set then any existing project with the same name will be overwritten.