Managing Kyvos Reporting Service

Kyvos Manager now supports installing, monitoring, and managing the Kyvos Reporting Service component in both on-premises and cloud environments.

Prerequisites
Deploying Kyvos Reporting Service
Post Deployment Steps
Known Behavior

Prerequisites

To deploy Kyvos Reporting Service, you will need to create a machine with all the required prerequisites, as described below.

Kyvos Reporting must be deployed on a dedicated node.
Kyvos Reporting must be deployed on Linux only and on the same Operating System as used by Kyvos.
NOTE: Machines based on Windows, MAC, or any unsupported Operating System will not be supported.
- Minimum 30 GB of free disk space
- Minimum 4 GB of RAM
The following commands must be present to access DFS.
- For on-premises, the hdfs command.
- For AWS and GCP, the aws s3 command.
- For Azure, the azcopy command.
Credentials to access the machine over SSH must be the same as those of other existing machines of the cluster.
Kyvos Reporting machine must have the same user account as the Kyvos machine.
Kyvos services should not be running on the Kyvos Reporting machine.
Kyvos Reporting machine must be in the same network and able to access Postgres (bundled or external).
Required ports: 45450 and 8080
For an on-premise cluster, the machine for Kyvos reporting should be part of the same Hadoop cluster in which Kyvos is deployed. In other words, the Kyvos reporting node should be able to access hdfs.
The installation directory on the Kyvos Reporting node must be the same as Kyvos. For example, if Kyvos is installed on /data1/kyvos, Kyvos reporting should also require this directory with the same set of rights.
Before installing Kyvos Reporting, copy the Kyvos Reporting bundle in the ../kyvosmanager_war/kyvosmanagerdata/server/repo/KyvosReporting/ directory on the Kyvos Manager node.
NOTE: This is not applicable where single-click upgrade is supported
- Create a Kyvos Reporting directory inside the repository if not present.

Deploying Kyvos Reporting Service

To deploy a Kyvos Reporting Service,

For scaling-supported environments, click here.
For environments that do not support scaling, click here.

Post Deployment Steps

The following are the post-deployment steps for deploying the Kyvos Reporting Service.

Installing fonts for specific types of Reports
Repository Connection Setup
Kyvos Connection Setup
Creating a secured Kyvos connection with Kyvos Reporting Portal
Enabling TLS
Kyvos Reporting Java Options Configuration
Kyvos Reporting Integration with Kyvos

Installing Fonts for specific types of reports

To use the export feature of Kyvos Reporting's Smart Report, Adhoc Report, and Studio Reports, you must install supported fonts on the machine where the Kyvos Reporting Service has been deployed.

Log in to your Linux machine.
Navigate to the /usr/share\ location and check the fonts folder. If the fonts folder is not present, execute the following commands to install the fonts:
sudo apt update sudo apt install fontconfig sudo apt install ttf-mscorefonts-installer sudo fc-cache -f -v

Note

In case fonts installation failed, copy the fonts available on Kyvos Reporting setup to the machine’s, where the Kyvos Reporting Service has been deployed, fonts folder.
To do this, execute the following commands:
sudo cp <installation directory>/kyvos/approger/KyvosReporting/reportengine/fonts/*.ttf /usr/share/fonts/truetype/
sudo fc-cache -f -v
Restart Kyvos Reporting portal and Reporting Server services.

Repository Connection Setup

To set up a repository connection, select the Is Repository checkbox on the Connection page to use this connection as the application's default repository to fetch and store metadata. For further details about other common properties while making a connection, see Intellicus documentation.

Any RDBMS database—Postgres, MSSQL, ORACLE, or MYSQL—can be used as a Repository in Kyvos reporting. A fresh database running on the same server or a different server (accessible by the Kyvos Reporting node) is required.

Note

After installing Kyvos Reporting Service, the DemoRepositoryDB is set as the default repository. To use a PostgreSQL connection as a repository, create a repository connection on the Kyvos Reporting Connection page. After creating a connection, restart the Kyvos Reporting Service node via Kyvos Manager.

Kyvos Connection Setup

To connect to Kyvos semantic models and fetch data for reporting, you must set up a Kyvos connection. This will enable you to process large amounts of data and create multi-dimensional reports. For further details about setting up a Kyvos connection, see Intellicus documentation.

Note

Kyvos supports both MDX and SQL queries. However, for Kyvos Reporting using Kyvos semantic models, only SQL queries will function with the Kyvos Reporting Query Object as it uses SQL based JDBC connection, which exclusively supports SQL queries.

Creating a secured Kyvos connection with Kyvos Reporting Portal

Establish a Kyvos connection in Kyvos Reporting Portal: When using Kyvos 2024.2, you must perform manual steps to create a Kyvos connection in the Kyvos Reporting Portal.
Uploading Hive Jars for Kyvos connection creation in Kyvos Reporting Portal: When using Kyvos releases earlier to Kyvos 2024.2, you must first upload Hive Jars at the Kyvos Reporting Portal and then create a Kyvos connection in the Kyvos Reporting Portal.

Establish a Kyvos connection in Kyvos Reporting Portal

After deploying Kyvos Reporting Service node, if Kyvos and Kyvos Reporting are running in secured (HTTPS mode), in this case you need to establish a Kyvos connection in Kyvos Reporting Portal. To do this, you need to perform the following manual steps.