How to: Define a Report Parameter

Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Parameters are used to specify the data to use in a report, connect related reports together, and control report presentation. This topic contains a section that describes the different kinds of report parameters that can be used on Microsoft Dynamics AX reports.

Report parameters are used to enable interactive, client-side data filtering in a report. In this case, you must manually define a parameter, and then use it to define an expression for a report filter. Since filters are applied on the client, there is no round tripping required.

The following procedures explain how to manually define a report parameter and use it in a filter.

To manually define a report parameter

1. In Model Editor, expand the node for the report that you want to work with.

2. Right-click the Parameters node, point to Add, and then click Parameter. A node for the parameter displays.

3. Select the node for the parameter.

4. In the Properties window, specify property values for the parameter.

   Property	Description
   Allow Blank	Indicates whether the parameter is allowed to be blank.
   Data Type	The data type of the parameter, such as DateTime. Note If a parameter is the DateTime Data Type, the Microsoft Dynamics AX client treats the parameter as coordinated universal time (UTC) and any default value from Reporting Services will be converted to the local user time zone. When you preview a report with a DateTime parameter, the time format displays as an Integer Data Type in Visual Studio preview. The report will render correctly as a DateTime Data Type in the Microsoft Dynamics AX client.
   Default Value	A default value for the parameter.
   Multi Value	Set the property to True in the following scenarios: The parameter is allowed to have multiple values. The parameter is static and represents a range on a query. Note The ‘;’ is not supported by the MSDAX client to mean Multi Value. If you set the Multi Value property to True and the end user of the report provides values like 1;2;3 then the client will only use 1 as the value.
   Name	The name of the parameter in the model.
   Nullable	Indicates whether the value of a parameter can be null. If the Nullable property is set to True, a null value indicator check box displays next to the control that is generated for the parameter. Note The Reporting Framework does not provide support for indicating that an Integer, Float, or String parameter is a NULL value.
   Prompt String	The text that displays in the user interface when a user is prompted to enter a value for the parameter.
   Values	Indicates how values are supplied for a parameter. Click the ellipsis button (...) to display a dialog box with the following options. From Dataset - Use this option to display a set of values from a particular dataset. Select a dataset from the drop-down list for the Dataset property, and then select a Label Field and a Value Field from the corresponding drop-down lists. The Label Field value displays to the end user. The Value Field value is used in filters or passed back to a query parameter when this parameter is used by a dataset. Non-queried - Use this option to display a set of unbound values that are not from a dataset. Provide a set of value/label pairs in the table for each item that you want to include as an available value. Unbound values must be a String type because they are entered and stored as text. You can leave the table blank and not specify any value/label pairs. However, if you do this, you will not be allowed to specify a default value for the parameter using the Default Value property since the default value must come from the set of available values. In this case, it is recommended that you use the Null option. Null - Use this option if you want to allow unrestricted values for the parameter (restricted only by the data type). You can specify a default value for the parameter using the Default Value property.
   Visibility	Indicates whether the parameter is displayed to the user.

   The property values that you specify for a parameter in the Properties window determine what a user sees when the parameter displays in a report. For more information about the controls used to render parameters in a report, see Controls Used to Render Report Parameters.

To use a report parameter in a filter

1. In Model Editor, expand the Designs node for the report.

2. Expand the node for the design that you want to add a filter to.

3. Right-click the Filters node, and then click Add Filter. A node for the filter displays.

4. Select the node for the filter.

5. In the Properties window, specify the following properties.

   Property	Description
   Expression	An expression for the filter. From the drop-down list, choose a valid field for the filter to create a simple expression, or choose <Expression…> to open the Edit Expression dialog box to create a more complex expression.
   Name	The name of the filter.
   Operator	An operator for the filter expression.
   Value	The parameter or an expression that contains the parameter. Choose <Expression…> from the drop-down list to create a complex expression. For information about creating expressions, see Expression Examples in Reporting Services.

6. To preview the layout of the report, right-click the node for the design, and then click Preview. The parameters display when you select the Parameters tab in the Preview window.

There are many types of report parameters. Use the following table to decide which is best suited for your report. The following table describes how parameters are created, how that affects a report, and any special considerations:

See also

How to: Define a Report Filter

Controls Used to Render Report Parameters

Expression Examples in Reporting Services