ServiceNow Connector for UiPathAllows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access. In this article you will learn how to quickly and efficiently integrate ServiceNow data in UiPath without coding. We will use high-performance ServiceNow Connector to easily connect to ServiceNow and then access the data inside UiPath. Let's follow the steps below to see how we can accomplish that! ServiceNow Connector for UiPath is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to ServiceNow in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from ServiceNow using UiPath we first need to create a DSN (Data Source) which will access data from ServiceNow. We will later be able to read data using UiPath. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys API Driver
ZappySys API Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "ServiceNow" from the list of Popular Connectors. If "ServiceNow" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ServicenowDSNServiceNow -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Authenticate using ServiceNow instance username and password.
Steps how to get and use ServiceNow credentials
Locate your ServiceNow instance credentials and use them for HTTP authentication:
- Go to https://developer.servicenow.com/dev.do and log in.
- Click on your profile picture.
-
When a menu appears, click on Manage instance password or a similar option:
-
In a new window you will see your HTTP Basic Authentication credentials:
-
Done! Use this username and password when configuring OAuth Authentication parameters.
Fill in all required parameters and set optional parameters if needed:
ServicenowDSNServiceNowBasic Auth [Http]https://[$InstanceName$].service-now.com/api/nowRequired Parameters InstanceName Fill-in the parameter... User name Fill-in the parameter... Password Fill-in the parameter... Optional Parameters ApiVersion v2 RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True Authenticate using ServiceNow instance username, password, OAuth Client ID, and Client Secret. [API reference]
Steps how to get and use ServiceNow credentials
Create OAuth application and use it for authentication:
- Login to your instance at https://your-instance-id.service-now.com.
-
Start by clicking on menu item All, then search for oauth, and click Application Registry option:
-
Then click button New:
-
Continue by clicking Create an OAuth API endpoint for external clients option:
-
Move on by naming your OAuth application and entering a Client Secret (or let it be generated automatically).
-
Finally give it a final touch by increasing the Refresh Token Lifespan value to
315,360,000
(it should last for 10 years): -
Done! Now you can use Client ID and Client Secret when configuring OAuth Authentication parameters.
Fill in all required parameters and set optional parameters if needed:
ServicenowDSNServiceNowOAuth [OAuth]https://[$InstanceName$].service-now.com/api/nowRequired Parameters InstanceName Fill-in the parameter... User name Fill-in the parameter... Password Fill-in the parameter... Client ID Fill-in the parameter... Client Secret Fill-in the parameter... ApiVersion Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503 RetryCountMax 5 RetryMultiplyWaitTime True -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ServiceNowAllows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access.ServicenowDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in UiPath to retrieve data from ServiceNow. Hit OK button to use this query in the next step.
SELECT * FROM incident --Using Primary Key --SELECT * FROM any_table_here WHERE sys_id='109562a3c611227500a7b7ff98cc0dc7' --Primary Key in WHERE clause --Using Filter Expression --SELECT * FROM incident WITH(Query='number=INC0000001') --Equal condition --SELECT * FROM incident WITH(Query='number!=INC0000001') --Not equal condition --SELECT * FROM incident WITH(Query='numberININC0000001,INC0000002,INC0000003') --IN condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7') --AND condition --SELECT * FROM incident WITH(Query='number=INC0000001^ORnumber=INC0000002') --OR condition --SELECT * FROM incident WITH(Query='numberLIKE0001') --LIKE condition --SELECT * FROM incident WITH(Query='numberSTARTSWITHINC00') --StartWith condition --SELECT * FROM incident WITH(Query='numberENDSWITH0001') --StartWith condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7^NQORnumber=INC0000002') --AND / OR MIXED using NQ (NewQuery Operator) -- (number=INC0000001 and state=7) OR (number=INC0000002) --more information about filter here https://docs.servicenow.com/bundle/utah-platform-user-interface/page/use/common-ui-elements/reference/r_OpAvailableFiltersQueries.html -- To read all available tables execute this query: -- SELECT * FROM Tables -- Other common tables: ----------------------- -- SELECT * FROM sys_db_object -- SELECT * FROM sys_dictionary -- SELECT * FROM sys_user -- SELECT * FROM sys_user_has_role -- SELECT * FROM sys_user_grmember -- SELECT * FROM task -- SELECT * FROM task_sla -- SELECT * FROM incident -- SELECT * FROM incident_sla -- SELECT * FROM change_request -- SELECT * FROM cmdb_ci_computer -- SELECT * FROM cmdb_ci_outage -- SELECT * FROM cmdb_ci -- SELECT * FROM sn_customerservice_case -- SELECT * FROM kb_knowledge -- SELECT * FROM kb_use -- SELECT * FROM sc_req_item -- SELECT * FROM sc_request -- SELECT * FROM sc_task
Some parameters configured in this window will be passed to the ServiceNow API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in UiPath:
ZappySys API Driver - ServiceNowAllows the reading and writing of incidents, attachments, and more in ServiceNow without coding! The ZappySys ServiceNow API Connector provides easy-to-use, high-performance API access.ServicenowDSNSELECT * FROM incident --Using Primary Key --SELECT * FROM any_table_here WHERE sys_id='109562a3c611227500a7b7ff98cc0dc7' --Primary Key in WHERE clause --Using Filter Expression --SELECT * FROM incident WITH(Query='number=INC0000001') --Equal condition --SELECT * FROM incident WITH(Query='number!=INC0000001') --Not equal condition --SELECT * FROM incident WITH(Query='numberININC0000001,INC0000002,INC0000003') --IN condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7') --AND condition --SELECT * FROM incident WITH(Query='number=INC0000001^ORnumber=INC0000002') --OR condition --SELECT * FROM incident WITH(Query='numberLIKE0001') --LIKE condition --SELECT * FROM incident WITH(Query='numberSTARTSWITHINC00') --StartWith condition --SELECT * FROM incident WITH(Query='numberENDSWITH0001') --StartWith condition --SELECT * FROM incident WITH(Query='number=INC0000001^state=7^NQORnumber=INC0000002') --AND / OR MIXED using NQ (NewQuery Operator) -- (number=INC0000001 and state=7) OR (number=INC0000002) --more information about filter here https://docs.servicenow.com/bundle/utah-platform-user-interface/page/use/common-ui-elements/reference/r_OpAvailableFiltersQueries.html -- To read all available tables execute this query: -- SELECT * FROM Tables -- Other common tables: ----------------------- -- SELECT * FROM sys_db_object -- SELECT * FROM sys_dictionary -- SELECT * FROM sys_user -- SELECT * FROM sys_user_has_role -- SELECT * FROM sys_user_grmember -- SELECT * FROM task -- SELECT * FROM task_sla -- SELECT * FROM incident -- SELECT * FROM incident_sla -- SELECT * FROM change_request -- SELECT * FROM cmdb_ci_computer -- SELECT * FROM cmdb_ci_outage -- SELECT * FROM cmdb_ci -- SELECT * FROM sn_customerservice_case -- SELECT * FROM kb_knowledge -- SELECT * FROM kb_use -- SELECT * FROM sc_req_item -- SELECT * FROM sc_request -- SELECT * FROM sc_task
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the ServiceNow API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in ServiceNow servers). -
Click OK to finish creating the data source.
Video Tutorial
Read ServiceNow data in UiPath Studio (workstation)
Here we will be reading ServiceNow data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!
- Open UiPath Studio.
- Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
-
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:
Simply select UiPath Studio option:
-
Start by creating a new project based on UiPath Process template:
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
ServicenowDSNServicenowDSNYou can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
-
Once you do that, it's time to configure a SQL query:
Make sure, you enclose the query in double quotes!
-
Proceed by adding a Write CSV activity after Run Query:
In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
-
Once you do that, configure the added Write CSV, this will write ServiceNow data to a CSV file:
-
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
-
Finally, ensure there are no execution errors!
Run UiPath package using Orchestrator (via robot)
UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!
Publish process package from UiPath Studio
- First of all, open the UiPath process package we created in the previous step
-
Set the option that our process package Starts in Background:
-
We are ready to Publish it:
-
Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
-
Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:
Create robot in UiPath Orchestrator
-
First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
-
It's time to create a robot, which will run unattended packages:
-
But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
-
Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
-
Configure the machine to run in Production environment:
-
We are ready to Create new robot account in the new machine:
-
Let's make our robot to work only on background automations:
-
Continue by selecting newly created robot:
-
Select Shared folder, so that everyone in the team can benefit from it:
This is the folder where we published our UiPath process package "MyProcess"
-
We are almost done!
We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator.
Let's leave this open for a while and see how we can do it in the next step.
Connect UiPath Assistant to Orchestrator
We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!
- Connect to a remote machine (where your UiPath process package will be running).
- Install UiPath Studio there.
- Then configure ODBC data source:
If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.
Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.
-
Continue by opening UiPath Assistant and going to Preferences:
-
Find Orchestrator Settings menu item and click it:
-
And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
-
Finally, we get rewarded for the hard work with the Connected as Unattended status:
Create and run UiPath process in Orchestrator
We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.
- First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
-
Then proceed by going to Process in Shared folder:
-
Continue by simply clicking on Add process button:
-
Select the process package we created in UiPath Studio:
-
Rest a while, and just hit Next, unless your package has requirements:
-
Then simply hit Create button:
-
But let's not stop here and Start the process by creating a job right away:
-
Use the same Production runtime we created before and hit Start:
-
We've reached the final step! In the CSV destination file or destination of your choice you should see ServiceNow data:
Actions supported by ServiceNow Connector
Learn how to perform common ServiceNow actions directly in UiPath with these how-to guides:
- Delete a Table Row
- Delete table row
- Get List of System Tables - Admin (Use sys_db_object)
- Get List of Tables
- Get List of Tables - Admin (Use sys_db_object)
- Get List of User Tables - Admin (Use sys_db_object)
- Get Table Columns
- Get Table Columns - Admin (Use sys_dictionary)
- Get Table Rows
- Update a Table Row
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to ServiceNow in UiPath and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to ServiceNow, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download ServiceNow Connector for UiPath and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download ServiceNow Connector for UiPath Documentation
More integrations
Other connectors for UiPath
Other application integration scenarios for ServiceNow
How to connect ServiceNow in UiPath?
How to get ServiceNow data in UiPath?
How to read ServiceNow data in UiPath?
How to load ServiceNow data in UiPath?
How to import ServiceNow data in UiPath?
How to pull ServiceNow data in UiPath?
How to push data to ServiceNow in UiPath?
How to write data to ServiceNow in UiPath?
How to POST data to ServiceNow in UiPath?
Call ServiceNow API in UiPath
Consume ServiceNow API in UiPath
ServiceNow UiPath Automate
ServiceNow UiPath Integration
Integration ServiceNow in UiPath
Consume real-time ServiceNow data in UiPath
Consume real-time ServiceNow API data in UiPath
ServiceNow ODBC Driver | ODBC Driver for ServiceNow | ODBC ServiceNow Driver | SSIS ServiceNow Source | SSIS ServiceNow Destination
Connect ServiceNow in UiPath
Load ServiceNow in UiPath
Load ServiceNow data in UiPath
Read ServiceNow data in UiPath
ServiceNow API Call in UiPath