Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
How to use SQLAlchemy ORM to access ServiceNow Data in Python
Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of ServiceNow data.
The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for ServiceNow and the SQLAlchemy toolkit, you can build ServiceNow-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to ServiceNow data to query ServiceNow data.
With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live ServiceNow data in Python. When you issue complex SQL queries from ServiceNow, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to ServiceNow and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).
About ServiceNow Data Integration
CData simplifies access and integration of live ServiceNow data. Our customers leverage CData connectivity to:
- Get optimized performance since CData uses the REST API for data and the SOAP API for schema.
- Read, write, update, and delete ServiceNow objects like Schedules, Timelines, Questions, Syslogs and more.
- Use SQL stored procedures for actions like adding items to a cart, submitting orders, and downloading attachments.
- Securely authenticate with ServiceNow, including basic (username and password), OKTA, ADFS, OneLogin, and PingFederate authentication schemes.
Many users access live ServiceNow data from preferred analytics tools like Tableau, Power BI, and Excel, and use CData solutions to integrate ServiceNow data with their database or data warehouse.
Getting Started
Connecting to ServiceNow Data
Connecting to ServiceNow 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.
ServiceNow uses the OAuth 2.0 authentication standard. To authenticate using OAuth, you will need to register an OAuth app with ServiceNow to obtain the OAuthClientId and OAuthClientSecret connection properties. In addition to the OAuth values, you will need to specify the Instance, Username, and Password connection properties.
See the "Getting Started" chapter in the help documentation for a guide on connecting to ServiceNow.
Follow the procedure below to install SQLAlchemy and start accessing ServiceNow 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 ServiceNow Data in Python
You can now connect with a connection string. Use the create_engine function to create an Engine for working with ServiceNow 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("servicenow:///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&Username=MyUsername&Password=MyPassword&Instance=MyInstance&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Declare a Mapping Class for ServiceNow 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 incident 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 incident(base):
__tablename__ = "incident"
sys_id = Column(String,primary_key=True)
priority = Column(String)
...
Query ServiceNow 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("servicenow:///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&Username=MyUsername&Password=MyPassword&Instance=MyInstance&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(incident).filter_by(category="request"):
print("sys_id: ", instance.sys_id)
print("priority: ", instance.priority)
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
incident_table = incident.metadata.tables["incident"]
for instance in session.execute(incident_table.select().where(incident_table.c.category == "request")):
print("sys_id: ", instance.sys_id)
print("priority: ", instance.priority)
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 Python Connector for ServiceNow to start building Python apps and scripts with connectivity to ServiceNow data. Reach out to our Support Team if you have any questions.
Ready to get started?
Download a free trial of the ServiceNow Connector to get started:
Download NowLearn more:
ServiceNow Python Connector
Python Connector Libraries for ServiceNow Data Connectivity. Integrate ServiceNow with popular Python tools like Pandas, SQLAlchemy, Dash & petl.
