Connect to Halo Service Desk Data in CloverDX (formerly CloverETL)

The CData JDBC Driver for Halo Service Desk enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Halo Service Desk as sources. In this article, you will use the JDBC Driver for Halo Service Desk to set up a simple transfer into a flat file. The CData JDBC Driver for Halo Service Desk enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Halo Service Desk as sources. In this article, you will use the JDBC Driver for Halo Service Desk to set up a simple transfer into a flat file.

Connect to Halo Service Desk as a JDBC Data Source

1. Create the connection to Halo Service Desk data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.api.jar file.
3. Enter 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.

   

   A typical JDBC URL is below:

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

Query Halo Service Desk Data with the DBInputTable Component

1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
2. In the DB connection property, select the Halo Service Desk JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT Id, InventoryNumber FROM Assets WHERE ClientId = '1'

Write the Output of the Query to a UniversalDataWriter

1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
3. Right-click the DBInputTable and then click Extract Metadata.
4. Connect the output port of the DBInputTable to the UniversalDataWriter.
5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Assets table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.