Configure Report Navigation

To allow a user to navigate the components of a report with the click of a button, you must create a document map. A document map consists of a series of bookmarked report components, typically headings, that are organized in a hierarchical format. This map of the document allows users to see the organization of a report and quickly navigate to a particular component. These document maps are particularly helpful for navigating long and complex reports. The document map can be accessed through the bookmarks feature in any program used to view PDF documents. Optionally, you can also make your document map visible in a Table of Contents Control .

The following tutorial makes use of the navigation properties available in the Label Control, however navigation properties are included in a number of controls. For more information on the navigation properties available with each control, see the Control Reference.

Step 1: Create the report

1. In VertiGIS Studio Report Designer, click File and then New.
2. Double-click the Layer Report option.
3. In the Layer Report Wizard dialog, select Use a new ArcGIS layer or table and then click Next.
4. Enter a name for the data source, such as World Time Zones.
5. For the URL, enter https://sampleserver5.arcgisonline.com/arcgis/rest/services/WorldTimeZones/MapServer, and then click Next.
6. Select the World Cities layer and then click Finish.

Step 2: Set the report to run on 100 features

To create a report that requires navigation, we must run the preview on many features. As it is unreasonable to manually enter 100 OBJECTIDs into the report parameter, we will modify the query to automatically query the first 100 features.

1. Open the Field List .
2. Expand the data source and then select the query.
3. Click Edit query .
4. In the Data Source Wizard, click Run Query Builder...
5. In the top right corner of the Query Builder dialog, expand Query Properties.
6. Delete the contents of the Filter property.
7. Set the Select Top property to 100.
8. Click OK and then Finish.
9. Open the Field List and expand Parameters.
10. Delete the FeatureIds parameter.
11. Click the Preview button to test your configuration.

Step 3: Configure Group Header bands with data

1. Add three group header bands to the report.

2. Select the table that contains the table headers.

   You can select the whole table by opening the Report Items List and selecting the table from the list of items.

3. Drag the table into GroupHeader1.

4. Configure GroupHeader2 with a Label control populated by the POP_CLASS field.

1. Open the Field List .
2. Expand the data source and the query.

3. Drag the POP_CLASS field into GroupHeader2.

   A Label control appears, configured with the POP_CLASS field.

4. Open the Properties panel and then expand the Layout property group.
5. Set Height to 50 and Width to 250.
6. Expand the Appearance property group.
7. Expand the Font property group and then set Size to 15.
8. Select the Italics option.
9. Set Text Alignment to Middle Left.

5. Configure GroupHeader3 with a Label control populated by the CNTRY_NAME field.

1. Open the Field List and drag CNTRY_NAME into GroupHeader3.
2. In the Properties panel, set the Height to 50 and Width to 250.
3. Set the Font Size to 20.
4. Set the Text Alignment to Middle Left.



Your report should look similar to the image

6. Click the Preview button.

   The group headers display once at the beginning of the report. To further organize the data, each header must appear once for each group of data.

Step 4: Configure the Group Header bands to group data

1. Select GroupHeader2.
2. In the Properties panel, expand the Actions property group.
3. Add a field to the Group Fields property.
4. Set Group By to POP_CLASS.
5. Select GroupHeader3.
6. Add a field to the Group Fields property.
7. Set Group By to CNTRY_NAME.
8. Click the Preview button.

   The group headers now appear once for every group of data. However, there are still no bookmarks to help navigate this large report.

   

   Your report should look similar to the example

Step 5: Configure the Group Header Navigation properties

1. In GroupHeader2, select the POP_CLASS label.
2. Open the Expressions panel.
3. In the Bookmark property, click ...
4. In the Expression Editor dialog, select the Fields heading from the column in the bottom left of the dialog.
5. In the bottom right column, double-click POP_CLASS.

   [POP_CLASS] is added to the expression.

6. Click OK.
7. In GroupHeader3, select the CNTRY_NAME label.
8. In the Bookmark property, click ...
9. Enter [CNTRY_NAME] into the expression and click OK.
10. Click the Preview button.
11. In your PDF viewer, open the bookmarks feature.

    The header of the document map reads Report. When expanded, all headers from the report appear in one long list, with no hierarchy imposed.

Step 6: Configure the document map hierarchy

1. Select the POP_CLASS label control.
2. Open the Properties Panel.
3. Under the Navigation heading, open the Parent Bookmark drop-down list.
4. Expand GroupHeader3 and then select the label control.
5. In the Report Items List, select Report.
6. In the Bookmark property, enter Table of Contents.
7. Click the Preview button.
8. Open the bookmarks feature.

   The document map appears with Table of Contents as the heading, and all sub-headings are organized in a hierarchical format.

   

Your document map should look similar to the example

Optional: Add a Table of Contents control

Configuring the bookmark navigation of a report lays the groundwork configuration for having a Table of Contents Control in your report.

1. Enlarge the ReportHeader1 band.
2. Drag the Table of Contents control into the ReportHeader1 band.
3. Open the Properties panel and expand the Behavior property group.
4. Expand the Level Title property group.
5. Set the Text property to Table of Contents.
6. Run the Preview.

By default, the table of contents starts on a new page. Each item in the table is linked to the location in the report of the item.