Parameters

What is a Parameter?

Parameters enable users to filter or customize data at runtime, tailoring objects such as forms, dashboards, and cube views to meet a variety of user needs. Administrators define these parameters in dashboard maintenance units, then assign them to the appropriate objects.

When to use

As configurable prompts, Parameters enhance reporting and analysis by enabling dynamic data filtering and refinement. Additionally, certain parameter types can be paired with form templates to streamline data collection.

When not to use

If your data remains constant and does not require dynamic filtering, using a Parameter may be unnecessary. Similarly, if the solution does not require user input or interaction to adjust the retrieved data, Parameters may not provide additional value.

Types

Each parameter type has two categories of properties: General and Data Source. Together, these properties identify a parameter, define its behavior, and control how it is used.

General properties are standard across all parameter types. Data Source properties vary by parameter type, but the first property for all parameter types is the Parameter Type property, where you select the type of parameter from a list.

Literal Value: Used to standardize formatting for cube view columns, rows, and dashboard components, reducing reporting maintenance. Literal Value parameters are the only type that do not prompt for any selections during creation.

Input Value: Allows users to enter or modify a value directly in a cube view or another object. For example, a user can create an Input Value parameter that, when running a cube view, prompts the user for a name to display as “Report Run By” in a product sales report.

Delimited List: Used to create a distinct list of predefined values. For example, a user can list all months of the year by specifying these items in the “display items” field, separated by commas, and then map each display item to a corresponding value item in the "value items" field, separated by commas, to finalize the list.

Bound List: Users can select a member from a dynamically generated list, sourced from a method or a SQL query. For example, a user could generate a list of all entities in a dimension using a method query.

Member List: Users select a member from a drop-down list. This parameter type does not support separate value or display items. The members shown in the list depend on the member filters a user configured for a given dimension.

Member Dialog: Enables users to navigate, search, and filter through a member hierarchy within a dialog box, allowing for more flexible selection of the desired member.

Create a Parameter

1. Click Application > Presentation > Workspaces.
2. Expand the Workspace and Dashboard Maintenance Unit where the Parameter will be created, then click Parameters.
3. Click Create Parameter in the dashboard toolbar.
4. In the Name and Description fields, provide a name and description that clearly indicates what information the parameter prompts users to specify, for example, "ParamBudget Scenario." Do not use special characters, dashes (-), or underscores (_) in the name.
5. In the User Prompt field, enter the text that will guide users in specifying the required information, such as "Select a Product Member" or "Enter your name." Skip this step for literal value parameters, as they do not prompt for selections.
6. From Parameter Type, choose a parameter type from the drop-down list. This determines the kind of information or objects users will be prompted to specify. For more details, see Types.
7. Configure the settings appropriate for the selected parameter type.
8. Click Save.

Assign a Parameter

After defining a parameter, assign it to the object where it should be used to filter runtime data or apply a stored value.

1. Click Application > Presentation > Workspaces and then select the appropriate object within a user's given Workspace and Maintenance Unit.
2. Edit the object to assign the parameter. Click the ellipses icon (...) within the Bound Parameter field to open the Object Lookup dialog box and locate the parameter, then enclose the parameter name in pipes and exclamation points. For example, |!ParamDate!|.
3. Click Save.