Feed Halo Service Desk Data into FineReport

The CData JDBC Driver for Halo Service Desk fully implements the JDBC standard and can provide Halo Service Desk data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Halo Service Desk data as JDBC data source in FineReport and view Halo Service Desk data as a table in the Report Designer.

Set Up a JDBC Data Source of Halo Service Desk Data

Follow the instruction below to set Halo Service Desk data as a FineReport database connection.

1. Copy the cdata.jdbc.api.jar file from the lib folder in the CData JDBC Driver for Halo Service Desk installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.api.lic file as well.
2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

1. Database: Others
2. JDBC Driver: cdata.jdbc.api.APIDriver
3. URL: A standard JDBC connection string using semicolon-separated connection properties.

   Start by setting the Profile connection property to the location of the HaloServiceDesk Profile on disk (e.g. C:\profiles\HaloServiceDesk.apip). Next, set the ProfileSettings connection property to the connection string for HaloServiceDesk (see below).

   HaloServiceDesk API Profile Settings

   HaloServiceDesk uses API key authentication. You can find or create API keys in HaloServiceDesk under Administration > Integrations > Halo API.

   Set the following connection properties to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to the API key from your HaloServiceDesk account.
   • Domain: Set this to the hostname of your HaloServiceDesk instance (e.g. yourcompany.haloservicedesk.com).

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Halo Service Desk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

   
       jdbc:api:Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';
     


4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Halo Service Desk set up, you can use it as FineReport data source.

Select Halo Service Desk Data in the Report Designer.

1. Click to add a new template data set and select DB query to open the database query window.

2. Choose the JDBC connection that you created from the dropdown list.
3. The Halo Service Desk entities will appear as tables on the left pane.
4. Write a SELECT statement for the Halo Service Desk data tables and columns that you want to load.

5. Click preview and data is shown as table.

With these simple steps, Halo Service Desk can be used as a JDBC data source in FineReport.