Report Parameters

Report parameters are values that you can provide to a report before it is run to control the scope of the report. For example, a date parameter can specify the reporting day.

There are two ways that parameters are added to reports:

• You can specify your own parameters. These can be used to provide values in text and headings, and as query parameters in SQL Query paragraphs.
• Some report paragraph types have built-in parameters that are added automatically when you include one of these paragraphs in your report. For example, an Object Attribute Table paragraph has an Area/Group parameter.

How are parameters used?

• You can substitute the value of any parameter in report text including headers, footers and table column headings. To insert a parameter value, enclose the parameter name in carets. The value returned in a text paragraph is a descriptive string. See Report Parameter Data Types for details of what is returned for each type of parameter.

  Example: ^myParameterName^

• You can substitute the value of any parameter in a SQL query in a SQL Query Table paragraph. For attribute types, objects and tags, the value substituted is the primary key. For boolean parameters the value returned is either the strings "Y" or "N" or a null value.

Viewing parameter details

In the Report Editor, view the details of parameters by opening a report and clicking Properties.

In report output, print the parameter details by including a Parameter Paragraph.

In the Report Scheduler, parameter values for the selected report are listed on the Parameters tab. This is useful if you are running the same report but with different parameters.

See Also:

• Report Parameter Data Types
• Adding a Report Parameter