ServiceNow Connector
Documentation
Version: 1
Documentation

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