ServiceNow Configuration Management Database (CMDB) is a centralized repository that serves as a comprehensive data warehouse, organizing information about an IT environment. The CMDB clarifies the relationships between hardware, software components, and networks, enhancing configuration management. More information can be found at  ServiceNow CMDB webpage.

Integration Method: API

Tables: Device Inventory Info (5001), Software Inventory Info (5020)

List of events supported by this integration.

This integration supports the following versions

Prerequisites

1. Access to the ServiceNow CMDB Admin Role to create an OAuth API endpoint for external clients.

2. Access to the DataBee console.

Configuration Overview

1. Generate API credentials on the ServiceNow console with the required user roles.

   1. Create OAuth client application

   2. Create user

   3. Assign roles to user

2. Add the ServiceNow data feed integration in the DataBee console with the required API credentials.

ServiceNow Configuration

The scope is a mechanism to let an application request limited access to a user’s data. ServiceNow platform supports authentication scopes to allow admins to limit access of an OAuth client application to a specific REST API.

Create OAuth client application

1. Get the servicenow instance from the URL as highlighted below.

2. Navigate to All

   • In the search bar, enter System OAuth.

   • Navigate to System OAuth > Application Registry.

3. Click on the New button.

4. On the Interceptor page, click Create an OAuth API endpoint for external clients.

5. Fill in the required details in the form:

   • Name: Enter a unique name for OAuth client application.

   • Client ID: Automatically generated by the ServiceNow OAuth server.

   • Client Secret: Enter Client secret for the Oauth application or leave empty for auto generation

         Copy the Client ID and Client Secret for later use.

6. Click on the Submit button.

Create User

1. Navigate to All,

   1. In the search bar, enter User Administration.

   2. Navigate to User Administration > Users.

2. Click on the New button. The Create User form window will appear.

3. Fill in the required fields to create a user:

   1. User ID: Enter a unique username.

   2. First Name: Enter the user's first name.

   3. Last Name: Enter the user's last name.

   4. Time Zone: Set to GMT/UTC to ensure the API response includes GMT/UTC dates.

   5. Date Format: Set to System (yyyy-MM-dd).

   6. Active: Ensure the checkbox is selected.

   7. Locked Out: Ensure the checkbox is not selected.

The user must be active and not locked out to allow the instance to generate an access token for OAuth.

Copy the User ID and Password for later use.

Click the Submit button.

4. Search username for the “User ID” created in the previous step and click on it.

5. Click on the Set Password button.

6. Click on the Generate button and copy the password for later use.

7. Click on the Save Password button.

Assign roles to user

1. Go to Roles tab and click on Edit to assign roles to user.
    

2. In the search bar:

   1. Enter "ITIL" and click Add.

   2. Click the Save button.

DataBee Configuration

Use the saved client secret and key to configure DataBee. Detailed setup documentation can be found at https://docs.databee.buzz/docs/api-ingest

1. Login to the DataBee UI, navigate to Data > Data Feeds and click the Add New Data Feed button

2. Search for Servicenow CMDB and select it.

3. Click on the API Ingest button.

4. Enter basic contact information in the contact form and click on the Next button.

5. In the configuration page, enter the following:

   • API Base URL: Replace <instance> with your ServiceNow Instance.

   • Authorization Method: OAuth2

   • Username: Paste the User ID.

   • Password: Paste the Password .

   • Client Key: Paste the Client ID generated earlier in the ServiceNow Platform.

   • Client Secret: Paste the Client Secret generated earlier in the ServiceNow Platform.

   • Token URL: Replace <instance> with your ServiceNow Instance.

Select the CMDB tables or leave it blank to retrieve all available CMDB tables.

7. Click on the Submit button.

Troubleshooting Tips

• Ensure the client key, client secret, instance, username and password are pasted correctly. Since you cannot view the client key and secret after the 1^st time, re-create the creds, paste it on a text editor to ensure no spaces or unexpected characters are included and reconfigure the DataBee feed

• Make sure the required user role is assigned.