(v24) Add a Table of Contents

Add a Table of Contents

This applies to: Managed Dashboards, Managed Reports

Add a table of contents to reports. Reports are automatically populated with entries you select when the report is viewed. Each entry includes a corresponding page number for the content.

Show a Table of Contents

Open the Properties window with nothing selected in your report to access the overall report property settings (to de-select an item, click on empty space outside of any template areas).

Select the option Show Table of Contents, and the new template area labeled TOC appears below the report header.

Use this new template area to customize the appearance of the area at the top of the table of contents. It initially contains a label as a title you can customize, add to, or remove.

After enabling the table of contents, new properties are added in the overall report properties: in the Look, Layout, and Text tabs, the Table of Contents category contains properties Background, Indent Size, and font settings for text.

Add Entries

Set up table of contents entries in the properties for any template area other than page headers & footers. When you add the table of contents, you can optionally include them only in exported PDF files for use with PDF viewer navigation options.

Select an empty area inside of a template area/region, or the labeled area to its left (e.g., where body is labeled B). You can also select any element inside, then click Select Template Cell in the toolbar.

In the Properties window, select Show in Table of Contents. A Text tab appears above that contains a set of properties you can adjust to determine the table of contents entry text:

• Set the Text property to identify this template area in the table contents. If this template area repeats based on data when viewing the report, a popup will open when you select this setting and list the available data that you can select to insert as a placeholder keyword, such as [Product] to list actual product values in the table of contents.

• The Text Source property dropdown determines which placeholder keywords are available for the Text property. If you're using a visualization that displays its own data separately from the group metric set, you can use this dropdown to select the visualization data instead.

• Select the Show Numbering option if you want to number each entry. This inserts the [TableOfContents] placeholder keyword for the numbering at the beginning of the template area. Combine with other text or keywords to display for each entry.

Set up the text in this way for every template area you want listed in the table of contents.

Numbering

If you selected the numbering option for a template area, numbering is added to the table of contents, but you still need to add corresponding numbers to the content.

To do so, use the [TableOfContents] placeholder keyword in labels or data labels in your report:

• Drag Table of Contents from the Labels window onto your report to quickly create a new placeholder label with this numbering.

• For an existing label or data label in your report: open the Properties window to the Text tab, and insert [TableOfContents] into the Label Text property setting. This is similar to the Text property for a template area you set above. It may be listed in a popup you select, or you can type or paste it.

View the Table of Contents

Select View in the toolbar to switch the report to view mode and see the table of contents entries. If the Report Header contains any content such as a report title, the table of contents will be on the following page (usually the second page).

The following image shows a table of contents listing the template areas for product categories as well as product subcategories (a nested/child group), with numbering enabled.

Important: If you want a report to immediately load fully with a complete table of contents, export the report to PDF or another format.

When you view a report directly in a browser, only the first few pages are loaded initially in order to reduce waiting time, with additional pages loaded as you scroll. If your report includes page headers or footers with [TotalPages] contained in a label, this is indicated with a plus symbol (+). For example: Page 1 of 4+.

In this case, the table of contents will also end with a message stating that it is incomplete. Once you have scrolled toward the end of the report, the page numbering will indicate the final page total and the table of contents will be complete if you scroll to it.

Select a table of contents entry to scroll directly to the corresponding page.

Export

Export a report to PDF or another format to prepare a report in its entirety all at once, including the final page total and a complete table of contents.

Select a table of contents entry to scroll directly to the corresponding page.

Many PDF viewers also have a sidebar that you can open for accessing the table of contents. Use it to navigate between report sections from any page.

For more information, see:

• Symphony Managed Reports

• Managed Report Layout Regions

• Design Overview

• Design Tips for Reports and Scorecards

• Share and Export Symphony Dashboards and Reports

• Report Layout Example