Adding a Report Parameter

To add a report parameter:

  1. Open your report and click Report Properties to open the Report Properties screen.
  2. Beside the Parameters field, click Add to open the Insert Parameter screen.
  3. Set the following properties:
    PropertyDescription

    Name

    Enter a parameter name that is unique within this report.

    Use the parameter name when you are substituting the parameter in text or in a SQL query.

    Description

    Enter a label for the parameter that will appear in the report interface

    Type

     

     

    Specifying a type

    Choose a parameter data type. See Report Parameter Data Types for more information about data types.

     

    If you choose an Object or an Attribute parameter, you will also be prompted to choose which object or attribute types can be chosen. The choice provided to the user will be restricted to the types you have specified. For example, if you choose the object type Area, the user can only choose an object of that type (or one of its subtypes).

    Note that you can choose more than one type, or leave the type unspecified in which case the user can choose from any type.

    Nullable

    Select this checkbox to make setting a parameter value optional. If you are using the parameter in a SQL query, make sure that you cater for the possibility that it will have a null value. If you use a null parameter in text, the value will be blank.

    Save value

    Select this checkbox if you want the report to store the value set for the parameter in the Report Editor for use as a default value.

    Use run-time

    This option is only available for Date or DateTime parameters.

    Select this checkbox if you want the value of this parameter to be set by the Report Scheduler. If this option is set, the parameter value is set to the time when the report is run.

  4. Click OK to save your changes.

See Also: