Using System Parameters for Studio Reports

Applies to: Kyvos Reporting

You can use system parameters to display values such as the current date, time, or report details. These parameters are global and can be used in any report as needed.

Previously defined parameters appear in the Field List window of the Layout Editor. To use them, drag and drop the parameter onto the layout window.

In addition to user-defined parameters, Kyvos Reporting Studio provides a set of predefined system parameters:

Parameter	Description

Parameter	Description
`SYS_DATE`	Displays the system date.
`SYS_TIME`	Displays the system time.
`SYS_LOCALE`	Displays the report output language.
`SYS_REPORT_FORMAT`	Displays the output format of the report.
`SYS_REPORT_ID`	Displays the ID of the currently executing report.
`SYS_CATEGORY_ID`	Displays the category under which the report is running.
`SYS_REPORT_NAME`	Displays the name of the report as stored in the repository.
`SYS_USER_PARAMS`	Displays a string of user parameters with their values.
`SYS_SORT_PARAMS`	Displays a string of sort parameters.
`SYS_REQUEST_ID`	Displays a unique request ID assigned by the report server.
`SYS_PAGENO`	Displays the current page number.
`SYS_FILTER_PARAMS`	Displays all filter parameters and their values.
`SYS_GROUPBY`	Displays all “group by” parameters used in ad hoc reports.
`SYS_USERID`	Displays the user ID used to log in to Kyvos Reporting Studio.
`SYS_ORGID`	Displays the organization ID of the logged-in user.
`SYS_FIRST_RECORD`	Returns `-1` if the current record is the first in the result set; `0` otherwise. Useful in scripting.
`SYS_LAST_RECORD`	Returns `-1` if the current record is the last in the result set; `0` otherwise. Useful in scripting.
`SYS_PARENT_MAP_LEVEL`	Displays the parent map level of the current map level.
`SYS_CURRENT_MAP_LEVEL`	Displays the current map level being used in the report.
`SYS_USER_TZ`	Displays the time zone of the logged-in user.
`SYS_SERVER_TZ`	Displays the time zone configured for the Kyvos Reporting server.
`SYS_CONN_TZ`	Displays the time zone associated with the current connection.
`SYS_ABSOLUTE_PATH`	Displays the report category name associated with the report.

Note

These parameters are especially useful for scripting and conditional logic within reports.