Parameter controller
A parameter controller is a component that lets viewers adjust the content of sheets. You can create multiple parameter codes based on one parameter controller, and you can use one parameter code in multiple sheets. During the actual query, each parameter code is filled in with the value of its parameter controller.
Each parameter controller has its own name and default value. Sheet debugging results depend on the default value, and you can't adjust the default value in edit mode.
Types of parameter controllers
BI dashboards currently support two types of parameter controllers: date range controllers and drop-down controllers.
A date range controller lets you set a date range. The available ranges are similar to those in dashboards and analysis models, including exact date ranges, rolling date ranges, and ranges with an exact start and a rolling end.
After you add a parameter controller, you also need to configure parameter codes, including:
- Parameter code: The name used in sheets
- Retrieved value: Start date or end date
- Date format: Select a format that suits your data
- Offset unit & offset: Offset from the start date or end date to get the final result
For example, if the date range of a date range controller is 2026-02-01 to 2026-02-28, the final result varies with the parameter code configuration:
| Retrieved value | Date format | Offset unit | Offset | Final result |
|---|---|---|---|---|
| Start date | yyyy-MM-dd | / | 0 | 2026-02-01 |
| Start date | yyyyMMdd | Day | -1 | 20260131 |
| End date | yyyyMM | Week | 1 | 202603 |
| End date | yyyy | Year | -2 | 2024 |
When the parameter code of a date range controller is replaced with a date, it comes with quotation marks. Write ${parameter code} directly in the sheet without adding quotation marks. If you write '${parameter code}', debugging reports an error.
A drop-down controller lets you set single-select options, and each option has an option name and content
Likewise, after you add a parameter controller, you also need to configure parameter codes, including:
- Parameter code: The name used in sheets
- Value type: Raw or text
If the value type is raw, the system fills in the content as is. If the value type is text, the system wraps the content in single quotation marks ('') before adding it
Use parameter codes in sheets
After configuration, the configured parameter controllers and their parameter codes appear below the sheet. Hover over a parameter code to preview the content it will be filled with, and click the copy button to quickly copy the parameter code.
Use ${parameter code} at the corresponding position in the sheet. It's replaced with the corresponding value during debugging and actual queries
If you use a parameter code that hasn't been configured, a message appears
Adjust parameter controllers on the page
On the page, you can click to add Parameter Control and then select a parameter controller of the same type. After configuration, you can adjust it when you preview and view the BI dashboard
Parameter codes of parameter controllers that aren't added to the page are queried only with their default values. The values of parameter codes of parameter controllers that are added to the page change as viewers adjust them