ServiceNow Connector for SSISAllows 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. If you are new to SSIS and ZappySys SSIS PowerPack then check these links to get started:
|
Connect to ServiceNow in other apps
|
Video Tutorial - Integrate ServiceNow data in SSIS
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
ServiceNow integration in SSIS - How to configure connection for
ServiceNow - Features about
API Source (Authentication / Query Language / Examples / Driver UI) - Using
ServiceNow Connection in SSIS
Prerequisites
Before we perform steps listed in this article, you will need to make sure following prerequisites are met:- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
Read data from ServiceNow in SSIS (Export data)
In this section we will learn how to configure and use ServiceNow Connector in API Source to extract data from ServiceNow.
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Use a preinstalled ServiceNow Connector from Popular Connector List or press Search Online radio button to download ServiceNow Connector. Once downloaded simply use it in the configuration:
ServiceNow -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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.
Configuring authentication parameters
ServiceNowBasic 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.
Configuring authentication parameters
ServiceNowOAuth [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 -
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - 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. -
That's it! We are done! Just in a few clicks we configured the call to ServiceNow using ServiceNow Connector.
You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
Write data to ServiceNow using SSIS (Import data)
In this section we will learn how to configure and use ServiceNow Connector in the API Destination to write data to ServiceNow.
Video tutorial
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download SSIS PowerPack for
ServiceNow integration in SSIS - How to configure connection for
ServiceNow - How to write or lookup data to
ServiceNow - Features about SSIS API Destination
- Using
ServiceNow Connector in SSIS
Step-by-step instructions
In upper section we learned how to read data, now in this section we will learn how to configure ServiceNow in the API Source to POST data to the ServiceNow.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
-
Select New Connection to create a new connection:
API Destination - 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. -
Use a preinstalled ServiceNow Connector from Popular Connector List or press Search Online radio button to download ServiceNow Connector. Once downloaded simply use it in the configuration:
ServiceNow -
Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in 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.
Configuring authentication parameters
ServiceNowBasic 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.
Configuring authentication parameters
ServiceNowOAuth [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 -
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - 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. -
Finally, map the desired columns:
API Destination - 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. -
That's it; we successfully configured the POST API Call. In a few clicks we configured the ServiceNow API call using ZappySys ServiceNow Connector
Load ServiceNow data into SQL Server using Upsert Destination (Insert or Update)
Once you read data from the desired source, now let's see how to Load ServiceNow data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.
-
From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface
Connect our Source component to Upsert Destination
-
Double click on Upsert Destination component to configure it.
-
Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS -
Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
-
Click on OK to save Upsert Destination settings UI.
-
That's it. Run the SSIS Package and it will read the data from the ServiceNow and load the data in the SQL Server/PostgreSql/Redshift using Upsert Destination.
Deploy and schedule SSIS package
After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog) article to see how to do it.
Advanced topics
Actions supported by ServiceNow Connector
ServiceNow Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
SysId |
|
||||||||||
Query |
|
||||||||||
Fields |
|
Parameter | Description |
---|---|
SysId |
|
Parameter | Description |
---|---|
SysId |
|
Parameter | Description |
---|---|
TableName |
|
Parameter | Description |
---|---|
TableName |
|
Parameter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TableName |
|
||||||||||||||||||||||
SysId |
|
||||||||||||||||||||||
Fields |
|
||||||||||||||||||||||
Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list) |
|
||||||||||||||||||||||
Query / Order By (Server Side Filter) |
|
Parameter | Description |
---|---|
TableName |
|
Parameter | Description |
---|---|
TableName |
|
SysId |
|
Parameter | Description |
---|---|
TableName |
|
SysId |
|
Parameter | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Url |
|
||||||||||||||||||||||||||
Body |
|
||||||||||||||||||||||||||
IsMultiPart |
|
||||||||||||||||||||||||||
Filter |
|
||||||||||||||||||||||||||
Headers |
|
Parameter | Description |
---|---|
Url |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Conclusion
In this article we discussed how to connect to ServiceNow in SSIS and integrate data without any coding. Click here to Download ServiceNow Connector for SSIS and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download ServiceNow Connector for SSIS
Documentation
More integrations
Other application integration scenarios for ServiceNow
Other connectors for SSIS
Download ServiceNow Connector for SSIS
Documentation
How to connect ServiceNow in SSIS?
How to get ServiceNow data in SSIS?
How to read ServiceNow data in SSIS?
How to load ServiceNow data in SSIS?
How to import ServiceNow data in SSIS?
How to pull ServiceNow data in SSIS?
How to push data to ServiceNow in SSIS?
How to write data to ServiceNow in SSIS?
How to POST data to ServiceNow in SSIS?
Call ServiceNow API in SSIS
Consume ServiceNow API in SSIS
ServiceNow SSIS Automate
ServiceNow SSIS Integration
Integration ServiceNow in SSIS
Consume real-time ServiceNow data in SSIS
Consume real-time ServiceNow API data in SSIS
ServiceNow ODBC Driver | ODBC Driver for ServiceNow | ODBC ServiceNow Driver | SSIS ServiceNow Source | SSIS ServiceNow Destination
Connect ServiceNow in SSIS
Load ServiceNow in SSIS
Load ServiceNow data in SSIS
Read ServiceNow data in SSIS
ServiceNow API Call in SSIS