Connect to Halo Service Desk Data in DBArtisan

The CData ODBC 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 an data source for Halo Service Desk in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Halo Service Desk Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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).

You can then 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 ODBC.
3. Enter a name for the data source and select the DSN.
4. 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.