Java APIs (Kyvos Reporting)

Kyvos Reporting provides a set of Java APIs for performing administrative and reporting operations such as user management and report execution.

Required JAR Files

To use the Kyvos Reporting Java APIs, ensure the JAR files are available in the classpath of your Java application. These files are available at <KyvosReporting_Installation_Path>/APIs.

Initialization

Step 1: Configure `ReportClient.properties`

Create and configure a ReportClient.properties file, and ensure it is available in the Java classpath. This file holds configuration values for connecting with the Kyvos Reporting Report Engine.

For reference, refer to the ReportClient_Default.properties file at the path <Installation_Path>\Jakarta\webapps\kyvosreporting\client\config

Step 2: Initialize Report Client

Before using any Kyvos Reporting Java API, initialize the Report Client using the static method ReportClient.init().

Import Required Classes:

import com.intellica.client.init.ReportClient;
import java.io.FileInputStream;
import java.io.BufferedInputStream;
import java.io.InputStream;

Initialization Example:

InputStream is = new BufferedInputStream(new FileInputStream("C://client/config/ReportClient.properties"));
ReportClient.init(is);

Step 3: Set `INTERA_HOME`

Specify the log path by setting the INTERA_HOME property in ReportClient.properties.

Examples:

Absolute Path:
INTERA_HOME=C://client
Relative Path:
INTERA_HOME=../../../client
Relative path is evaluated from the jakarta/bin/ directory of your Kyvos Reporting installation.

User Context Initialization

To execute actions in Kyvos Reporting using Java APIs, a requestor user context must be initialized.

UserInfo Object

Create a UserInfo object to represent the user initiating the action.

Class: com.intellica.client.common.UserInfo

Attribute	Description

Attribute	Description
`userId`	User ID
`password`	Password
`orgID`	Organization ID
`sessionId`	Session ID
`securityDescriptor`	Security descriptor string
`customerId`	Customer ID (for service provider setup)
`location`	Location ID
`locale`	Locale setting
`dbName`	Database name

User ID, Password, and Org ID are mandatory when using Kyvos Reporting authentication.

Import Required Class:

import com.intellica.client.common.UserInfo;

Example:

UserInfo requestorUserInfo = new UserInfo("John", "getSecurePwd()", "Org1");

To perform administrative operations such as user management, the UserInfo must represent a user with admin rights in Kyvos Reporting.

Refer to the chapters below for more details.

User Management Java APIs