reportdef/parameters/parameter/parameter-options/parameter-option
Description |
Optional element that affects the behavior of parameter selecting by enforcing a selection and/or limiting the number of selections. |
Attributes |
name, value |
Example
In the example, the data is filtered
three ways: by business date (busDate
), location
name (locName
), and revenue center name (rvc
). These parameters are options when running a report
in Reporting and Analytics, found within Edit Parameters.
In the advanced editor, you can view the parameters listed under
the subject area selected for this query. Possible parameters and
parameter names are shown with a Parameter tag
in the subject area list on the left. Use the alias name of the column
within the name
attribute.
The parameter options used in this specific example limit the total number of business dates that can be selected to 7, limit the total number of locations that can be selected to 1, cause the parameter options to be shown when the report is run, and will force the user to select a location before running the report.
<queries> <query datasource="" name="Query2" result-type="multiple-rows" type="iquery"> <subjectArea name="Tender Fixed Period Total"> <columns> <column name="busHour" /> <column name="tndrName" /> <column name="tndrCnt" aggregate="sum" /> <column name="tndrTtl" aggregate="sum" /> </columns> <orders> <order name="busHour" direction="ASC" /> <order name="tndrName" direction="ASC" /> </orders> </subjectArea> </query> </queries> <parameters> <parameter name="busDate" type="list" data-type="date"> <parameter-default default-type="system" default-value="MostRecentOperations" /> <parameter-options> <parameter-option name="maximum" value="7" /> </parameter-options> </parameter> <parameter name="locName" type="value" data-type="text"> <parameter-options> <parameter-option name="pre-select" value="yes" /> <parameter-option name="maximum" value="1" /> </parameter-options> </parameter> <parameter name="rvc" type="list" data-type="text" /> </parameters> <report> ... </report> ...
Parent topic: Elements