Connect to Halo Service Desk Data in Claris FileMaker Pro

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use the CData API Driver for ODBC in FileMaker Pro to connect to Halo Service Desk and work with Halo Service Desk data in your FileMaker applications.

Claris FileMaker is a low-code database application development tool that allows users to create custom apps for managing and organizing data. It combines a powerful relational database engine with an intuitive interface, enabling both technical and non-technical users to design and deploy applications across desktop, web, and mobile platforms.

In this article, we'll explore how to use the CData API Driver for ODBC in FileMaker to connect to Halo Service Desk data.

Create an ODBC Data Source for Halo Service Desk

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

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.

Connect and sync Halo Service Desk data with FileMaker using the CData API Driver for ODBC

Once you configure the CData API Driver for ODBC, you can connect to live Halo Service Desk data in FileMaker and use it in your applications. In this section, we'll walk through the steps to connect live Halo Service Desk data to FileMaker.

You can download and install the latest version of FileMaker Pro for your Mac/Windows/Linux systems here: https://www.claris.com/resources/downloads/.

Importing Halo Service Desk data using FileMaker's ODBC Import Function

Follow the steps below to easily import Halo Service Desk data using the ODBC import feature:

  1. Open FileMaker Pro. Navigate to Create from the left panel and select Blank > Create.
  2. Create a new application in FileMaker
  3. Enter a desired filename and click Save.
  4. In the Manage Database window, go to the Tables tab and create or rename the table where you want to display Halo Service Desk data.
  5. Create or edit a table.
  6. In the Fields tab, add the required fields to the table.
  7. Create the fields for the table.
  8. In the Relationships tab, define table relationships if your database has multiple tables, then click OK.
  9. To reopen and modify the table structure later, go to File > Manage > Database.
  10. To import Halo Service Desk data via the CData API Driver for ODBC, navigate to File > Import Records > ODBC Data Source.
  11. Select ODBC Data Source from Import Records.
  12. In the Select ODBC Data Source window, choose CData API Driver for ODBC and click Create. Enter your Halo Service Desk username and password, then click OK.
  13. Select CData API Sys. Enter the Halo Service Desk username and password.
  14. In the SQL Query Builder window, select the desired table from the Tables section and choose the relevant columns from the Columns section. Click Insert into SQL Query after each selection to automatically generate a query that retrieves data from Halo Service Desk. You can also manually edit the query using WHERE and ORDER BY clauses or use the tabs provided in the SQL Query Builder. Click Execute to run the query.
  15. Choose the columns to generate the SQL Query.
  16. In the Specify Import Order window, define the import order for the target fields. Select Add between source and target to add new records to the target table from the selected fields. Click Import.
  17. Specify the import order.

You have now successfully imported Halo Service Desk data into FileMaker Pro using the CData API Driver for ODBC. To perform incremental updates, change the import order to "Update" or use "Replace" based on your use case.

Process Halo Service Desk data at design time

You can sort and aggregate data, as well as calculate summary functions while browsing tables. To manipulate the view of data at design time, complete the following steps:

  • Switch to Preview Mode: Click the Preview at the top to check how the Halo Service Desk data with look before you print it.
  • Switch to Table View: Click the table icon in the View As menu in the main toolbar of the application.
The Halo Service Desk data is displayed in FileMaker Pro.

Aggregate and summarize

Follow the steps below to group column values and display summaries, as shown in the screenshot:

  • Sort: Click the arrow in the NumberOfEmployees column header and choose Sort Ascending from the menu.
  • Group: In the same menu, click Add Trailing Group by Industry to group the values and insert a summary row. Alternatively, click Add Leading Group to add a summary row at the beginning.
  • Summarize: Select a summary option from the Trailing Subtotals menu for a grouped column.
Select the Trailing Subtotals.

Create a bar chart

Use the following steps to create a simple bar chart showing the total NumberOfEmployees for each Industry:

  1. Click the arrow in the NumberOfEmployees column header and select Chart by NumberOfEmployees.
    • If you've already grouped the table by a column (e.g., Industry), you can chart NumberOfEmployees by that column.
    Create the chart from Halo Service Desk data.
  2. In the Chart Setup window:
    • Click the button next to the Data box to add the x-axis column.
    • Choose the appropriate column in the dialog that appears.
    • For the y-axis, select a summary option from the Summary menu.
The chart is displayed based on the inputs given.

Get Started Today

Download a free 30-day trial of the CData API Driver for ODBC to integrate Halo Service Desk data into Claris FileMaker and work with Halo Service Desk data in your FileMaker applications.

Reach out to our Support Team if you have any questions.

Ready to get started?

Connect to live data from Halo Service Desk with the API Driver

Connect to Halo Service Desk