Applies to: Kyvos Enterprise Kyvos Azure Marketplace
Kyvos AWS Marketplace Kyvos Free (
Use parameters to create dynamic dimensions and measures. Parameters allow you to quickly change among chosen dimensions or measures using the filter pane.
You can use parameters with a worksheet or dashboard. When you share a worksheet or dashboard, the recipient can choose from the parameters you provide to visualize the data differently easily.
When you use a parameter, a filter is automatically created. Then you can use the filter to visualize your data dynamically.
Each group of parameters is of the same type. If you want both dynamic dimensions and measures, create two different parameter groups.
Creating a list of parameters
To create a list of parameters of the same type, perform the following steps:
- From the Toolbox, select Workbooks , then select a workbook.
- Click the Actions menu (...) to the upper right of the pane and click Parameters.
- Enter a Name and optional Description for the parameter.
- Use the Caption field to provide a display name for the parameter. While browsing the worksheet, this caption is shown instead of the parameter name on the shelf and filter card .
- Choose whether it's a Dimension or a Measure
- Click Add from Semantic model fields and specify the semantic model if needed.
- Navigate to and select a level or attribute value or use Search to quickly find it
- Use the Display As an option to provide a custom value for showing on the visualization.
For example, you can choose the value CustomerName and set the Display as value to Customer Name. - Click the Is Default checkbox to choose the default value. This is the value first shown in the workbook or dashboard.
- Click Add from Semantic model fields again to provide additional values of the same type.
- You can rearrange the order of the values by dragging a value name in the list to a new position using the control next to the checkboxes.
- Click the Plus button to add more values and the Minus button to remove a value.
- Click Apply.
Adding a group of parameters
To add another group of parameters, perform the following steps:
- From the Toolbox, select Workbooks , then select a workbook.
- Click the Actions menu (...) to the upper right of the pane and choose Parameters.
- Click the Plus button at the top of the Parameters list
- Enter a name and optional description for the parameter.
- Select whether it's a dimension or measure.
- Click Add from Semantic model fields and add values.
- Click Apply.
Editing list of parameters
To edit a list of parameters, perform the following steps:
- From the Toolbox, select Workbooks , then select a workbook.
- Click the Actions menu (...) to the upper right of the pane and click Parameters.
- Select the parameter group to edit.
- Make changes.
- Click Apply.
Adding and using parameters in the worksheet
To add and use parameters in the worksheet, perform the following steps:
- The parameters are displayed in the Dimension and the Measures panels in the design view.
Drag them to the X or Y axis as you create worksheets. - In the Filter pane, you'll see the parameter name.
- Select from the values you created earlier to see different data quickly.
Using parameters in the dashboard
To use parameters in the dashboard, perform the following steps:
- Add a filter card to the dashboard.
- Select a parameter list name in the field column.
- Select values from the values in the parameter list you created.
Custom parameters
From Kyvos 2023.3 onwards, you now have the option to create custom parameters in your workbook. These parameters can be of the number, character, or date type and can be applied across all worksheets and dashboards within the workbook. By utilizing these custom parameters in filters, highlight conditions, cohort filter conditions, and calculated measures, users can make conditions dynamic. These parameters act as placeholders for values and can be modified by the user in the parameter section of the filter card on the sheet or dashboard.
For example, if you have set a condition as 'Country is in top 10 by Sum Sales,' you can use parameters to replace ‘Country’ and ‘Sum Sales’ making it dynamic by changing field from the filter card. Previously, there was no way to make the value '10' dynamic. With custom parameters, you can now dynamically modify the numerical value '10' since custom parameters support number, character, and date type parameters within workbooks.
To create a custom parameter, perform the following steps.
- From the Toolbox, select Workbooks , then select a workbook.
- Click the Actions menu (...) to the upper right of the pane and click Parameters.
- Enter a Name and optional Description for the parameter.
- Use the Display as field to provide a display name for the parameter. While browsing the worksheet, this display name is shown instead of the parameter name on the shelf and filter card .
- Select the type as Custom that will be used as a placeholder for character, number, or date type of values.
- Select data types as Character, Number or Date.
- Select the input control type from the Show as list which will be available to change this parameter value.
- For character, select one of the following:
- Text Input: Use this option to display text type input box.
- Single Select List: Use this option to display list of text values in which one value can be selected at a time.
- Multi Select List: Use this option to display list of text values in which multiple values can be selected at a time.
- For number, select one of the following:
- Number Input: Use this option to display number type input box.
- Single Select List: Use this option to display list of number values in which one value can be selected at a time.
- Multi Select List: Use this option to display list of number values in which multiple values can be selected at a time.
- Range Selector: Use this option to display range slider to set a valid number which will respect its range and step size.
- Type minimum and maximum value for the range parameter. The step size and default parameter value are automatically calculated and displayed in their respective fields. You can also modify these default values as needed.
NOTE: The intervals for that range must not be more than 1000.
- Type minimum and maximum value for the range parameter. The step size and default parameter value are automatically calculated and displayed in their respective fields. You can also modify these default values as needed.
- For date, select one of the following:
- Date Input: Use this option to display date type input box.
- Single Select List: Use this option to display list of date values in which one value can be selected at a time.
- Multi Select List: Use this option to display list of number values in which multiple values can be selected at a time.
- For character, select one of the following:
- Specify blank value if you want to add it to display in the worksheet.
NOTE: For a parameter, providing a default value is mandatory. - For a parameter with single select list or multi select list, do the following:
- Specify the custom value and use the Display As an option to provide a custom value for showing on the visualization.
For example, you can set the custom value as CustomerName and set the Display as value to Customer Name. - Click the Is Default checkbox to choose the default value. This is the value first shown in the workbook or dashboard.
- Optionally, if you want to include a blank value, then select Include Blank Value checkbox to include a blank value with the list of values.
- For a parameter with single select list or multi select list, if you want to provide multiple values at once instead of entering them separately, then click the Bulk List Generator link.
- Click Generate. The list is populated automatically under the 'list of values' section. You can click the Plus button to add more values and the Minus button to remove a value.
- Specify the custom value and use the Display As an option to provide a custom value for showing on the visualization.
- Click Apply. The custom parameter is created.
Using custom parameters in the worksheet or dashboard
Using custom parameters for the cohort filter
Using custom parameters in highlighting conditions
Using a custom parameter value in the calculated measure expression and use it in the worksheet
To do this, you must first open the Calculated Measures dialog box, and specify the expression that contains a custom parameter.
Following is the sample expression:
[Measure].[sales] * <%= Parameter 1&>
Filtering custom parameters
After creating calculated measure, drag the calculated measure into the View type section and drop it. In the Parameters section, you can view and change the custom parameter value anytime as needed in the worksheet.
After defining a calculated expression using dynamic values, it will allow you to change the parameter value dynamically in the worksheet without opening the calculated measures dialog box.
Adding a Dynamic Measure Title
Applies to: Kyvos Enterprise Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace
Kyvos Azure Marketplace Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)
Kyvos supports a Dynamic Measure title that can be applied to a worksheet or Dashboard. When the value of a dimension filter is changed, the measure title will automatically update to reflect the selected value of the dimension filter. See the Filtering data in worksheets section for more details.
To make the Dynamic Measure title work, you need to create the expressions for the following:
Measure value: Displays the Measure value when the filter value is changed.
Measure title: Displays the Measure title along with the Measure value. You can also reuse the Measure title for other Measure values.
Sample Expression
For example, you have a semantic model with a dimension called 'Calculation Type,' and this dimension has members such as MTD, YOY, YTD, and so on. Multiple calculated measures are created in the semantic model, and their values depend on the Calculation Type filter selected in the view. When you modify the filter value, the title of the measure will change accordingly.
Consider an example where a Calculated Measure displays a dynamic title, i.e., 'Dynamic Caption'.
Following is the sample expression for a Dynamic Measure Value
iif([CalculationType].[CalculationType].currentmember is [CalculationType].[CalculationType].&[YOY], "YOY ", iif([CalculationType].[CalculationType].currentmember is [CalculationType].[CalculationType].&[YTD], "YTD ", iif([CalculationType].[CalculationType].currentmember is [CalculationType].[CalculationType].&[MTD], "MTD " ,null)))
Following is the sample expression for a Dynamic Measure Title
iif([CalculationType].[CalculationType].currentmember is [CalculationType].[CalculationType].&[YOY], [Measures].[YOY Sales], iif([CalculationType].[CalculationType].currentmember is [CalculationType].[CalculationType].&[YTD], [Measures].[YTD Sales], iif([CalculationType].[CalculationType].currentmember is [CalculationType].[CalculationType].&[MTD], [Measures].[MTD Sales],null))), DYNAMIC_CAPTION = [Measures].[Dynamic Caption] + "On Sales"
If the filter is set to 'YOY' and the 'Sales Cal' Measure is visible in the View, the Measure title will be 'YOY on Sales'. This title combines the strings of the 'Sales Cal' Measure and the Dynamic Caption measure, as shown below:
Filter: Calculation Type = YOY
Measures: Sales Cal
Measure Title: YOY on Sales
Note
The changes are specific to the Kyvos Visualization layer and will not impact any third-party BI tool.
When the filter is not applied to the Calculation Type Hierarchy or is applied to multiple members of the hierarchy, the Measure Name (also referred to as the static caption), as displayed in the above example (such as 'On Sales'), will be shown. However, if the filter is applied to a single member of the Calculation Type Hierarchy, the Measure value you have set by using the DYNAMIC_CAPTION function will be displayed on the KPIs, charts, labels, titles, axes, tooltips, and legends.
Kyvos supports naming semantic model entities in the ENTITY_ format, such as DIMENSION_, DIM_, MEASURE_, and so on.
To add a Dynamic Measure value and title, perform the following steps.
In the Measures column, select the measure.
In Measure Properties, select Expression.
On the Expression dialog box, specify the expression as per your requirement. Click the i icons to learn more.
Click Validate to validate your criteria.
If you have made changes and don’t want to keep them, click Cancel.Click Save. The Dynamic Measure name and caption that you created are applicable to a Worksheet or a Dashboard.
Worksheet
Dashboard