Ad hoc Report Templates

Ad hoc Report Templates

Applies to: Kyvos Reporting


This section describes how to configure Ad hoc Templates in Kyvos Reporting, which define the structure, appearance, and behavior of ad hoc report outputs. Templates are a combination of multiple files—primarily style (.sty) and layout (.irl)—that work together to control how data is presented across different output formats such as HTML and iHTML.

The Ad hoc Template Configuration page enables you to create, modify, and manage templates used in report generation. You can define visual styling for report components (such as headers, grids, charts, and matrices), configure layout structure using the Report Designer, and preview changes in real time.

This configuration also provides fine-grained control over individual report components, including grids, charts, matrices, and DataBars, along with advanced options such as orientation handling, iHTML-based layouts, and grid behavior through property files. Additionally, you can customize viewer-level experiences such as interactivity, rendering engines, and performance-related settings.

To configure templates, go to Navigate > Design > Ad hoc Template Configuration.

image-20260407-130150.png

Kyvos Reporting uses multiple files to generate ad hoc report outputs. Each file plays a specific role in defining the layout, styling, and behavior of report components.

File Types and Purpose

File Type

Description

File Type

Description

.sty (Style File)

Defines the visual style of report components such as alignment, orientation, font, and color.

.irl (Layout File)

Specifies data layout, paper size, and static elements on the report.

Style Template Components

Attach the following templates to the .sty file:

Component

Description

Component

Description

Report/Page/Group Headers & Footers

Define the visual properties of various headers and footers.

Detail Section

Controls styling and color of the report’s detail area.

Grid Template

Defines grid appearance in HTML or iHTML output.

Chart Template

Defines the look and feel of charts (CanvasChart or AmChart).

Matrix Template

Controls visual settings for matrix components.

DataBar Template

Sets style for DataBar visualization.

iHTML Template

Specifies layout and style for iHTML output.

Map Template

Defines map appearance and properties.

Work with the Ad hoc Template Configuration Page

Filter Templates

To filter templates:

  1. Enter search text in the textbox.

  2. The template list updates dynamically (case-insensitive).

Create a Copy of an Existing Template

  1. Select the desired template.

  2. Click Add Like.

  3. A duplicate template is created with the prefix Copy of. You can rename and modify it as needed.

Create a New Template

  1. Click Add New.

  2. Enter a template name and click Save.

  3. Define styles using the Item Properties pane and save changes.

  4. Click Edit Layout to open the Report Designer and define the layout.

Modify Templates

Modify Style File

  1. Select a template from the list.

  2. In the right pane, select a component and adjust its Item Properties.

  3. Click Save.

Modify Layout File

  1. Select a template.

  2. Click Edit Layout to open the Report Designer.

  3. Save the changes in the designer window.

Preview Template

Click Preview to launch the Ad hoc Wizard. You can open or design a report to preview changes made to the template.

Configure Output Styles

General Styling Options

You can set the following for headers, footers, and detail sections:

  • Font name, style, size, and color

  • Background color

  • Underline and strikethrough

  • Horizontal and vertical alignment

Group Header Options

  • Group Indent Width: Set to Fixed or Auto.

  • Include Groups in CSV: Set to True or False.

  • Horizontal/Vertical Alignment

Detail Section

  • Alternate Backcolor and Border Color (BGR format)

Configure Report Components

Grid Settings

Property

Description

Property

Description

Grid Provider

Choose rendering engine for grid.

Grid Template

Apply a specific template file.

Width/Height

Set in twips (1 twip = 1/15 pixel).

Grid Local Cache

Controls field show/hide options.

Data Tree Expansion

Options: Fetch on Demand, Prefetched, Expanded.

Chart Settings

Property

Description

Property

Description

Chart Provider

Choose between CanvasChart and AmChart.

Chart Template

Apply a chart style template.

Export Chart Provider

Choose the export rendering engine.

Width/Height, Font Name

Define chart dimensions and font.

Chart Local Cache

Controls field visibility.

Note
CanvasChart doesn’t support real-time or 3D charts. If 3D is selected, it falls back to 2D.

Matrix Settings

Property

Description

Property

Description

Theme

Apply matrix theme.

Alternate Colors

Set background and text colors.

Font, Row/Column Height

Define size and appearance.

Header Repeat

Enable/disable repeat across pages.

DataBar Settings

Property

Description

Property

Description

Width/Height

Define DataBar size in twips.

Positive/Negative Color

Set DataBar color based on value.

Data Label ForeColor

Set text color.

Configure Orientation

Property

Description

Property

Description

Modify Orientation

Auto-switches to landscape if needed.

Control Move/Expand Right

Define static controls to shift or expand if orientation changes.

Configure iHTML Output

iHTML Template

The iHTML template is a web resource folder containing a mandatory main.htm file. This acts as the layout for HTML Viewer output.

Location:
<Kyvos Reporting_Install_Path>/ReportEngine/templates/ihtml/<template_name>

Key Guidelines

  • Register INTERA_ONLOAD() function in <body> tag.

  • Use specific element IDs for components:

Component

ID Format

Component

ID Format

Grid

INTERA_GRID0

Chart

INTERA_CHART0 and INTERA_CHART0<!>MESSAGEDIV

System Parameters

INTERA_SYS_<PARAMETER_NAME>

Display Parameters

INTERA_<PARAMETER_NAME>_DISP

Note
If a placeholder is present but not used in the report, it will render blank. Use UTF-8 encoding for Unicode content:

<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">

Grid Behavior via Property File

Path:
<Kyvos Reporting_Install_Path>/ReportEngine/templates/grids/dhtmlx/<template>/dhtmlxgrid.properties

Note
Changes to this file require a Report Server restart.

Key Settings

Property

Description

Property

Description

STATUS_BAR

Show/hide grid status bar. Default: TRUE

SHOW_HIDE_COLUMNS

Allow users to show/hide columns. Default: TRUE

COLUMN_RESIZE

Enable column resizing. Default: TRUE

COLUMN_MOVE

Allow column reordering. Default: TRUE

SORT_ON_CLICK

Enable sort on column click. Default: TRUE

SEARCH

Enable row search. Default: TRUE

SEARCH_TYPE

FILTER or NAVIGATE. Default: FILTER

FILTERING_LEVEL

CURRENT_LEVEL, TOP_LEVEL, LAST_LEVEL, ALL_LEVELS

PAGINATION

Enable pagination. Default: TRUE

RECORDS_PER_PAGE

Number of records per page. Default: 100

 

Copyright Kyvos, Inc. 2026. All rights reserved.