Properties Windows for Parameter Groups and Parameters

Parameter Groups

Name - Use to customize the name of a parameter group. Each group requires a unique name. The name will display above the group in the View Prompt window.

Dimension, Hierarchy, and Level - Dimension field is read only and is updated as you make your Hierarchy selection. If a Hierarchy has more than one level, choose the level for the parameter group using the Level drop-down list.

Required - If you want users of the view to be required to specify parameter values for the group before they can run the view, leave Required set to Yes. Otherwise you can change it to No and users will be able run the view without specifying any parameter values for the group.

Parameters

Name - Use to customize the name of a parameter. Each parameter across all parameter groups for the view requires a unique name. Don't use any spaces in the name.

Type - Select the type of parameter. You can create up to four parameters per parameter group, one of each type.

  • Select Members - this type creates a filter icon in the View Prompt window. The user can click it to access the Select or Advanced Select Members window. They can search for and select multiple members as the parameter value.

  • Drop Down - this type creates a drop-down list in the View Prompt window. The user can select one member as the parameter value.

  • User List - this type creates a filter icon in the View Prompt window. The user can click it to access the Select User List Filter window and select a user list as the parameter value.

  • Expression - this type creates a filter icon in the View Prompt window. The user can click it to access the Expression window and set up an expression for the parameter value.

Prompt - Enter a text prompt that instructs the user what to do with the parameter. The prompt will display next to the parameter's radio button in the View Prompt window. For example, you could enter text such as Choose a user list: for a user list parameter.

Note: In order to activate a parameter and have it display in the View Prompt window, you need to enter a prompt. If you don't enter a prompt, you are required to specify a default value.

Filter Mode - This property controls how Viewer treats the parameter filter. A parameter set to “Include” means the applied parameter filter will return only the members specified by your filter selections/criteria. A parameter set to “Exclude” means the applied parameter filter will return all members except the ones specified by your filter selections/criteria.

Default Value - You have the option of specifying a default value for each parameter. The value displays in the View Prompt window where the user can either accept it or override it by choosing a different parameter value.

  • Click the Browse button to set up a default. The window that opens depends on the type of parameter. For example, the Select or Advanced Select Members window opens for a Select Members parameter.

  • Click the "X" button to remove a default value from the parameter.

Display Text – You have the option of customizing the Display Text property for the parameter. See How Parameter Display Text Interacts with Other Settings for more details and examples.     

  • View – This is the default Display Text selection for all parameter types. Setting this to view means that you want the applicable drop-down list or Select/Advanced Select Members windows for the parameter to display based on the display text setting for the associated level in the view. 

  • Value or Attribute Relationship – Setting the Display Text to a specific attribute (either value or attribute relationship) means that you want the applicable drop-down list or Select/Advanced Select Member windows for the parameter to display using the selected attribute.

Note: Administrative settings in the Select Members Options window can override the parameter Display Text property.