Manage Halo Service Desk Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Halo Service Desk seamlessly integrates Halo Service Desk data into database management tools like DBArtisan by enabling you to access Halo Service Desk data as a database. This article shows how to create a JDBC source for Halo Service Desk in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Halo Service Desk Data into DBArtisan Projects

Follow the steps below to register Halo Service Desk data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Halo Service Desk data. Halo Service Desk entities are displayed in the Datasource Explorer.

You can now work with Halo Service Desk data as you work with any other database. See the driver help documentation for more information on the queries supported by the Halo Service Desk API.