Advanced Report Options

Owned by Becky Weinberg (Unlicensed)
Last updated: Aug 22, 2023 by Pamela Totas (Deactivated)
4 min read

Advanced Report options are parameters you define that are passed through the Advanced Report Rule to the Advanced Report profile. Use Advanced Report Options to add customization and flexibility to the processing and output of an Advanced Report. Advanced Report Options include changing a report title or footnote, changing a chart type displayed in an Advanced Report, filtering data based on a specific PACE field, or determining the sort order of data or footnotes within a report. Most options require some custom coding in the imaging template (DLL) to perform a custom function.

Manage Options

To access Advanced Report Options:

  1. From any Eagle window, click the Eagle Navigator button to access the Eagle Navigator.

  2. Enter Options in the Start Search text box.

  3. Click the Options/Parameters (Reporting Center) link to access the Maintain Options/Parameters component.
    You see the Maintain Options/Parameters window displaying existing advanced report options and their parameters, including Comments, Caption, Type, and Default Value.

  4. Click the Options/Parameters (Reporting Center) link to access the Maintain Options/Parameters component.
    You see the Maintain Options/Parameters window displaying existing advanced report options and their parameters, including Comments, Caption, Type, and Default Value. The Maintain Options/Parameters window displays the following columns:

  • Name. A unique option name.

  • Comments. The option description displayed as a tool tip in the advanced report profile.

  • Caption. The Caption displayed in the Options Values selection window of the Advanced Report profile.

  • Type. The type of the option.

  • Default Value. The default value for a particular option type.

Using the Maintain Options/Parameters window, you can manage advanced report options, including refreshing, adding, editing, copying, and deleting options. These procedures are explained in the following sections. The following table describes options available on this window.

Option

Description

Refresh

Refreshes the list of advanced report options on the Maintain Options/Parameters window.

New

Use to add a new advanced report option to the Maintain Options/Parameters window.

Edit

Use to edit parameters of the selected advanced report option displayed on the Maintain Options/Parameters window.

Copy

Use to copy parameters of the selected advanced report option and save the new option under a unique name.

Delete

Use to delete the selected advanced report options.

Usage

Displays how the Advanced Report Rule is used in other dependent components.

Add Advanced Report Options

To add a new advanced report option:

  1. On the Maintain Options/Parameters window, click Add.
    You see the Add/Edit Option dialog box.

  2. In the Name field, type a name for the new advanced report option.

  3. In the Caption field, type a caption for the advanced report option.

  4. In the Comments field, type a description for the new advanced report option.

  5. From the Type drop-down list, select the option type. Complete the options as needed.

  6. In the Default Value field, click the ellipsis (...). The dialog box that appears depends on the option you selected in the Type drop-down list.

  7. In the Properties section, select the following check boxes to set up Advanced Report properties:
    Required properties. Required properties must have a value entered in the advanced report profile for the profile to be submitted.
    Shared properties. Shared properties apply to all relevant advanced rules in the advanced profile. If you select the Shared check box, the option is applied to more than one advanced rule in an advanced profile. The option appears only once in the option section of the advanced profile, and you only have to set the option value in one place. Conversely, if more than one advanced rule in an advanced profile has a non-shared option associated, that option appears in the profile once for each advanced rule which contains the option.
    Hidden properties. A Hidden property is invisible in the advanced report profile. For example, the opt_run_last option, which is shipped and installed with PACE. This option is used to ensure that a specific advanced report rule is run at the end of a package, no matter where in the package it has been selected to image. The opt_run_last option is typically used with an advanced report rule associated with a table of contents. This allows the table of contents to display the correct package level page numbering for the reports in the package.
    When an advanced report with a code option runs, you select a Code value for the option. An example of how this type of Option can be used is an Advanced Report that retrieves trade data and the Code option specifies which transaction type to include in the report.
    An Option cannot have both the Required and Hidden properties enabled without a Default Value specified. Advanced Report Options data is stored in the RULES.DBO.OPTIONS table. The associations between Advanced Report Options and Advanced Report Rules are stored in the RULES.DBO.ADV_REPORT_OPTIONS table.
    When an Option has a type of Code, the long description of the code value associated with that code is displayed in the Option Value selection field within the advanced report profile, and not the short description of the code value.

  8. Click OK.
    You see the new advanced report option on the Maintain Options/Parameters window.

Edit Advanced Report Options

To edit an advanced report option:

  1. On the Maintain Options/Parameters window, select the option to edit.

  2. Click Edit.
    You see the Add/Edit Options dialog box.

  3. Make any changes and click OK.

Delete Advanced Report Option

To delete one or more advanced report option:

  1. On the Maintain Options/Parameters dialog box, select the advanced report option to delete.

  2. Click Delete.

  3. You see a confirmation dialog box.

  4. Click OK to delete the selected option.

Copy Advanced Report Option

To copy an advanced report option:

  1. On the Maintain Options/Parameters dialog box, select the check box next to the option to copy.

  2. Click Copy.
    You see the Copy As dialog box.

  3. In the Copy As field, type a unique name for the new option and click OK.
    The new option appears on the Maintain Options/Parameters window.