NOTE: This help page describes a specific section of the Report Definition File Wizard. If you need more background information on this wizard, see the "Using the Report Definition File Wizard" topic.
This section of the Report Definition File Wizard enables you to specify the page keys of the report you are defining. A page key is a collection of values by which the user will be able to index the report; examples include accounts and departments. (When the Banner ePrint report is displayed in Adobe® Reader, each bookmark corresponds to a particular page key/value combination.)
If the report is secured by VBS (Authorization Type=VBS), the page keys must correspond to the VBS elements in the security definition file. (Authorization Type is set on the Basic Report Information section of the report definition file wizard.) If the report is not secured by VBS, any element that appears on each page of the report can be a page key.
You may define up to three keys for each report. If you define more than one page key for the report, you must indicate the key hierarchy with the Order field, with zero (0) the lowest level of the hierarchy. The PDF bookmarks will reflect this hierarchical relationship by appearing in a nested fashion on Adobe® Reader's navigation pane.
Click the Add button near the bottom of the dialog. Then fill-in-the-blanks with the appropriate information about the page key, as outlined below.
Key Name: | Type in the key name. This is the name that will appear in the user interface, so capitalize the first letter. If the report is secured by VBS (the Authorization Type on the Basic Report Information section of the wizard = VBS), the key name must exactly match a VBS element ID defined in the security definition file. |
---|---|
Bookmark Label: | Key in the label name. This is the text that will identify the PDF bookmark (e.g., 'Acct: ' for 'Account'). Be sure to include a trailing space if you want a space to appear between the label and the bookmark value. |
Type: | From the list box, select SCAN if the key is not located in the same place on each page of the report, or FIXED if it is in a fixed location. |
Order: | This field indicates the page key hierarchy. From the list box, select a value (0, 1 or 2) to represent the level for this key; the higher the number, the higher the hierarchy level. |
Scan for: | If Type=SCAN, key the value to be scanned for into this field. It is important that the value be entered exactly, including any trailing spaces. |
Row/Column: | If Type=FIXED, key the row where the key is located and the column where the key begins. |
Length: | Enter the number of characters of the page key. If the key is a scan key, then a number of characters equal to this length will be extracted immediately after the scan value. |
Using the Next and/or Previous buttons at the bottom of the page keys (or the secondary navigation bar), locate the key you wish to modify. Type over and/or select the appropriate information. The information will be modified when you finish the wizard.
Select the Delete button at the bottom of the page key you wish to remove. The key is removed from the report definition when you finish the wizard.
Report Definition File Wizard (Overview)
Navigating through a Wizard