/
Customizing HTML Viewer

Customizing HTML Viewer

When a report is run in HTML or iHTML format, the HTML Viewer appears at the top of the report. As an administrator, you can customize the HTML Viewer toolbar to meet organizational needs. The toolbar provides options to export, print, publish, email, or upload reports.

To configure the HTML Viewer toolbar settings, go to Navigate > Administration > Configure > Viewer.

image-20241125-113321.png

Using the HTML Viewer Configuration Page

As a super administrator, you can customize the HTML Viewer for the following levels:

  • Default: Applied when no configuration is set, or the system configuration is lost or deleted.

  • System: Applied to all users or roles across all organizations where custom configurations are not set.

  • Organization: Applied to all users or roles within an organization where custom configurations are not set.

  • Users/Roles: Applied specifically to the user or role for which it is created.

When you open the configuration page, the System configuration is displayed by default. You can:

  • Open a configuration to edit it.

  • Save for one or multiple organizations and users to apply the configuration.

  • Delete the configuration for one or multiple organizations and users.

Buttons on Configuration page

Configuration page has following buttons on it:

  • Save: Saves configuration changes for the System, the selected organization, or the user currently open.

  • Save For: Opens the Save Configuration dialog, allowing you to select entities and apply the changes to all selected entities. Click the down arrow on the Save button to access the Save For option.

  • Open: Opens the Open Configuration dialog to select an entity and view or edit its configuration.

  • Delete: Deletes the currently open configuration (default or selected entity).

  • Delete For: Opens the Delete Configuration dialog to select entities for deletion. Click the down arrow on the Delete button to access the Delete For option.

Open Configuration dialog

Use this dialog to select a configuration (System, organization, or user) and open it for editing on the Configuration page.

Save Configuration Dialog

Use this dialog to save configuration settings made on the Configuration page for one or more entities, including organizations and users. The Save Configuration dialog opens when you select the Save For option.

Delete Configuration Dialog

Use this dialog to select one or more organizations or users and delete their configurations. The Delete Configuration dialog opens when you select the Delete For option.

Configuring the Viewer

The HTML Viewer Toolbar page includes the following sections:

  • Show: Configure the toolbar groups and their buttons to display in the viewer.

  • Ad hoc Power Viewer: Configure features specific to the Ad hoc Power Viewer.

  • Background Execution Report: Choose whether to display report execution details.

Show

This section allows you to configure which tool-button groups appear on the HTML Viewer Toolbar and adjust their sequence.

Steps to Configure Tool-Button Groups:

  1. In the box under the Show section, select the checkbox for the desired tool-button group.

  2. The details for the selected group will appear on the right side of the Show area.

  3. Configure the details and options for the selected group as needed.

  4. Click Save to apply your changes.

Adjusting the Sequence of Tool-Button Groups:

  • To change the order of tool-button groups on the toolbar or buttons within a group, select the group or button and use the arrow buttons to move it left or right on the toolbar.

Backcolor:

  • Choose a background color for the toolbar.

    • Specify the RGB code for the color.

    • Alternatively, use the color picker to select a color.

  • If the provided color code is invalid, the default color (grey) will be applied by Kyvos Reporting.

UTILITY

Use this section to add utility-related buttons to the HTML Viewer Toolbar.

Steps to configure Utility buttons:

  1. Select the UTILITY checkbox to enable utility-related buttons.

  2. Choose from the available utility buttons:

    • ALERTS: Adds an alert indicator button to the toolbar. This button blinks when alerts for the report being viewed are generated.

    • TOC: Adds a Table of Contents (TOC) button to the toolbar.

  3. In the selection box at the top, select the specific utility buttons you want to include on the toolbar.

EXPORT

This section allows you to configure export-related buttons on the HTML Viewer Toolbar.

Steps to configure Export buttons:

  1. Select the EXPORT checkbox to enable export-related buttons.

  2. In the selection box at the top, choose the export buttons to include as part of the export functionality.

In this section, you can also configure the export options that should appear in the Export Dialog Box. The sequence in which you set these options will determine their order in the dropdown list.

Note

The Export Options Dialog Sequence will only take effect when EXPORT_OPTIONS is selected in the selection box at the top.

PRINT

Use this section to add print-related buttons to the HTML Viewer Toolbar.

  1. Select the PRINT checkbox to include print options.

  2. Configure Margins:

    • Print Left Margin

    • Print Right Margin

    • Print Top Margin

    • Print Bottom Margin
      Specify the margin (space to be left blank) in pixels for the left, right, top, and bottom of the page.

  3. In the selection box, choose the print-related buttons to include on the toolbar.

PUBLISH

Use this section to add Publish buttons to the toolbar.

  1. Select the PUBLISH checkbox to include publishing-related options.

  2. From the selection box, choose the Publish tool button to be added to the toolbar.

EMAIL

Use this section to add Email options to the toolbar.

  1. Select the EMAIL checkbox to include email-related tool buttons.

  2. From the selection box, choose the Email tool button to include on the toolbar.

UPLOAD

Use this section to add Upload options to the toolbar.

  1. Select the UPLOAD checkbox to include upload-related tool buttons.

  2. From the selection box, choose the Upload tool button to be added to the toolbar.

REFRESHDATA

Use this section to add a Refresh Data button to the toolbar.

  1. Select the REFRESHDATA checkbox to add the button for refreshing the report with the latest data.

  2. From the selection box, choose the Refresh Data tool button to include on the toolbar.

NAVIGATION

Use this section to add Navigation buttons to the toolbar.

  1. Select the NAVIGATION checkbox to include navigation-related tool buttons.

  2. From the selection box, choose the navigation-related buttons to be added to the toolbar.

REPORT

Use this section to add the Stop button to the toolbar.

  1. Select the REPORT checkbox to include the Stop button on the toolbar, which allows users to stop a report's execution.

  2. From the selection box, choose the Stop button to be added to the toolbar.

COMMENTS

This section allows you to configure the display of comments within reports.

  1. Show comments in new reports: When selected, comments are displayed in unpublished reports. If a comment is added to the report, it will automatically be published as Public for an infinite duration.

  2. Show comments in published reports: When selected, comments are displayed when viewing published reports.

  3. From the selection box, choose the comment-related buttons to be included on the toolbar. You can also set the sequence of the buttons.

  4. Select the GENERATELINK checkbox to include the Generate Links tool button for published report outputs.

Ad hoc Power Viewer

When viewing an Ad hoc Report, you can perform additional actions like sorting, grouping, repositioning columns, or viewing charts in different ways. These dynamic actions are possible if the Ad hoc Power Viewer is enabled.

  1. Enable: Select this checkbox to enable Power Viewer functionalities.

  2. Show Help: Select this checkbox to make the Help icon visible in the viewer.

Related content

Copyright Kyvos, Inc. All rights reserved.