ServiceNow Connector for SSIS

In this article you will learn how to quickly and efficiently integrate ServiceNow data in SSIS without coding. We will use high-performance ServiceNow Connector to easily connect to ServiceNow and then access the data inside SSIS.

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

Let's follow the steps below to see how we can accomplish that!

Download Documentation

ServiceNow Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them).

Connect to ServiceNow in other apps

Connect to ServiceNow in SQL Server

Connect to ServiceNow in Power BI

Connect to ServiceNow in SSRS

Connect to ServiceNow in Informatica

Connect to ServiceNow in MS Access

Connect to ServiceNow in MS Excel

Connect to ServiceNow in SSAS

Connect to ServiceNow in C#

Connect to ServiceNow in Python

Connect to ServiceNow in JAVA

Connect to ServiceNow in Tableau

Connect to ServiceNow in SAP Crystal Reports

Connect to ServiceNow in Azure Data Factory (Pipeline)

Connect to ServiceNow in Azure Data Factory (SSIS)

Connect to ServiceNow in Talend Studio

Connect to ServiceNow in UiPath

Connect to ServiceNow in PowerShell

Connect to ServiceNow in ODBC

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

Watch this video on YouTube

Prerequisites

Before we begin, make sure the following prerequisites are met:

SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

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:
1. SSIS ToolBox on left side bar
2. Solution Explorer and Property Window on right bar
3. Control flow, data flow, event Handlers, Package Explorer in tab windows
4. 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.

Basic Auth [Http]

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

ServiceNow

Basic Auth [Http]

https://[$InstanceName$].service-now.com/api/now

Required 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

OAuth [OAuth]

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

ServiceNow

OAuth [OAuth]

https://[$InstanceName$].service-now.com/api/now

Required 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 - ServiceNow

Allows 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

Watch this video on YouTube

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 - ServiceNow

Allows 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

Basic Auth [Http]

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

ServiceNow

Basic Auth [Http]

https://[$InstanceName$].service-now.com/api/now

Required 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

OAuth [OAuth]

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

ServiceNow

OAuth [OAuth]

https://[$InstanceName$].service-now.com/api/now

Required 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 - ServiceNow

Allows 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 - ServiceNow

Allows 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 configured the data source, you can load ServiceNow data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
Connect your SSIS source component to Upsert Destination.
Double-click on Upsert Destination component to open configuration window.
Start by selecting the Action from the list.
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
Click OK to save the configuration.
Run the package and ServiceNow data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
Done!

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 this article:

How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog)

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Preparing ADF instance to use SSIS PowerPack

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.

Get List of Tables - Admin (Use sys_db_object)

Get a list of tables by quering sys_db_object. To read data from this object make sure user has read permission to this table. [ Read more... ]

Parameter

Description

SysId

Query

Option	Value
Filter by active status	active=true
Order By name column	ORDERBYname
Order By name column (Descending)	ORDERBYDESCname
Order By Multiple Fields (ASC + DESC)	ORDERBYcolumn1^ORDERBYDESCcolumn2

Fields

Get List of User Tables - Admin (Use sys_db_object)

Get a list of tables not created by 'system' user [ Read more... ]

Parameter	Description
SysId

Get List of System Tables - Admin (Use sys_db_object)

Get a list of tables created by 'system' user [ Read more... ]

Parameter	Description
SysId

Get Table Columns - Admin (Use sys_dictionary)

Get a list of columns by quering sys_dictionary. To read data from this table make sure user has read permission to sys_dictionary table. [ Read more... ]

Parameter	Description
TableName

Get List of Tables

Get a list of tables. [ Read more... ]

Get Table Columns

Get a list of columns of a table [ Read more... ]

Parameter	Description
TableName	Table name

Get Table Rows

Get table rows [ Read more... ]

Parameter

Description

TableName

Table name

SysId

Row 'sys_id'

Fields

Comma-separated field names you want to return in the response. E.g. sys_id,name,label,sys_name,sys_updated_on. Using this setting reduces the response size and speed up the processing.

Fields to include in response (Keep blank to get all fields -OR- Enter comma separated list)

Query / Order By (Server Side Filter)

Server side search / filter condition

Option	Value
Equal Example	numberISINC0000060
AND Example	category=software^category=hardware
OR Example	category=software^ORcategory=hardware
IN Example	categoryINsoftware,hardware
STARTSWITH Example	categorySTARTSWITHsoftware
NOT EQUAL Example	category!=software
Filter Condition AND Order By	category!=software^ORDERBYname
Order By name column	ORDERBYname
Order By name column (Descending)	ORDERBYDESCname
Order By Multiple Fields (ASC + DESC)	ORDERBYcolumn1^ORDERBYDESCcolumn2

Delete a Table Row

Insert a row into the table. [ Read more... ]

Parameter	Description
TableName	Table name

Update a Table Row

Insert a row into the table. [ Read more... ]

Parameter	Description
TableName	Table name
SysId	Row 'sys_id'

Delete table row

Delete the specified row in the table by row 'sys_id'. [ Read more... ]

Parameter	Description
TableName	Table name
SysId	Row 'sys_id'

Generic Request

This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [ Read more... ]

Parameter

Description

Url

API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains

Body

Request Body content goes here

IsMultiPart

Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle

Filter

Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract

Option	Value
No filter
Example1	$.store.books[*]
Example2 (Sections Under Books)	$.store.books[].sections[]
Example3 (Equals)	$.store.books[?(@author=='sam')]
Example4 (Equals - Any Section)	$..[?(@author=='sam')]
Example5 (Not Equals - Any Section)	$..[?(@author!='sam')]
Example6 (Number less than)	$.store.books[?(@.price<10)] Example7 (Regular Expression - Contains Pattern)=$.store.books[?(@author=~ /sam\|bob/ )]
Example8 (Regular Expression - Does Not Contain Pattern)	$.store.books[?(@author=~ /^((?!sam\|bob).)*$/ )]
Example9 (Regular Expression - Exact Pattern Match)	$.store.books[?(@author=~ /^sam\|bob$/ )]
Example10 (Regular Expression - Starts With)	$.store.books[?(@author=~ /^sam/ )]
Example11 (Regular Expression - Ends With)	$.store.books[?(@author=~ /sam$/ )]
Example12 (Between)	$.store.employees[?( @.hiredate>'2015-01-01' && @.hiredate<'2015-01-04' )]

Headers

Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Generic Request (Bulk Write)

This is a generic endpoint for bulk write purpose. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [ Read more... ]

Parameter	Description
Url	API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
IsMultiPart	Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter	Enter filter to extract array from response. Example: $.rows[] --OR-- $.customers[].orders[*]. Check your response document and find out hierarchy you like to extract
Headers	Headers for Request. To enter multiple headers use double pipe (\|\|) or new line after each {header-name}:{value} pair

Conclusion

In this article we showed you how to connect to ServiceNow in SSIS and integrate data without any coding, saving you time and effort. We encourage you to download ServiceNow Connector for SSIS 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 SSIS Documentation

More integrations

Other connectors for SSIS

Amazon Ads

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

OData

OneDrive

Outlook Mail (Office 365)

Power BI

SharePoint Online

Shopify

Smartsheet

Stripe

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for ServiceNow

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Download ServiceNow Connector for SSIS Documentation

Common Searches:

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