Skip to main content

Use a Report Object Variable to Create a Table of Contents

You can assign a variable to a report object in CDM so that it is listed in the table of contents (TOC) for a report.

Building a table of contents involves assigning TOC variables to report objects and then listing these variables, in either a table or by using paragraphs, in a Word object you add to the report.

To create a TOC using report object variables:

  1. Open the report that you want to work with.
  2. In report tree, determine the location where you want a table of contents to be placed.
  3. Create a Word object that will be used to contain the table of contents. For more information, see the CDM Administration Guide.
  4. Determine what report objects you want to include in the table of contents.
  5. For each report object that you want to include in the table of contents, check out the report object and enter a unique TOC variable in the ToC Variable field in the Property and Comments window. Use the correct syntax, for example, ##3page.
    1. Type ## to identify the start of your variable.
    2. Enter a unique number for this report object that represents the order that the report object is to be placed in the table of contents.
    3. Type page to identify the variable as part of the table of contents.
  6. In the table of contents Word object, complete one of the following tasks:
    • Create and format a three-column table. Add as many rows as there are report objects to which you have designated a TOC variable. In each row, enter the topic heading for the report object in the first column, leaders (.......) in the second column, and then the corresponding TOC variable that you assigned to that report object.
    • Enter the topic heading for the first report object, followed by leaders, and then the corresponding TOC variable you assigned to that report object. Start a new paragraph and enter the same information for the second report object you want in the table of contents. Continue to add a paragraph and information for each report object to which you have designated a TOC variable.
  7. Save your changes in the table of contents Word object.
  8. Save your changes to the report and check in the Word object.

When the report is generated, the correct page numbers are dynamically updated and appear in the table of contents for the report.

Was this article helpful?

We're sorry to hear that.