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 →
Use JayDeBeApi to access ServiceNow Data in Python
Use standard Python scripting and the development environment of your choice to access live ServiceNow data.
Access ServiceNow data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for ServiceNow and the JayDeBeApi module to work with remote ServiceNow data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to ServiceNow and visualize ServiceNow data with standard Python.
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
Use the JayDeBeApi module
JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:
pip install JayDeBeApi
Create the JDBC URL
Once you have JayDeBeApi installed, you are ready to work with ServiceNow data in Python using SQL.
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.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the ServiceNow JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.servicenow.jar
Fill in the connection properties and copy the connection string to the clipboard.
Below is a sample variable assignment, including a typical JDBC connection string:
jdbc_url = "jdbc:servicenow:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Username=MyUsername;Password=MyPassword;Instance=MyInstance;InitiateOAuth=GETANDREFRESH"
Access ServiceNow data in Python
With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.servicenow.jar" on Windows).
NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.
Use code similar to the follow to read and print data from ServiceNow:
import jaydebeapi
#The JDBC connection string
jdbc_url = "jdbc:servicenow:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Username=MyUsername;Password=MyPassword;Instance=MyInstance;InitiateOAuth=GETANDREFRESH"
username = "****"
password = "****"
#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.servicenow.jar"
conn = jaydebeapi.connect(
"cdata.jdbc.servicenow.ServiceNowDriver",
jdbc_url,
[username, password],
jdbc_driver_jar,
)
cursor = conn.cursor()
cursor.execute("SELECT * FROM incident;")
results = cursor.fetchall()
for row in results:
print(row)
cursor.close()
conn.close()
Free trial & more information
Download a free, 30-day trial of the CData JDBC Driver for ServiceNow and start working with your live ServiceNow data in Python. Reach out to our Support Team if you have any questions.
Ready to get started?
Download a free trial of the ServiceNow Driver to get started:
Download NowLearn more:
ServiceNow JDBC Driver
Rapidly create and deploy powerful Java applications that integrate with ServiceNow data includingSchedules, Timelines, Questions, Syslogs, and more!
