ServiceNow

Configure a ServiceNow connector in Dataworkz using OAuth to ingest incident and CMDB data.

This page describes the Dataworkz connector configuration required to access ServiceNow.

Steps to Create a ServiceNow Instance

If an instance already exists, skip this section and go to "Steps to Create a Service Now Connected App".

1. Go to developer.servicenow.com and click Sign In.

2. After logging in, click Request Instance to create a new instance.

3. Instance creation begins and takes some time to complete.

4. After the instance is created, a username and password are assigned. Copy these credentials and the instance URL for use in the Dataworkz configuration.

5. Click the Instance URL to open the private ServiceNow instance.

6. Set up two-factor authentication to log in to the private instance.

Steps to Create a ServiceNow Connected App

Follow the steps below to set up a private connected app for use in Dataworkz.

1. Go to your private ServiceNow instance (e.g., https://dev188373.service-now.com) and click the All menu option.

2. Search for User Administration and navigate to User Administration → Roles.

3. Create a new custom role.

4. Search for User Administration again and navigate to User Administration → Users.

5. Create a new user and save. Edit the user and assign both the custom role you created and the existing rest_service role.

6. Set the user password by generating a new password.

7. Elevate the logged-in user's role. Click the System Administration icon and select Elevate Role. This is required to allow updating the ACL (Access Control List).

8. Search for System Security and navigate to System Security → Access Control (ACL).

9. A New button appears below the system administrator icon.

10. Click New to create an ACL entry. Create one entry for each operation and entity (table) combination.

11. Create the following ACL entries for the Incident table:

    Operation	Type	Role
    read	record	dataworkz_integration_role
    write	record	dataworkz_integration_role
    create	record	dataworkz_integration_role

12. Search for Application Registry and open it.

13. On the Application Registry page, click New (top right corner) to create a new connected app.

14. Select Create an OAuth API endpoint for external clients (for older applications).

    1. If [Deprecated UI] Create an OAuth API endpoint for external clients is selected, a form appears in the following format.

       
    2. Set Client Type to Integration as a Service and Accessible from to All Application Scopes.

    3. Enter the following redirect URL for the private connected app: https://<Dataworkz application domain>/dataworkz-web/restApi/oauth/servicenow/get_oauth_token (alternatively, copy this from the Dataworkz ServiceNow configuration setup).

    4. Fill in the remaining details and submit. Edit the created app to retrieve the Client ID and Secret.

15. For a new app setup, use New Inbound Integration Experience.

    The New Inbound Integration Experience is the recommended approach for:

    • Server-to-server integrations

    • Token generation (client_credentials flow)

    • Calling ServiceNow REST APIs (Incident, User, CMDB, etc.)

    1. Click New Integration (top right corner).

    2. Select OAuth - Authorization code grant.

    3. Enter the connected app name and redirect URL. Check This is a public client if the client is to be used publicly (the client and server generate a verification code to produce the access token).

    4. Click Save to create the connected app.

16. Copy the Client ID, Secret, and Private Instance URL for use when configuring the connected app in Dataworkz.

Configure ServiceNow Connector in Dataworkz

1. Log in to the Dataworkz application.

2. Go to Configuration > SaaS Applications > ServiceNow.

3. Click the + icon to add a new configuration.

4. Enter the following information:

   1. Client ID — Client ID of the ServiceNow connected app

   2. Client Secret — Client secret of the ServiceNow connected app

   3. ServiceNow Instance URL — URL of the ServiceNow private instance

1. Custom app already created:

   1. Select Yes if the connected app has already been created.

   2. Select No. A screen with the redirect URL appears. Copy the redirect URL and complete the ServiceNow connected app setup.

2. Enter the Workspace name.

3. Enter the Collection name.

4. Select the appropriate Scope from the dropdown.

5. Click Save. Dataworkz prompts you for ServiceNow credentials. Use the username and password from step 4 of the ServiceNow instance setup. Click Login after entering credentials.

Dataworkz prompts you to allow connecting to the private instance. Allow this to complete the Dataworkz configuration for ServiceNow.

The newly created connector appears in the list of ServiceNow configurations.