ServiceNow Connector for Azure Data Factory (Pipeline)

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.

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

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

Download Documentation

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from ServiceNow using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from ServiceNow. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:

  1. Download and install ODBC PowerPack.

  2. Open ODBC Data Sources (x64):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for 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.
    Azure Data Factory (Pipeline) uses a Service Account, when a solution is deployed to production environment, therefore for production environment you have to create and use a System DSN.
  4. 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:

    ServicenowDSN
    ServiceNow
    ODBC DSN Template Selection
  5. 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:

    1. Go to https://developer.servicenow.com/dev.do and log in.
    2. Click on your profile picture.
    3. When a menu appears, click on Manage instance password or a similar option:

      Manage instance password in ServiceNow
    4. In a new window you will see your HTTP Basic Authentication credentials:

      Use instance credentials to authenticate to ServiceNow
    5. Done! Use this username and password when configuring OAuth Authentication parameters.

    Fill in all required parameters and set optional parameters if needed:

    ServicenowDSN
    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
    ODBC DSN HTTP Connection Configuration

    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:

    1. Login to your instance at https://your-instance-id.service-now.com.
    2. Start by clicking on menu item All, then search for oauth, and click Application Registry option:

      Locate OAuth configuration in ServiceNow
    3. Then click button New:

      Create new OAuth application in ServiceNow
    4. Continue by clicking Create an OAuth API endpoint for external clients option:

      Use ServiceNow OAuth application for external clients
    5. Move on by naming your OAuth application and entering a Client Secret (or let it be generated automatically).

    6. Finally give it a final touch by increasing the Refresh Token Lifespan value to 315,360,000 (it should last for 10 years):

      Configure OAuth application in ServiceNow
    7. 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:

    ServicenowDSN
    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
    ODBC DSN Oauth Connection Configuration

  6. 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 - 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.
    ServicenowDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  7. 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 Azure Data Factory (Pipeline) 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
    Configure table/endpoint parameters in ODBC data source based on API Driver
    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 data much faster.
  8. 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 Azure Data Factory (Pipeline):

    ZappySys API Driver - 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.
    ServicenowDSN
    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
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole 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).
  9. Click OK to finish creating the data source.

Video Tutorial

Read data in Azure Data Factory (ADF) from ODBC datasource (ServiceNow)

  1. To start press New button:

    Create new Self-Hosted integration runtime
  2. Select "Azure, Self-Hosted" option:

    Create new Self-Hosted integration runtime
  3. Select "Self-Hosted" option:

    Create new Self-Hosted integration runtime
  4. Set a name, we will use "OnPremisesRuntime":

    Set a name for IR
  5. Download and install Microsoft Integration Runtime.

  6. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

    Copy/paste Authentication Key
  7. After finishing registering the Integration Runtime node, you should see a similar view:

    Check Integration Runtime node status
  8. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

    Integration Runtime status
  9. Go to Linked services section and create a new Linked service based on ODBC:

    Add new Linked service
  10. Select "ODBC" service:

    Add new ODBC service
  11. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    ServicenowDSN
    DSN=ServicenowDSN
    Configure new ODBC service
  12. For created ODBC service create ODBC-based dataset:

    Add new ODBC dataset
  13. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    Set source in Copy data
  14. Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:

    Set sink in Copy data
  15. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    Run the flow

Actions supported by ServiceNow Connector

Learn how to perform common ServiceNow actions directly in Azure Data Factory (Pipeline) with these how-to guides:

Conclusion

In this article we showed you how to connect to ServiceNow in Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) 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 Azure Data Factory (Pipeline) Documentation

More integrations

Other connectors for Azure Data Factory (Pipeline)

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for ServiceNow

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications

  • How to connect ServiceNow in Azure Data Factory (Pipeline)?

  • How to get ServiceNow data in Azure Data Factory (Pipeline)?

  • How to read ServiceNow data in Azure Data Factory (Pipeline)?

  • How to load ServiceNow data in Azure Data Factory (Pipeline)?

  • How to import ServiceNow data in Azure Data Factory (Pipeline)?

  • How to pull ServiceNow data in Azure Data Factory (Pipeline)?

  • How to push data to ServiceNow in Azure Data Factory (Pipeline)?

  • How to write data to ServiceNow in Azure Data Factory (Pipeline)?

  • How to POST data to ServiceNow in Azure Data Factory (Pipeline)?

  • Call ServiceNow API in Azure Data Factory (Pipeline)

  • Consume ServiceNow API in Azure Data Factory (Pipeline)

  • ServiceNow Azure Data Factory (Pipeline) Automate

  • ServiceNow Azure Data Factory (Pipeline) Integration

  • Integration ServiceNow in Azure Data Factory (Pipeline)

  • Consume real-time ServiceNow data in Azure Data Factory (Pipeline)

  • Consume real-time ServiceNow API data in Azure Data Factory (Pipeline)

  • ServiceNow ODBC Driver | ODBC Driver for ServiceNow | ODBC ServiceNow Driver | SSIS ServiceNow Source | SSIS ServiceNow Destination

  • Connect ServiceNow in Azure Data Factory (Pipeline)

  • Load ServiceNow in Azure Data Factory (Pipeline)

  • Load ServiceNow data in Azure Data Factory (Pipeline)

  • Read ServiceNow data in Azure Data Factory (Pipeline)

  • ServiceNow API Call in Azure Data Factory (Pipeline)