Maintaining Sun Master Indexes (Repository)

Master Index Command Line Report Properties (Repository)

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

Element/Attribute 

Description 

report

Defines each report run by the batch file. Each report is defined by a report element. 

report/name

The descriptive name of the report. This can be any string, and appears as the title in the specified report. 

report/template

The template to use for the type of report being generated. You should not need to modify this element, but you can specify any of the following templates. 

  • Assumed Match

  • Potential Duplicate

  • Deactivated

  • Merged

  • Unmerged

  • Update

  • Weekly Activity

  • Monthly Activity

  • Yearly Activity

enable

Specifies whether to run the report for the current run. Specify true to run the report; specify false to disable the report. This option allows you to run one report at a time.

output-file

The name of the file generated by the report client. This file is created in the output directory defined earlier in the file or in the output directory specified in the command line (the command line output directory overrides the configuration file output directory). 

max-result-size

The number of records to display on the report. If no value is entered, or if the value is zero (0), the size defaults to 1000 records. To retrieve all records for a report, enter a very large value for this element. 

page-size

The number of records returned to the report generator at one time for each report. 

criteria

Defines the date range for the report. 

dates/type

Indicates the type of date range to use for the report. Specify today to report on transactions with today’s date; specify yesterday to report on transactions with yesterday’s date; or specify range to enter a specific range of dates. If you specify range, you must enter the date range in the from-date and to-date attributes.


Note –

If you enter a type of today or yesterday and you enter a date range, only the type will be used. For the activity reports, entering today runs the report for the current week, month, or year. Entering yesterday only runs the previous week’s report if yesterday was a Saturday.


dates/from-date

The starting date when using a date range for the report. Enter the starting date for the report transactions in YYYYMMDD or YYYYMMDDHHmmss format. If you enter a date in this element, you must enter a later date in the to-date element and specify range in the type element.


Note –

For the activity reports, you can enter the range for the week, month, or year (depending on the type of activity report) on which you want to report. If the dates you specify do not fall within one calendar week, month, or year, the report client creates a report for the calendar week, month, or year containing the from-date and ignores the to-date value.


dates/to-date

The ending date when using a date range for the report. Enter the ending date for the report in YYYYMMDD or YYYYMMDDHHmmss format.

status

This element is valid for the potential duplicate report only, and indicates the status of the potential duplicate pairs to display on the report. Specify any of the following values: 

  • U - Only unresolved potential duplicates appear on the report.

  • A - Only potential duplicates that are permanently resolved (auto-resolved) appear on the report.

  • R - Only resolved potential duplicates appear on the report.

    Leaving the status blank results in potential duplicates of all statuses appearing on the report.

fields

A list of fields to display on the report in addition to those that are displayed automatically. This element should be empty for the activity reports. If a list of fields is supplied for these reports, it is ignored. 

field/path

The ePath to a field you want to include in the report. For more information about ePaths, see Master Index Field Notations in Understanding Sun Master Index Configuration Options (Repository).


Note –

You cannot use the asterisk option in the ePaths you specify here.


field/label

The column label for the specified field in the report. 

field/width

The width of the column for the specified field in the report. If a field value is larger than the width specified, that value will be truncated in the report.