Displaying report parameters
Parameters enable users to input values into the BIRT document or design file for filtering, formatting or processing data. Parameters can be required to run a file job or they can be optional. For example, a BIRT design file that displays order history for each customer can require a parameter for a customer name. The user selects a customer name and runs the file job to create the document file. Only data about the selected customer is in the new document. Other uses of parameters is to request a report in a specific language or to add comments into the final report.
Each parameter in a report or Reportlet gadget can appear in the following ways:
Not displayed
The parameter is not displayed on the dashboard. A default value is selected when creating or editing the gadget.
Displayed inside the gadget
The parameter is displayed as part of the report or Reportlet gadget. A user selects values for the parameter, then runs the report.
Displayed as a new selector
A new data selection gadget is created that contains the selected static parameter. Other report and Reportlet gadgets can use this gadget.
Linked to an existing gadget
The report or Reportlet gadget uses an existing parameter or data visualization gadget to receive the parameter value.
Dynamic filter parameters can only appear in parameter gadgets or as part of the report gadget. These are parameters that enable the user to select a condition and a value. Static parameters only enable the user to select values.
If a parameter value is required, you must select a default value, as shown in
Figure 3‑11. Displaying a parameter enables the dashboard user to change the parameter value and update the gadget content.
Figure 3‑11 Configuring parameter settings for a report gadget
