Parameter Objects

Applies to: Kyvos Reporting

In Kyvos Reporting, reports retrieve data by executing pre-defined Query Objects. If a query requires user input at runtime, it must include a user-defined parameter. When the report runs, the user is prompted to provide values for these input parameters.

Overview

Parameter Objects are reusable components that define how input values are collected during report execution. These parameters are stored in the repository and can be used across multiple reports and query objects.

Note

It is recommended to create all required Parameter Objects before creating Query Objects that will use them.

Access Requirements

To create and save a Parameter Object in a specific category, you must have Read and Write permissions for Parameter Objects in that category.

Administrators can grant or revoke user access to Parameter Objects. By default, all users can access parameters once they are created.

Naming and Syntax

Parameter names are typically prefixed with prm and referenced in queries using the following format:

<%prm_parametername%>

Example:

SELECT DISTINCT city 
FROM Country 
WHERE state IN <%prm_state%>

Types of Parameters

Kyvos Reporting supports various parameter types, including:

Linked parameters
Boolean-type parameters
Multi-select parameters
And more

Accessing the Parameter Object Editor

You can open the Parameter Object Editor in either of the following ways:

Navigate > Design > Parameter Object
Navigate > Repository > Report Objects > Parameter

The Parameter Object Editor allows you to create, modify, and delete parameter objects. Refer to the next section for details on creation parameters.

Refer to the chapters below to learn how to work with parameter objects.