/
Database Connections in Kyvos Reporting
Document toolboxDocument toolbox

Database Connections in Kyvos Reporting

Owned by Sarabjeet Kaur
Dec 19, 2024
3 min read

In this section, you will find instructions on creating connections to various data sources. Kyvos Reporting helps you fetch data from multiple data sources at once.

You must have Super Administrator privileges to set up database connections.

To create a connection, click Navigate > Administration > Configure > Connections.

KRconnection.png

If Kyvos Reporting runs in security-disabled mode, you can access this page by specifying the following URL in the browser’s address bar.

  • If you are using a machine that acts as a web server - http://localhost:<portnumber>/Kyvos Reporting/pattern/conf and then click the Databases tab

  • In other cases - http://<IP of the server:port number>/Kyvos Reporting/pattern/conf and then click the Databases tab

Action Buttons

  • Add: Configure a new connection using the Connection Name and Provider details.

  • Test: Test a database connection’s validity. A Connection Test Succeeded message will appear if the selected connection is valid. When the user clicks on the ‘Failed’ marker for an invalid connection, a pop-up will open to show the detailed error message behind the failed connection.

  • Save: Save the selected connection once it has been successfully tested.

  • Discard: To discard unsaved connections.

  • Refresh Schema: To manually refresh the schema of the selected connection. Metadata is cached when a database connection is created.  It is refreshed depending on the value set in MetaData Cache Purge Frequency. Select the data connection to refresh the metadata manually and click the Refresh Schema button.  On the Confirm Refresh dialog, click Yes to proceed.  A message ‘A request for refreshing (name of the connection) schema has been sent to the Report Server’ will be displayed.

  • Remove Connection (available under the Actions menu next to Refresh Schema): Remove an existing connection.

  • For more than 10 connections, use the search bar to find a connection.

Note

Click the Actions menu next to the help icon to download the database configuration file in encrypted.

Deciding the preference of connections for a report run

The data the user gets on a report is fetched from a database using a data connection.  Based on the Kyvos Reporting edition and license, you can set one or more data connections in Kyvos Reporting.

The database (data connection) to be used to run reports can be set in the following ways:

  • While running the report.

  • While specifying just after logging into Kyvos Reporting (at session level), this remains the default for any database use (report running, running queries, etc.).

  • By setting up User Preferences

  • By specifying it as part of the Report Details (while uploading a report through the portal or through cab).

  • By specifying it while designing the report (IRL file).

  • By specifying a default data connection.

When a report is being run, Kyvos Reporting will use the data connection in the following order:

  1. Data connection selected while running the report from Report Delivery Options

  2. If the connection was not selected on Report Delivery Options page, database connection selected at the time of login into Kyvos Reporting (session level).

  3. If the connection was not selected during login, the data connection on User Preferences.

  4. If a connection is not selected on the User Preferences page, the data connection while deploying the report (report details).

  5. If a connection is not selected as a report detail, the connection selected when designing the report (irl file).

  6. If a connection is not selected in the irl file, the default connection set in Kyvos Reporting on Connection Configuration.

Changing the order of preference

Order is controlled by values specified in <CONNECTIONPRIOIRTY> tag in ProviderInfo.xml located at path: Kyvos Reporting<installation path>\ReportEngine\Config .

Values (and the default sequence) are:

  • CALLBACK: The connection is set on the Report Delivery Options page.

  • SESSION: Connection set from the home page of Kyvos Reporting.

  • USERPREFERENCE: The connection is set on the user preference page.

  • REPORTDEPLOYMENT: Connection set at the time of report deployment.

  • NAMEDCONNECTION: Connection set during report design.

  • DEFAULT: Connection is set as the default on the Database page of Kyvos Reporting.

To change the order, change the appearance of the above values in the CONNECTIONPRIORITY tag, which is the last tag in the file.

For example, the default order:

<CONNECTIONPRIOIRTY>CALLBACK, SESSION, USER PREFERENCE, REPORTDEPLOYMENT, NAMEDCONNECTION, DEFAULT</CONNECTIONPRIOIRTY>

Modified order:

<CONNECTIONPRIOIRTY> SESSION, CALLBACK, USER PREFERENCE, REPORTDEPLOYMENT, NAMEDCONNECTION, DEFAULT</CONNECTIONPRIOIRTY>

To learn connecting different providers, refer the chapter below.

Copyright Kyvos, Inc. All rights reserved.