Working with Parameter Objects

Applies to: Kyvos Reporting

This topic explains how to create and configure parameter objects used to capture user input during report execution. It covers the steps to define parameters using the Parameter Object Editor and provides a detailed description of all available properties under the General and Advanced tabs.

You will also learn how to control parameter behavior, validation, default values, and visibility, along with configuring data formats for both input and output. Understanding these configurations helps ensure accurate data capture, improved user experience on the Input Parameter Form (IPF), and efficient report execution.

To create a parameter object:

Open the Parameter Object Editor.
Specify the required properties for the new parameter.
Click Save As to save the parameter with a unique name in the selected category.
Click Add New to create additional parameters. This button is enabled after saving the first parameter.

Parameter Properties

The properties are grouped under two tabs: General and Advanced.

General Tab

Property	Description

Property	Description
Name	A unique name to identify the parameter across the application.
Caption	Descriptive label shown on the Input Parameter Form (IPF) at runtime. Helps users understand the expected input.
Data Type	Choose from:- Char: Alphanumeric and special characters Number: Digits and decimals Date: Date or date parts Boolean: Accepts true/false (checkbox)
Size	Maximum number of characters or digits (applies to Char and Number types only).
Usage Format	Output format for the parameter value. For details, see Parameter Object Formats.
Prompt Format	Input format shown on IPF for Date-type parameters. Supports locale defaults.
Default Prompt Value	Set a default value to auto-fill during report execution.For Date types, you can use:- `CURRENT_DATE`- `MONTH_START_DATE`- `YEAR_START_DATE`To define relative dates, use operators:• `CURRENT_DATE + 3`• `MONTH_START_DATE - 5`• `CURRENT_DATE + 2M - 5Y`
Use Input Source	Use the first value from a dynamic source (ValueColumn) as the default.
Mandatory	If selected, the user must provide a value before generating the report. Marked with an asterisk on IPF.
Visible	Controls visibility on IPF. Clear this to pass values programmatically (e.g., sub-reports or hyperlinks).
Enable	Controls whether the user can modify the parameter value. Can be toggled using scripts at runtime.

Advanced Tab

Property	Description

Property	Description
ID	System-generated unique identifier for the parameter.
Database Time Zone	Time zone of stored data. Select:- `SYS_CONN_TZ` (Database)- `SYS_SERVER_TZ` (Report Server)
User Time Zone	Time zone of the user. Select:- `SYS_USER_TZ` (Runtime-defined)- `SYS_SERVER_TZ` (Report Server). You can prompt users to specify a time zone on IPF.
Description	Information shown as a tooltip when the user clicks the info icon on IPF. Also appears in parameter save and open dialogs.
Restrict to List	If enabled (default), the user can only select values from a drop-down list. Applies to drop-down input types.
Pass Values Using Tables	Use this option to pass large sets of values using tables, especially when the data size exceeds SQL limits.
Add Script	Open the Script Editor to add custom validation or dynamic behavior. For details, see Scripting Parameter Form.

Parameter Object Formats

Format codes determine how data is displayed or entered. These formats apply both to parameters (input) and report fields (output).

Data Format Examples

Data Type	Sample Format	Example

Data Type	Sample Format	Example
City Name	Title case	New Delhi
Percentage	`%`	56%
Year	`yyyy`	2024
U.S. Date	`MM/dd/yyyy`	12/27/2024
India Date	`dd/MM/yyyy`	27/12/2024
Currency	`$`	$99

To apply a format, select from preset options. The corresponding format code is displayed and saved.

Note

You can enable Apply Locale Default to use the active locale’s formatting rules at runtime.

Format Categories

General: No specific formatting.
Number:
- Decimal Places: e.g., 12.00 or 12.34
- Use 1000 Separator: e.g., 1,000,000
- Negative Numbers: (874.98) or -874.98
Currency: Same as Number, with symbol prefix (e.g., ₹, $)
Date/Time: Choose from multiple formats (see next section).
Percentage: Display number with % suffix.
Scientific: Display in exponential form (e.g., 1.23E+02).
Text: Choose from Upper Case, Lower Case, or None.

Date and Time Format Codes

Use the following codes to format date and time values.

Code	Description	Example

Code	Description	Example
`dd`	Day (2 digits)	26
`ddd`	Abbreviated day	Fri
`dddd`	Full day name	Friday
`MM`	Month (2 digits)	12
`MMM`	Abbreviated month	Dec
`MMMM`	Full month name	December
`yy`	Year (2 digits)	24
`yyyy`	Year (4 digits)	2024
`HH`	Hour (24-hour)	17
`mm`	Minute	46
`ss`	Seconds	13
`a`	AM/PM	PM