ServiceNow Query Authentication

ServiceNow Query Authentication


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the ServiceNow Query connector for use in Matillion ETL.

Important Information

  • The ServiceNow Query connector uses an OAuth for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. In Matillion ETL, on the top left corner of the screen, click ProjectManage OAuth.

    Please Note

    If a ServiceNow Query connector has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:

    1. Click the connector icon to open the Properties panel at the bottom of the screen.
    2. Click ... next to the Authentication input, and finally click Manage in the pop-up window.
    Project dropdown menu

    Project dropdown menu

  2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

  3. Click + in the bottom left corner of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth Entry

  4. Click on the Service dropdown menu and select ServiceNow. Then, provide a name for the OAuth in the Name field and click OK.

    Create OAuth Entry window

    Create OAuth Entry window

  5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

    Please Note

    This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

    OAuth Entry list

    New Entry listed on Manage OAuth window


Acquiring Third-Party Credentials

  1. Navigate to the ServiceNow Developers portal. Click Log In on the right of the header menu. The browser will then redirect to a login screen. Enter valid credentials to continue. Log in to ServiceNow Developers portal

    Log in to ServiceNow Developers portal

  2. Next, click ManageInstance on the header menu.

    Manage Instance

    Manage Instance

  3. Now, on the My Instance page, click the instance URL.

    My Instance

    My Instance

  4. The browser will redirect to a login screen. Enter valid credentials for instance and click Login.

    Please Note

    Take note of the username and password used to log in to the instance, as well as the instance name (the subdomain of the URL, i.e. subdomain.service-now.com) as they will required in configuring OAuth in Matillion ETL in Authorising for use in Matillion ETL.

    Log in to My Instance

    Log in to My Instance

  5. Once logged in, scroll down the sidebar menu on the left to System OAuth, then click Application Registry.

  6. In the Application Registry window, click New on the window header.

    Application Registry

    Application Registry

  7. Then, in the OAuth application window, click Create an OAuth API endpoint for external clients.

    Create OAuth API endpoint

    Create OAuth API endpoint

  8. This will open a "New record" and a new window. In this window, provide details for the following fields:

    • Name – provide a unique name for the app
    • Redirect URL – paste Callback URL (copied earlier from the Manage OAuth window from the Matillion ETL), then click Submit

    Please Note

    Before entering the Callback URL, Unlock will need to be clicked to reveal the field.

    Provide application details

    Provide application details

  9. The browser will return to the Application Registry window. Click the <Name of the newly created app> in the app list.

    Find newly created app on list

    Find newly created app on list

  10. Now, in the new app window, copy the Client ID and Client Secret as they will be required later during Authorizing for use in Matillion ETL.

    Please Note

    • Before the Client Secret can be copied, click Unlock to make it visible.
    • Additionally, when copying the codes, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
    Copy the Client ID and Client Secret

    Copy the Client ID and Client Secret


Authorising for Use in Matillion ETL

  1. Return to the Manage OAuth window on Matillion ETL and click next to the previously created OAuth entry. This will open the Configure OAuth window.

    Configure OAuth settings

    Configure OAuth settings

  2. Using the codes copied from the ServiceNow Developers portal earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings