Report Index
Description
A custom index can be created for a report, listing key terms and page numbers for the report. The index is also 'live', meaning the user can click on an entry to navigate to the corresponding page in the report.
Discussion
The index appears after the report body and lists the page number for each entry. Entries are fully customizable as is the appearance of the index.
The Define Index menu option under the Report menu is used to add an index to a report.
In the index builder, you will see several report sections listed that can be included in the index. Each report section can have an Index entry expression that defines the entry in the index.
- Report Section
- Description
- Grand
The "Grand" section is the page header and footer.
- Detail
The "Detail" section refers to each detail entry, which is typically repeated for each report record.
- Group Break
If the report contains one or more group breaks, an entry for each break will be listed. For example, if a report contains group breaks for each invoice number, then an index entry can be defined for the invoice number.
For each Report Section, you can define the following properties:
- Property
- Description
- Index entry expression
An expression that generates the text shown in the index.
- Target object
Object in the report that receives focus when the user clicks on the entry in the index.
Every time a record in a report section is printed, the Index entry expression is evaluated and a new entry is inserted into the index. The text shown in the index is the result of the expression.
When an entry in the index is clicked, the corresponding page where the object is located is shown and the focus is given to the defined Target object.
Customizing the Index Appearance
The layout of the index can be customized by creating a special type of report called an Index Report. The custom Index Report is built using the report builder. Any formatting or styling tools available in the report builder can be used to customize the appearance of the index.
To create a customized index, click the Add new custom 'Index' Report link at the bottom of the Define Index for Report dialog. When prompted, specify a name for the new Index Report and click OK. Alpha Anywhere will open the report builder, which can be used to customize the index. When you are satisfied with your changes, save and close the report.
After the custom index has been created, it can be added to the report. Open the Define Index dialog. In the Custom 'Index' Report dropdown, choose the index report you created then click OK to save your changes.
Where to Store a Custom Index Report
When you create an Index Report, you can store it in one of two locations:
- Location
- Description
- Global Dictionary
The Index Report will be saved in the global report dictionary.
- Local Dictionary
The Index Report will be saved in a local report dictionary (required for web applications)
If the Index Report is stored in the global dictionary, it can be used in other reports that you have created.
If stored in a local dictionary, the index can only be referenced by the report used to create it.
If a report will be used in a web application, the Index Report must be stored in a local dictionary. Desktop applications support storing Index Reports in both local and global dictionaries.
Videos
Reports - Table of Contents, Bookmarks and Index
A Table of Contents, Bookmarks, or Index can be added to a report using the report builder. You can completely customize the entries that are made in the Table of Contents, Bookmark section, and Index. In addition, you can completely customize the layout of the Table of Contents section and Index section.
The entries that appear in the Table of Contents, Bookmark section, and Index are "live" - if you click on an entry, you will be navigated to the appropriate page in the report. In addition, when you print the report to a PDF file, the Table of Contents, Bookmarks, and Index are live.
Limitations
Freeform and Layout Table Reports Only