[IFS/BA Designer Help Guide]
Apply Parameters
Explanation
This activity is used to select or enter values which are used to filter the
information shown in a report when being processed. This filtering can be done
using the Filter Criteria
tab where you can select the parameter values using the List of Values.
Prerequisites
In order to assign parameters:
- Parameters should have been created.
- Make sure the basic design of the report has been created.
- The report created should be filtered to use the created parameters.
System Effects
Information filtered using the parameters will be displayed in the report
when executed. If the report is saved as a template or as a published report and
is retrieved at a later time, it will only display the filtered information.
Related Process Model
Apply Basic Design
Related Activity
Select Information
Sources
Procedure
- Click
Report Book.
- Click
Parameters.
- Click
New Parameter if you need to create a new parameter.
- Select the Visible check box if you want the parameter to be
visible to the end user. If this is not selected you must enter a
default value to be used when filtering using this parameter.
- Select the Editable checkbox if you want the parameter value to
be editable during report processing.
- Select the Multi Value check box if you want to enter multiple
values for a parameter. Multi value parameters can be used as a condition
for a Filter Criteria with operator IN or NOT IN.
- The new parameter type will be set to Display Item by default. You can
change the parameter type as appropriate. For
example, selecting DisplayItem means the parameter is connected to a
display Item, selecting StringConstant means this value is based on a
string value, selecting NumberConstant means a constant based on a
number value, selecting DateConstant means a constant based on a date
value.
- Enter a name for the parameter.
- Enter a prompt text to be used when the report is
being ordered in the Prompt Text field. It is used as a guide at the time of entering a
parameter value.
- Define the display order to control the order of prompting the parameters at the point of execution.
- Click
Save Parameters.
- Click
Execute.
Note: When a parameter is saved it becomes visible in the
Display Parameters
pane. By expanding the parameter, it is possible to drag and drop the parameter
name, parameter value and any additional display items in to the design sheet.