Definitions and Descriptions of the UI Controls

Prompt

The Prompt is the label the user will see next to the input field for the parameter in the UI at run time.

You can use the up and down arrows on the left of the prompts to reorder the user prompts as they will appear in the Reports Console UI.

Parameter Type (UI control)

The Parameter Type, or UI control determines how the user selects input for the parameter. Examples of UI controls: pick lists, check boxes, text boxes, date fields.

The Parameter Type for user input must be matched to Data Type.

Parameter Name

The Parameter Name is the name associated to the parameter. It is assigned when the parameter is created, either manually or during dataset creation. When reports are being created, careful thought should be given to the parameter name that will identify it so that it is clear to the user what input is required. This field is not editable in Report Manager but can be edited in Report Builder. The name is case-sensitive, begins with a letter and has letters, numbers, an underscore (_), and no spaces, for example, ReportParameter_1. For automatically-generated parameters, the name matches the query parameter in the dataset query.

Data Type

The Data Type is a property of the parameter that determines the Parameter Type or UI Control that can be used for user input. The following data types are available in Report Manager: Text, Integer, DateTime, Boolean, String, Float.

Hint Help

The Hint Help will appear when a user rolls their mouse over the hint icon.

Data Dependency

Data Dependency allows filtering of the contents of one parameter type based on the selection of another.

In Simple Mode, this is informational. In Advanced Mode, this becomes editable.

Visibility Dependency

Visibility Dependency allows one UI control to be visible based on the selection of another UI control (always a check box) at run time. This helps to keep the UI organized and easy to read. An example of visibility dependency in the stock reports is the UI Control "Include Time Based SLA Breakdowns". If this check box is selected, the UI controls for the following appear: All Day, Start Time, End Time and Days. Each of these UI controls has a visibility dependency based on the selection of the UI control "Include Time Based SLA Breakdowns".

Required Field

A Required Field forces user input before the report can be generated.

Default Value

Applies to a required field. When a Default Value can be provided for a required field, user input becomes optional for the field.

Validation Groups

Validation Groups are created when two or more UI control types for parameters are assigned to a validation group. A Validation Group allows users to pick any of the contents of the grouped UI control types to filter the contents of a dependent UI control type.