Build Halo Service Desk-Connected ETL Processes in Google Data Fusion

Google Data Fusion allows users to perform self-service data integration to consolidate disparate data. Uploading the CData API Driver for JDBC enables users to access live Halo Service Desk data from within their Google Data Fusion pipelines. While the CData JDBC Driver enables piping Halo Service Desk data to any data source natively supported in Google Data Fusion, this article explains how to pipe data from Halo Service Desk to Google BigQuery,

Upload the CData API Driver for JDBC to Google Data Fusion

Upload the CData API Driver for JDBC to your Google Data Fusion instance to work with live Halo Service Desk data. Due to the naming restrictions for JDBC drivers in Google Data Fusion, create a copy or rename the JAR file to match the following format driver-version.jar. For example: cdataapi-2020.jar

1. Open your Google Data Fusion instance
2. Click the to add an entity and upload a driver
3. On the "Upload driver" tab, drag or browse to the renamed JAR file.
4. On the "Driver configuration" tab:
   • Name: Create a name for the driver (cdata.jdbc.api) and make note of the name
   • Class name: Set the JDBC class name: (cdata.jdbc.api.APIDriver)
   
5. Click "Finish"

Connect to Halo Service Desk Data in Google Data Fusion

With the JDBC Driver uploaded, you are ready to work with live Halo Service Desk data in Google Data Fusion Pipelines.

1. Navigate to the Pipeline Studio to create a new Pipeline
2. From the "Source" options, click "Database" to add a source for the JDBC Driver
3. Click "Properties" on the Database source to edit the properties

   NOTE: To use the JDBC Driver in Google Data Fusion, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

   • Set the Label
   • Set Reference Name to a value for any future references (i.e.: cdata-api)
   • Set Plugin Type to "jdbc"
   • Set Connection String to the JDBC URL for Halo Service Desk. For example:
     
     jdbc:api:RTK=5246...;Profile=C:\profiles\HaloServiceDesk.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Domain=yourcompany.haloservicedesk.com';

     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.

     
   • Set Import Query to a SQL query that will extract the data you want from Halo Service Desk, i.e.:
     SELECT * FROM Assets
   
4. From the "Sink" tab, click to add a destination sink (we use Google BigQuery in this example)
5. Click "Properties" on the BigQuery sink to edit the properties
   • Set the Label
   • Set Reference Name to a value like api-bigquery
   • Set Project ID to a specific Google BigQuery Project ID (or leave as the default, "auto-detect")
   • Set Dataset to a specific Google BigQuery dataset
   • Set Table to the name of the table you wish to insert Halo Service Desk data into
   

With the Source and Sink configured, you are ready to pipe Halo Service Desk data into Google BigQuery. Save and deploy the pipeline. When you run the pipeline, Google Data Fusion will request live data from Halo Service Desk and import it into Google BigQuery.

While this is a simple pipeline, you can create more complex Halo Service Desk pipelines with transforms, analytics, conditions, and more. Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Halo Service Desk data in Google Data Fusion today.