How to use SQLAlchemy ORM to access Halo Service Desk Data in Python

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData API Driver for Python and the SQLAlchemy toolkit, you can build Halo Service Desk-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Halo Service Desk data to query Halo Service Desk data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Halo Service Desk data in Python. When you issue complex SQL queries from Halo Service Desk, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Halo Service Desk and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Halo Service Desk Data

Connecting to Halo Service Desk data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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

Follow the procedure below to install SQLAlchemy and start accessing Halo Service Desk through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy
pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Model Halo Service Desk Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Halo Service Desk data.

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("api:///?Profile=C:\profiles\HaloServiceDesk.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_api_key&Domain=yourcompany.haloservicedesk.com'")

Declare a Mapping Class for Halo Service Desk Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Assets table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Assets(base):
	__tablename__ = "Assets"
	Id = Column(String,primary_key=True)
	InventoryNumber = Column(String)
	...

Query Halo Service Desk Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("api:///?Profile=C:\profiles\HaloServiceDesk.apip&AuthScheme=APIKey&ProfileSettings='APIKey=your_api_key&Domain=yourcompany.haloservicedesk.com'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Assets).filter_by(ClientId="1"):
	print("Id: ", instance.Id)
	print("InventoryNumber: ", instance.InventoryNumber)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Assets_table = Assets.metadata.tables["Assets"]
for instance in session.execute(Assets_table.select().where(Assets_table.c.ClientId == "1")):
	print("Id: ", instance.Id)
	print("InventoryNumber: ", instance.InventoryNumber)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to Halo Service Desk data. Reach out to our Support Team if you have any questions.