Using Studio Reports Parameters Form Layout

Applies to: Kyvos Reporting

When a report includes run-time parameters, the Input Parameters Form (IPF) appears during report execution. You can configure the layout of this form using the Parameters Form Layout screen.

Accessing Parameters Form Layout

You can open the Parameters Form Layout screen in one of the following ways:

From the menu bar: Tools > Parameters Form Layout
From the toolbar: Click the Parameters Form Layout icon

Configurable Options

Property	Description

Property	Description
Description	Enter a description that will appear at run time on the Input Parameter Form.
No. of Parameters in a Row	Specify the number of parameters to display per row. Enter `0` to auto-adjust based on form width.

Adding Scripts at Form Level

You can define scripts at the form level using the OnSubmit() event. These scripts are executed when the user clicks the OK or Run button on the Parameter Details screen.

Script Behavior

Executes at run time or when the report is scheduled.
Can access all report parameters, parameter objects (even if not imported), and global business parameters (read-only).
Returns True if all parameter values are valid, or False if validation fails.
If False, an error message is displayed and the report will not run.
In case of a JavaScript error, the Report Server returns an ERROR.

To add a script, click Add Script to open the Script Editor. Click OK to save changes or Cancel to close without saving.

IPF at Runtime

When previewing a report in Studio with three or more parameters, the Input Parameter Form will display parameters in up to three columns per row, depending on configuration.

The Report Parameters screen appears in the following scenarios:

When the report is opened or fields are refreshed.
When the Preview tab is clicked.
When the OK button is clicked in the SQL Editor.

Using Report Parameters in SQL Editor

You can use defined parameters in the SQL Editor by referencing them within SQL statements.

Syntax:
Enclose the parameter name with <% and %>. Use single quotes around the parameter in SQL.

Example:

SELECT * FROM table1 WHERE name = '<%prm_agencyname%>'

When the SQL is executed, the actual run-time value replaces <%prm_agencyname%>.

Using Report Parameters in Layout Editor

Parameters can also be used within the Layout Editor:

Open the Field Window in Layout Editor.
Click View > Refresh Field List to display the parameters.
Drag parameter fields from the list onto the report layout as needed.