Maintaining Sun Master Indexes (Repository)

Configuring Master Index Command Line Reports (Repository)

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 eIndexPersonReport.xml is defined for a person object and a default XML file named eView 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.


Note –

The DOCTYPE element indicates the type of document being generated. Do not change this value.


ProcedureTo 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.

ProcedureTo 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>