Parameters
Parameters serve as dynamic placeholders that allow users to customize data retrieval and visualization within datasets and dashboards. They enable flexible queries, filters, and conditions , helping tailor data presentation and analysis to specific needs.
Users can configure parameters with various properties, such as data type, default values, and display options. This flexibility empowers users to interactively control and manipulate data visualization and analysis within the application environment.
Create and Use Parameters: This video explains how to create and apply parameters in the application.
Steps to Create a Parameter
There are two ways to access the parameter creation interface:
-
Click the hamburger menu, navigate to Masterdata, and then select Parameters.
-
There are two ways to create a new parameter in the application:
-
Method 1: Click the Create button located at the bottom of the Parameters page.
-
Method 2: Right-click on the blank space within the parameter list area and select Create Parameter from the context menu.
-
-
After clicking Create, a Create Parameter popup box will appear. Fill in the fields as prompted to complete the parameter setup.
Understanding Fields in the Create Parameter Popup:
-
Parameter Name: A unique name for the parameter used when referencing it in datasets. Example: Country. (Required)
-
Prompt Text: The label shown to users when the parameter input appears. It helps guide users on what input is expected. Example: Select Country. (Required)
-
Data-Type: Select the appropriate data type for the parameter. Example: String. (Required)
-
Format As: Defines how the parameter value should be displayed. By default, this is set to Custom. Example: Custom. (Required)
-
Display Type: Allows users to choose how the parameter value will be presented. Example: List Box. (Required)
Display Type Options:
-
Text Box: A plain text input field for manually entering static values.
-
List Box: Displays a dropdown list of options from which users can select one or more values. Suitable for both static and dynamic lists, it enables users to choose from a predefined set of choices based on their needs.
-
Radio Button: Presents a list of mutually exclusive options where users can select only one. Ideal for scenarios where a single selection is required. Can be configured with static or dynamic values.
-
Multi-Select: Enables users to select multiple options from a dropdown list. Useful for filtering or analyzing data based on several criteria simultaneously. Supports both static and dynamic lists and enhances flexibility in data analysis.
-
-
Help Text: Optional text that provides additional guidance to users when interacting with the parameter. Example: Please select Country from the dropdown. (Optional)
The user can decide to enable the following option for the Parameter:
- Hidden : Parameter value will be applied, however, it will not be visible to end user
- Require : Currently in all the cases Parameter will be required whether the box is checked or unchecked.
- Dynamic : This option only gets active when Display Type is selected as List Box or Radio Button, the user can pull the parameter value dynamically from the Dataset.
Here as we have selected Dynamic the following fields are also enabled :
- Dynamic : This option becomes active when the Display Type is set as List Box or Radio Button. It allows users to dynamically retrieve parameter values from a dataset. By enabling this feature, users can populate the dropdown list or radio button options with values fetched directly from a dataset. This dynamic capability enhances flexibility and automation in parameter management, ensuring that users have access to the most up-to-date and relevant options for their analysis or queries.
- Select Dataset : This option becomes available when the Dynamic checkbox is checked. When selected, users are required to choose the dataset from which the parameter value will be retrieved. Enabling this dynamic functionality allows parameters to be populated dynamically based on the data available in the selected dataset. It enhances flexibility and automation, ensuring that parameter values are always up-to-date and relevant to the user’s analysis or queries.
- Display Text : Display text for the end user” refers to the text that users will see when interacting with a parameter in the application interface. It provides clear instructions or information to guide users in selecting the appropriate parameter values. This display text should be concise, descriptive, and easy to understand, helping users make informed choices when using the parameter in their analysis or queries.
- Value : The “Column name from where the values of the parameter will be displayed and applied” refers to the specific column in the dataset from which the parameter values will be retrieved and displayed to the user. This column contains the data that users can select when using the parameter in the application. It’s essential to choose the correct column that contains relevant and meaningful values for the parameter to ensure its effectiveness in filtering or specifying data in the application.
- Linked Parameter and Filter Column : This option is only required when creating a Cascading parameter.
In case of any further help, the user can click on the 
icon to access the AIV help documents.
If the user is not satisfied and wants to cancel the create request, he can do this by clicking on the CANCEL button next to SAVE or by clicking on
icon next to the icon.
Finally, click on button to create a new parameter.
In this manner, you can create a new parameter in the AIV application.