ServiceNow Connector for 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.
You can use this connector to integrate ServiceNow data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download Documentation

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:
  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
  4. Optional (If you want to Deploy and Schedule ) - Deploy and Schedule SSIS Packages

How to 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.

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. 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
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. 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
    ServiceNow Connector Selection

  8. 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 to get ServiceNow Credentials

    To get your Instance name, Username and Password:

    1. Log in into your ServiceNow and go to https://developer.servicenow.com/dev.do.
    2. Click on your profile icon.
    3. Select your instance.
    4. Click on "Manage instance password" or similar link.
    5. In the opened page you should see Instance name, Username and Password.
    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...
    ApiVersion Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

    Authenticate using ServiceNow instance username, password and clientid, clientsecret [API Help..]

    Steps to get ServiceNow Credentials

    To get your OAuth client ID / ClientSecret perform the below steps:

    1. Login to your instance https://{your-instance-id}.service-now.com/.
    2. Click on All > System OAuth > Application Registry (or just search for "Application Registry" under All menu)
    3. You can also Navigate to "Application Registry" using this link (Replace your instance-id in link) https://{your-instance-id}.service-now.com/now/nav/ui/classic/params/target/oauth_entity_list.do.
    4. Click on "New" button (see top-right corner for most user) and select "Create an OAuth API endpoint for external clients".
    5. Fill out the form according to your requirement and click "Submit". If you are unsure then populating the "Name" field will suffice. Please note down the "Client ID" and "Client Secret" as they will be used later.
    6. Go back to Connection UI and enter your UserName, Password and ClientID, Secret.
    7. To create new User you can go to All > Organization > Users
    8. Click Test Connection.
    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 Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  9. 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.
    API Source - Select Endpoint

  10. 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)

    Execute Package - Reading data from ServiceNow and load into target

Load ServiceNow data in 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.

  1. From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface

  2. Connect our Source component to Upsert Destination

  3. Double click on Upsert Destination component to configure it.

  4. 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
    Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

  5. 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.
    SSIS SQL Upsert option

  6. Click on OK to save Upsert Destination settings UI.

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

    Execute Package - Reading data from API Source and load into target

Video Tutorial - Write or lookup data to ServiceNow using SSIS

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

How to write or lookup data to ServiceNow in SSIS (Import data)

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.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. 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.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. 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.
    API Destination - New Connection

  4. 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
    ServiceNow Connector Selection

  5. 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 to get ServiceNow Credentials

    To get your Instance name, Username and Password:

    1. Log in into your ServiceNow and go to https://developer.servicenow.com/dev.do.
    2. Click on your profile icon.
    3. Select your instance.
    4. Click on "Manage instance password" or similar link.
    5. In the opened page you should see Instance name, Username and Password.
    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...
    ApiVersion Fill in the parameter...
    Optional Parameters
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys Http Connection

    Authenticate using ServiceNow instance username, password and clientid, clientsecret [API Help..]

    Steps to get ServiceNow Credentials

    To get your OAuth client ID / ClientSecret perform the below steps:

    1. Login to your instance https://{your-instance-id}.service-now.com/.
    2. Click on All > System OAuth > Application Registry (or just search for "Application Registry" under All menu)
    3. You can also Navigate to "Application Registry" using this link (Replace your instance-id in link) https://{your-instance-id}.service-now.com/now/nav/ui/classic/params/target/oauth_entity_list.do.
    4. Click on "New" button (see top-right corner for most user) and select "Create an OAuth API endpoint for external clients".
    5. Fill out the form according to your requirement and click "Submit". If you are unsure then populating the "Name" field will suffice. Please note down the "Client ID" and "Client Secret" as they will be used later.
    6. Go back to Connection UI and enter your UserName, Password and ClientID, Secret.
    7. To create new User you can go to All > Organization > Users
    8. Click Test Connection.
    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 Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ZappySys OAuth Connection

  6. 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.
    API Destination - Select Endpoint

  7. 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.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the ServiceNow API call using ZappySys ServiceNow Connector

    Execute Package - Reading data from API Source and load into target

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
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.
Query Server side search 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
 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
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 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