Adding Studio Reports Parameters
Applies to: Kyvos Reporting
You can define a new report parameter on the Parameter Details screen. This screen is accessed by navigating to Tools > Parameters and clicking Add.
The table below describes each field available on the Parameter Details screen:
Property | Description |
|---|---|
Name | A unique name used to reference the parameter in the report layout and SQL using |
Prompt | The label that appears on the parameter input form at runtime. Example: |
Data Type | Specifies the type of input expected for this parameter. Supported types:
|
Size | Maximum length (characters or digits) allowed for the parameter value. |
Format | Format string to define the input format. Click the Format button to launch the Data Format dialog. Format examples:
Note |
Prompt Format | Format to be applied while displaying the prompt input box. |
Default Value | The value pre-filled in the parameter input field. For multi-select parameters, multiple values can be selected. For date-type parameters, predefined variables such as |
Database Time Zone | Specifies the time zone in which the database stores date/time values. Options include:- |
User Time Zone | Specifies the user’s time zone for accurate time zone conversion. Options include:- |
Prompt User Time Zone | When selected, the user will be prompted to select a time zone at runtime while entering the parameter value. Note |
Additional Parameter Configuration
The Parameter Details screen provides extended configuration options to control runtime behavior, input constraints, and value sourcing.
General Properties
Property | Description |
|---|---|
Description | Enter an informative note or help text for the parameter. It appears as a tooltip icon ( |
Mandatory | Select this check box to make the parameter mandatory. If the user tries to run the report without providing a value, an error message is displayed. |
Visible | If selected, the parameter is displayed on the input form. Set to false for hidden parameters like drill-down links or data security fields. |
Enable | If selected, the parameter appears enabled for input. This setting can be controlled dynamically through scripting. |
Secure | If selected, the values passed for this parameter are secured (not exposed in URLs or logs). |
Pass Values Using Table
This option is used when you need to pass a large set of values that may exceed SQL or stored procedure limits.
Sub-Property | Description |
|---|---|
Maximum Selectable | The maximum number of values allowed for the parameter. |
Enclosed By | Character used to enclose each value. Depends on the database. |
Separator | Character used to separate multiple values. Depends on the database. |
Value Restrictions
Property | Description |
|---|---|
Restrict to List | When selected (default), users can only choose from available list values. Applicable for Dropdown input type. |
Data Restriction | (Visible to Super Admin only) Allows assigning specific parameter values to specific users or organizations. For example:- Tom: Central, West- John: East, AlaskaConfigured under Manage Users > Modify > Data Restriction in the web portal.⚠️ Enabled only for referenced parameters. To edit, open the parameter via the portal. |
Input Type
The Input Type defines how end users provide parameter values:
Input Type | Control Type | Usage |
|---|---|---|
Edit Text | Textbox | Free text entry |
Dropdown | Multi-select list box | Select one or more values |
Options | Radio buttons | Select one option |
Slider | Range input | Select a range using slider control |
Checkbox (Boolean) | Checkbox | Select/deselect |
Boolean Parameter Setup:
Set data type as Boolean.
Specify values to be passed when checkbox is checked and unchecked.
Dropdown Source (Combo or Option)
Used when the parameter input type is Dropdown or Options.
Predefined Values
Under Dropdown Source, select Pre Defined.
In Display, enter the label shown to the user.
In Value, enter the value passed as filter.
Click Add (+) to include it in the list.
Use Edit (✏️) or Delete (🗑️) to modify entries.
Dynamic Values
Under Dropdown Source, select Dynamic.
Enter an SQL query to fetch data dynamically.
Use SQL Designer if needed.
Click Verify SQL to validate and fetch result fields.
In Display Column, select the field to show.
In Value Column, select the field to use as filter input.
In Display Parameter Name, enter the parameter name used as a control on a report.
More Properties
Property | Description |
|---|---|
Multi-Select | Enables selection of multiple values for the parameter. Useful for parameters like Country Name, where multiple selections may be needed. |
Maximum Selectable | Sets a limit on the number of values that can be selected for a multi-select parameter. |
Enclosed By | Character used to enclose values. This depends on database requirements. |
Separator | Character used to separate multiple values. This depends on database requirements. |
Default Value - Selected | Lets you preselect specific values to appear as selected at runtime. |
Default Value - All | All values appear as selected by default. |
Default Value - None | No value is selected by default at runtime. |
Search - Input Type | Set to |
Search - Dropdown Source | Set to |
Quick Search | Enables filtering of values using a keyword. Requires minimum key length. |
Advanced Search | Allows filtering using multiple columns, data types, operators, and values. Filtered values appear under the Result tab. |
Search - Column Name / Data Type / Prompt / Operator / Values | Define columns and conditions for search. The result set will update based on provided criteria. |
Tree View | Displays hierarchical parameter values, such as City → State → Country. |
Tree View - Source Type | Choose |
Tree View - Flat | Use when parameter values are in a flat structure. Configure nodes in Tree View Details and leaf in Dropdown Source. |
Tree View - Hierarchical | Use when the database supports hierarchical relationships. Requires fields like NODEID, PARENTNODEID, NODELEVEL, and NODEVALUE. |
Link | Link this parameter to another parameter. The values in the dropdown are filtered based on values selected in the linked parameter. |
Link - SQL Reference | Reference other parameters using |
Validation - Allowed/Invalid Characters | Specify valid or invalid characters, numbers, or dates. |
Validation - Allowable/Invalid Range | Define acceptable range of values. Can be numeric, character-based (Unicode), or date-based. |
Validation - Numeric Range | Use From/To fields to specify valid number range. Supports positive, negative, and decimal values. |
Validation - Character Set | Select allowed characters from the Character Set dialog or specify Unicode ranges. |
Validation - Date Range | Specify fixed dates or select from options like |
Validation Script | Add custom validation using script. Triggered on parameter change. Script returns |
Script Execution | Triggered on input changes (text input, dropdown, checkbox, etc.). For scheduled reports, the script runs at schedule creation time, not at runtime. |
Script Behavior | Can show error messages, disable other parameters, and reload affected parameters. Scripts can read other parameters and global business parameters (read-only). |