Use the CData ODBC Driver for Halo Service Desk in MicroStrategy Desktop

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When paired with the CData ODBC Driver for Halo Service Desk, you gain database-like access to live Halo Service Desk data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding Halo Service Desk as a data source in MicroStrategy Desktop and creating a simple visualization of Halo Service Desk data.

The CData ODBC Driver offers unmatched performance for interacting with live Halo Service Desk data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Halo Service Desk, the driver pushes supported SQL operations, like filters and aggregations, directly to Halo Service Desk and utilizes the embedded SQL Engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Halo Service Desk data using native MicroStrategy data types.

Connect to Halo Service Desk as an ODBC Data Source

Information for connecting to Halo Service Desk follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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

When you configure the DSN, 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.

Windows

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.

Linux

If you are installing the CData ODBC Driver for Halo Service Desk in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Sys]
Driver = CData ODBC Driver for Halo Service Desk
Description = My Description
Profile = C:\profiles\HaloServiceDesk.apip
AuthScheme = APIKey
ProfileSettings = 'APIKey = your_api_key
Domain = yourcompany.haloservicedesk.com'

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Connect to and Visualize Halo Service Desk Data using MicroStrategy Desktop

In addition to connecting Halo Service Desk in MicroStrategy enterprise products, you can connect to Halo Service Desk in MicroStrategy Desktop. Follow the steps below to add Halo Service Desk data as a dataset and create visualizations and reports of Halo Service Desk data.

1. Open MicroStrategy Desktop and create a new dossier.
2. In the datasets panel, click New Data, select Databases, and select Type a Query as the Import Option.
3. Add a new data source and choose DSN data sources.
4. Choose the DSN you previously configured (likely CData API Sys) and select Generic DBMS in the Version menu.
5. Set the User and Password properties for the DSN (or use placeholder values) and name the data source.

6. Select the new database instance to view the tables. You may need to manually click the search icon in the Available Tables section to see the tables.
7. Create a SQL query for the Halo Service Desk data (see below) and click Execute SQL to test the query.

   
   SELECT * FROM Assets
   

   NOTE: Since we create a live connection, we can execute a SELECT * query and utilize the filtering and aggregation features native to the MicroStrategy products.
8. Click Finish and choose to connect live.
9. Choose a visualization, choose fields to display (data types are discovered automatically through dynamic metadata discovery) and apply any filters to create a new visualization of Halo Service Desk data. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Halo Service Desk, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL Engine embedded in the driver.
10. Once you are finished configuring the dossier, click File -> Save.

Using the CData ODBC Driver for Halo Service Desk in MicroStrategy Desktop, you can easily create robust visualizations and reports on Halo Service Desk data. Read our other articles on connecting to Halo Service Desk in MicroStrategy and connecting to Halo Service Desk in MicroStrategy Web for more examples.