Report parameters

Report parameters are placeholders for data that is populated when a report generates. Configuring report parameters provides a more efficient report building and viewing process.

Report parameters are inserted in data templates and report templates in the RtReports editor when defining:

• Journal Actions

• Module Templates

• Element Templates

• Asset Context Template

  The following report parameters are supported in asset context templates:

  • AF Element Name

  • AF Template Name

  • AF Root Path

  • AF Attribute

  • EF Attribute

Default values are set when you create a report parameter. When you generate a report, you will have the option to change or leave the default value. Report parameters can be created so that users generating the report can choose a value from a defined list. After viewing a report, you can change one or more values and regenerate the report.

To use the report parameters in the Asset Context Template:

Report parameter attributes

You can edit the report parameters in the Report Parameter Edit window.

• Report Parameters

  Lists the report parameters for the current data template.

• Parameter Name

  The name of the parameter. This name can be any length.

  All characters in the parameter name are encoded for the report URL string used in the RtReports generator, and they can contain any characters. However, due to constraints in Internet Explorer, the maximum length of URL strings is 2,083 characters. If possible, parameter names should use only alphanumeric characters to minimize the length of the URL string.

• Prompt

  The prompt displayed next to the report parameter name in the report viewer parameter interface. This text can provide additional information to the person generating a report.

  The prompt can be any length, but for viewing purposes in the report viewer, limit the length of the string to less than 50 characters. Since all characters in the parameter name are encoded for the URL string, the prompt can contain any characters.

• Accessibility

  The parameter resolution.

  Generator and URL string is a fully accessible parameter resolution.

  URL string only makes the parameter resolution unavailable in the user interface.

  Hidden parameter resolutions are not shown in the user interface or in the URL string.

• Values

  Determines the behavior of the parameter, and depends on the accessibility type.

  Report parameters can have default values and a validation type.

  Multiple value lists are unavailable for parameters that are not fully accessible.

• Data Type

  Determines how the parameter value is validated. Data types can be String, Numeric, or List.

  While all parameter values are stored as string values, you can specify a particular type before the report is generated. Values that do not match the data type will cause the report to generate an error. If the List type is selected, a list of values that will be selectable in the report viewer for that parameter can be defined by clicking the ellipsis button.

• Default Value

  The value used to resolve the parameter if the user does not change it during report generation.

  For String and Numeric type parameters, users can click on the magnifying glass icon to the right of the Value field to search for string values.

  You can search for parameter values by clicking the magnifying glass icon in the top right corner.

  When you select a value from the search results, you add that value to the parameter list values.

• Allow blank value

  Permits users to leave the parameter value blank.

  Supplying a blank value at runtime will substitute a blank value for that parameter indicator.

  Numeric type report parameters cannot use this option.

  If this option is cleared, using a blank value at run time generates an error.