Skip Navigation Links | |
Exit Print View | |
![]() |
Maintaining Oracle Java CAPS Master Indexes (Repository) Java CAPS Documentation |
Maintaining Oracle Java CAPS Master Indexes (Repository)
Defining Master Index Security (Repository)
To Create a Master Index User Account
Master Index User Roles (Repository)
Learning About Master Index Reports (Repository)
Master Index Command Line Reports (Repository)
Master Index Report Configuration (Repository)
Creating Custom Master Index Reports (Repository)
Masked Data in Master Index Reports (Repository)
Master Index Production Reports (Repository)
Master Index Activity Reports (Repository)
Master Index Database Indexes (Repository)
Working With Master Index Command Line Reports (Repository)
Configuring the Master Index Report Environment (Repository)
Configuring Master Index Command Line Reports (Repository)
Defining the Command Line Report Configuration
Configuring Command Line Reports
Master Index Command Line Report Properties (Repository)
Running Master Index Command Line Reports (Repository)
Maintaining the Master Index Database (Repository)
Backing up the Master Index Database
Restoring the Master Index Database
Implementing Changes to the Master Index Project (Repository)
Modifying Master Index Configuration Files (Repository)
Updating Normalization and Standardization Structures
Modifying Standard Master Index Project Components (Repository)
Modifying the Master Index Database (Repository)
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 Enterprise Data Manager, see Working With the EDM for Oracle Java CAPS Master Index.
Make sure the reports have been installed as described in Using the Oracle Java CAPS 6.3 Installation GUI. 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.
Before running the master index reports from a command line, you must configure the report environment. Configuring the environment consists of two steps: copying the generated project files and setting environment variables.
The reports rely on two files, stc_eindex_client.jar and stc_eindex_util.jar, that are generated in the master index project. You need to export these files to the reports directory. If the project is regenerated at any time, export the files to the reports directory again when the generate process is complete.
The Save dialog box appears.
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.
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.
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
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.
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.
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.
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.
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>
The following table lists and describes the elements in the report configuration files that define the configuration of each production and activity report.
|
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. |
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.
Before You Begin
Before running the reports for the first time, set up the environment variables as described in To Set up the Environment.
java com.stc.eindex.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.