Running the Dictionary Usage Report

In Release 8, Eclipse standardized the naming conventions for dictionary items. We changed the internal programs to use the new names and then archived the old names. The archived names still work in programs, such as user-defined reports, files, forms, and order entry views created prior to Release 8, but we recommend that you update your reports and views to use the new dictionary items and then delete the old dictionary items.

Run the Dictionary Usage Report to identify the dictionary items your system uses and where they are being used. You can run the report for a single file, multiple files, or all files. The program can check D-types, i-descriptors, or both types of dictionary items. You can report on used, unused, or all dictionary items. The report can include active, archived, or all dictionary items.

In addition to creating a report, you can use this program to purge unused user-defined dictionary items from your system. We recommend that you create a report of the dictionary items not being used and review it before running the program with the purge option selected.

To run the Dictionary Usage Report:

  1. From the Maintenance > Eclipse Dictionary menu, select Dictionary Usage Report to display the Dictionary Usage Report screen.

Note: If prompted, log on to the character-based system.

  1. Enter selection criteria in the following fields, as needed:

Field

Description

File

The files for which to run the report.

  • To run the report for one file, enter the filename in this field.

  • To run the report for multiple files, use the Multi hot key and enter each filename.

  • To run the report for all files, leave this field blank.

Dictionary Type

The type of dictionary items to include in the report. Select from the following options:

  • Dictionary - Selects only D-type dictionary items.

  • I-Descriptor - Selects only i-descriptor dictionary items.

  • All - Selects D-type and i-descriptor dictionary items.

Dictionary Usage Prompt

Whether to report on used or unused dictionary items. Select from the following options:

  • Used - Selects only dictionary items being used by Eclipse reports and programs.

  • Unused - Selects only dictionary items not being used by any Eclipse reports and programs.

  • All - Selects used and unused dictionary items.

Dictionary Activity

Whether to report on active or archived dictionary items. Select from the following options:

  • Active - Selects only active dictionary items.

  • Archived - Selects only archived dictionary items.

  • All - Selects active and archived dictionary items.

Note: On the Dictionary Maintenance screen, an asterisk in the Archived field indicates that the dictionary item is archived.

Purge Unused Archived

Whether the system should purge unused archived dictionary items as it compiles the report.

  • Y - The system purges unused archived dictionary items.

Note: To enter a Y in this field, you must set the Dictionary Usage Prompt and Dictionary Activity fields to include unused and archived dictionary items. The system will not purge special-purpose dictionary items that start with @, & or $.

  • N - The system does not purge any dictionary items.

  1. Use the Print, Hold, or Opts hot keys, as needed, to run the report.

The report displays the following information for each dictionary item occurrence:

Column

Description

File

The file for which the dictionary item is defined.

Dictionary Item

The dictionary item ID.

Type

The dictionary item type.

  • A - Data descriptor.

  • D - Data descriptor.

  • I -  Interpretive descriptor

Archived

Indication whether the dictionary item is archived.

  • YES - Archived.

  • NO - Not archived.

Where Used

The program that uses the dictionary item.

  • Report Writer

  • File Definition Maintenance

  • User Defined Forms

  • Customer Uploads

  • File Sorts

  • OE Views

Description

The dictionary item description.

Last Run

For Report Writer reports, the time and date when the report was last run.

See Also:

Running the Release 8 Dictionary Update

Eclipse Dictionary Overview

Tasks Not Available in Solar