Working With Master Index Command Line Reports

The following topics provide information and instructions for configuring and running reports from a command line using a Java command. For information about running the reports from the Master Index Data Manager, see Master Index Data Manager User’s Guide.

• Configuring the Master Index Report Environment

• Configuring Master Index Command Line Reports

• Running Master Index Command Line Reports

The reports are automatically generated at NetBeans_Projects/Project_Name/report-client. You must also have the Java 2 Platform, Standard Edition v. 1.5.13 or later installed on the machine from which the reports are run. Be sure you have configured the database connection for the master index application using the GlassFish Admin Console.

Configuring the Master Index Report Environment

Before running the master index reports from a command line, you must configure the report environment.

To Set up the Environment

1. If you install or move the reports files to a machine other than the application server machine, make sure JRE 1.5.13 or later is installed on the machine where the files reside.
2. Set up all Java environment variables as specified in the Java documentation.
3. Create one environment variable, JAVA_HOME, and set it to the home directory of the JRE installation.
4. If you run the reports using the Java command and not the supplied batch file, modify the CLASSPATH variable before running the reports for the first time by adding the absolute path and filename of the files in the lib subdirectory of the reports home directory to the CLASSPATH variable.

Configuring Master Index Command Line Reports

Before running any reports from the command line, you must customize the XML configuration file. You can use either of the files located in the reports directory in the eView or eIndex subdirectory. A default XML file named PersonReport.xml is defined for a person object and a default XML file named CompanyReport.xml is defined for a company object. You can use either of these as a basis for your production configuration file. Report configuration includes two steps: defining the overall report configuration and configuring the individual reports.

Defining the Command Line Report Configuration

The first section of the report configuration file is indicated by the DOCTYPE and the report elements and tells the report client how to connect to the application server, which application to run the reports against, and where to output the report files.

To Define the Command Line Report Configuration

1. In the SYSTEM element, enter the location of the DTD file for the reports.

   By default, this file is named report.dtd, and is located in the config directory. You should not need to modify this attribute unless you move report.dtd

2. In the appserver element, enter the IIOP address for the application server.

   This must be in the format corbaname:iiop:host:port, where host is the name of the server and port is the ORB port number.

3. In the application element, enter the name of the primary object used by the master index application.
4. In the output-folder element, enter the location in which the generated reports will be placed.

   If an output directory is specified in the command line, that directory overrides the one specified here. If the output directory already exists, the report client issues a warning that any existing report files will be overwritten and gives you the option of cancelling the reports.

Configuring Command Line Reports

A configuration section is defined for each of the six report templates. Use these sections to configure each report to display information as you want to view it. You can also specify which reports to run.

To Configure Command Line Reports

For each report, make the following modifications before running the reports. Each element or attribute mentioned in the following instructions is defined in . There are six stanzas for you to modify, one for each report.

1. In the XML file you will use for your implementation, scroll to the report element.
2. Name the report in the report name attribute.
3. Specify whether or not to run the report in the enable element.
4. Define the name of the output file in the output-file element.
5. Specify a time period for the report by modifying the type element and, optionally, the from-date and to-date elements.
6. Define the fields to include on the report by modifying the elements in the fields element.
7. When you have finished configuring each report, save and close the file.

   A sample report configuration appears below.

   <report name="Potential Duplicate Today"
    template="Potential Duplicate">
     <enable>true</enable>
     <output-file>pot_dup_t.txt</output-file>
     <max-result-size>0</max-result-size>
     <page-size>100</page-size>
     <criteria>
       <dates type="today" from-date="" to-date=""/>
       <status></status>
     </criteria>
     <fields>
       <field path="Person.FirstName" label="First Name" width="10"/>
       <field path="Person.LastName" label="Last Name" width="10"/>
       <field path="Person.SSN" label="SSN" width="9"/>
       <field path="Person.DOB" label="DOB" width="10"/>
       <field path="Person.Address.AddressLine1"
         label="AddressLine1" width="30"/>
       <field path="Person.Address.AddressLine2"
         label="AddressLine2" width="30"/>
      </fields>
   </report>

Master Index Command Line Report Properties

The following table lists and describes the elements in the report configuration files that define the configuration of each production and activity report.

Running Master Index Command Line Reports

Once you have configured the reports, you can run them by either running the batch file provided with the reports or using the Java command.

---

Caution - The application server must be running with the master index project deployed and enabled in order to generate command line reports.

---

To Run the Reports Using the Batch File

1. From a command prompt, navigate to the location of the report files.
2. Type the following all on one line:

   ReportClient.bat -f config_file- d output_directory

   where config_file is the name of the report configuration file to use, and output_directory is the location to which the reports will be written. This value overwrites the value specified in the configuration file. If this option is not specified, the configuration file value is used.

   ---

   Note - The ReportClient.bat file must reside in the reports home directory at the same level as the lib and config subdirectories in order for the environment variables to be set up correctly.

   ---

3. To view the reports, navigate to the location you specified as your output path and open the files in any text editor.

To Run the Reports Using a Java Command

Before You Begin

Before running the reports for the first time, set up the environment variables as described in To Set up the Environment.

1. At the command prompt, type the following all on one line:

   java com.sun.mdm.index.report.ReportClient- f config_file- d output_directory

   where config_file is the name of the report configuration file to use and output_directory is the location to which the reports will be written. This value overwrites the value specified in the configuration file. If this option is not specified, the configuration file value is used.

   ---

   Note - An additional option, -h, can be used to obtain help information for the report client.

   ---

2. To view the reports, navigate to the location you specified as your output path and open the files in any text editor.