> For the complete documentation index, see [llms.txt](https://docs.dropzone.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dropzone.ai/integrations/data/servicenow_data.md).

# ServiceNow

## ServiceNow

Dropzone AI integrates with [ServiceNow](https://www.servicenow.com/now-platform.html), a cloud-based platform that provides digital workflow automation. Dropzone supports two methods of authentication for this integration: Basic and OAuth Inbound.

{% hint style="info" %}
If you wish to use Basic authentication, you may skip to the "Enable ServiceNow" section of this document.
{% endhint %}

### Create an OAuth Application User

To grant Dropzone access to [tables](https://www.servicenow.com/docs/r/washingtondc/api-reference/rest-apis/c_TableAPI.html) for use in analysis, you will need to add a user (either a dedicated Dropzone User or another user) to an [access control list](https://www.servicenow.com/docs/r/platform-security/access-control/exploring-access-control-list.html). Alternatively, you may use an administrative user as your OAuth Application User, which will allow Dropzone access to most organizational data and tables.

{% hint style="info" %}
If you choose to use an admin user, you may skip to the "Create an OAuth Inbound Integration" section of this document.
{% endhint %}

#### Create a New Role

To create a new role, do the following:

* In the top bar of the ServiceNow home page, click "All"
* In the search bar, navigate to System Security > Users and Groups > Roles

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-5453cdf5fe0a44a564fbbf48754e3d752936c257%2Fservicenow-1.png?alt=media" alt=""><figcaption><p>Navigate to Roles</p></figcaption></figure>

* Click "New"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-27ebd07b9a1b22780fce9ae510ea60410a9a8ddb%2Fservicenow-2.png?alt=media" alt=""><figcaption></figcaption></figure>

* Name the role something memorable, such as "dz\_table\_read"
* Click "Submit"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-d2d49a8aceecdcb8ff4aa2cdcc13a59dbb173f6a%2Fservicenow-3.png?alt=media" alt=""><figcaption><p>Create a new role</p></figcaption></figure>

#### Create an Access Control List

To create an ACL, do the following:

* In the upper right corner, click your icon
* Click "Elevate Role"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-7fdf8e6f3e10a17e400f2759139a09063cffccd6%2Fservicenow-4.png?alt=media" alt=""><figcaption><p>Elevate your role</p></figcaption></figure>

* Select security\_admin

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-cf1a7f133ea705e79844839f661a67dc560d1071%2Fservicenow-5.png?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
For more information on elevated roles, see [ServiceNow's documentation](https://www.servicenow.com/docs/r/platform-security/c_ElevatedPrivilege.html#:~:text=to%20manually%20elevate-,The%20security_admin%20role,-In%20the%20base)
{% endhint %}

* Navigate to All > System Security > Access Control (ACL)
* Click "New"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-27ebd07b9a1b22780fce9ae510ea60410a9a8ddb%2Fservicenow-2.png?alt=media" alt=""><figcaption></figcaption></figure>

* Under "Operation," select "read"
* Under "Name," input a table you want Dropzone to have read access to

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-9fcd69596dac4130c76a944e4bde5481560df720%2Fservicenow-6.png?alt=media" alt=""><figcaption><p>Assign the ACL scope</p></figcaption></figure>

* Under "Role," input the role you created earlier, e.g. dz\_table\_read

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-c7a391228464487c99f6ef80cd62264c8497b271%2Fservicenow-7.png?alt=media" alt=""><figcaption><p>Input the new role</p></figcaption></figure>

* Click "Submit"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-faf77c04a608c3cfa61748b324bfa6aa24251744%2Fservicenow-8.png?alt=media" alt=""><figcaption></figcaption></figure>

Repeat for every table you want Dropzone to have access to

#### Assign the ACL to the Role

* Navigate back to Roles
* Click on the role you just created
* In the "Modules with Role" section, click "New"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-9a6186f6fcfa010fa7c79c9c32199e2ca891690c%2Fservicenow-9.png?alt=media" alt=""><figcaption></figcaption></figure>

* Name the record with the name of the table in question
* Click "Link Type"
* Under "Table," select your desired table

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-96ba06a6dbd1470670a3bba9d6a78d9fb93400c3%2Fservicenow-11.png?alt=media" alt=""><figcaption></figcaption></figure>

* Click "Submit"

Repeat for every table you want Dropzone to have access to

#### Create a Group

* Navigate to All > System Security > Users and Groups > Groups

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-1093b0c73e72421cff21850bee179e6b7fbc63f1%2Fservicenow-13.png?alt=media" alt=""><figcaption></figcaption></figure>

* Click "New"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-27ebd07b9a1b22780fce9ae510ea60410a9a8ddb%2Fservicenow-2.png?alt=media" alt=""><figcaption></figcaption></figure>

* Name the role something memorable, such as "Dropzone AI"
* Assign yourself (or a dedicated Dropzone User) as the manager
* Click "Submit"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-f6400e49d643826e532a9ce5504c243adf4ca662%2Fservicenow-14.png?alt=media" alt=""><figcaption></figcaption></figure>

* Click "Group Members"
* Click "Edit"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-cac0a4d7f530276aa1e5b539c407d3bcf379a04a%2Fservicenow-15.png?alt=media" alt=""><figcaption></figcaption></figure>

* In the search bar under "Collection," add yourself (or a dedicated Dropzone User)
* Click the `>` then click "Save"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-cbd9af2907ef2effbb2242084ead9a52080c0a41%2Fservicenow-16.png?alt=media" alt=""><figcaption></figcaption></figure>

* In the "Roles" section, click "Edit"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-97cc42b20193c792b32b52d2ed234248cd95929a%2Fservicenow-17.png?alt=media" alt=""><figcaption></figcaption></figure>

* In the search bar under "Collection," add the role you created earlier
* Click the `>` then click "Save"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-de69eca957496a0d8f2ec730106d0c14c4a55b78%2Fservicenow-18.png?alt=media" alt=""><figcaption></figcaption></figure>

The user associated with this group will be used as the OAuth Application User.

## Create an OAuth Inbound Integration

ServiceNow requires a Client ID and Client Secret to enable. To manage OAuth integrations, you must have access to a user with one of the following roles: oauth\_admin mi\_admin admin

To obtain a Client ID and Secret, do the following:

* Navigate to All > System OAuth > Inbound Integrations

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-92dae321c070c3b8896b7d9893e74396da04ec54%2Fservicenow-19.png?alt=media" alt=""><figcaption><p>Navigate to Inbound Integrations</p></figcaption></figure>

* In the upper right, click "New Integration"
* Select "OAuth - Client Credentials Grant"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-788993bb408e2b3d5a1ff25b537a2fa1a1f9e3a0%2Fservicenow-20.png?alt=media" alt=""><figcaption></figcaption></figure>

* Name the client something memorable, such as "Dropzone AI"
* Under OAuth Application User, select the user you assigned earlier
* In the "Auth Scopes" section, click "Create auth scope"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-502121534a7f41f582ec2ae19a0aa9c33d965c61%2Fservicenow-21.png?alt=media" alt=""><figcaption></figcaption></figure>

* Name the scope something memorable, such as "Dropzone"
* Assign the integration the Table API scope

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-9d1d57d4764329403bfe33d29ec8a88797fafd85%2Fservicenow-22.png?alt=media" alt=""><figcaption><p>Add the Table API scope</p></figcaption></figure>

* Click "Submit"
* Copy the Client ID and Client secret generated for use later in the Dropzone UI where they are called "Client ID" and "Client Secret" respectively

### Enable ServiceNow

To enable the Data Source integration, you will need the following information:

| Dropzone Field | Source                                                                                 |
| -------------- | -------------------------------------------------------------------------------------- |
| Instance URL   | Your ServiceNow instance URL, e.g. yourcompany.service-now\.com                        |
| Username       | The username of the admin user you are using. Only used for basic authentication       |
| Password       | The password for the aforementioned user's account. Only used for basic authentication |
| Client ID      | The Client ID value generated earlier                                                  |
| Client Secret  | The Client Secret value generated earlier                                              |

To enable the Data Source integration, do the following:

* Navigate to your Dropzone AI tenant home page e.g. https\://*mycompany*.dropzone.app
* In the bottom left hand corner, navigate to Settings > Integrations

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-8c77435ef341f8180540e049f505d3390a27bbf4%2Fui-integrations-dropdown.png?alt=media" alt=""><figcaption><p>Integrations Dropdown</p></figcaption></figure>

* Click "Library"

{% hint style="info" %}
If you have previously integrated this application, click "Configured"
{% endhint %}

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-7e038b4f51ee27d4cf4f1ac6f76c5ddae2bf29c5%2Fapp_system_integrations_library.png?alt=media" alt=""><figcaption><p>Click Library</p></figcaption></figure>

* In the Search bar, search ServiceNow, then click "Configure"

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-f9eec2d1d2189cf08a5816d2ca90156266268c27%2Fapp_system_integrations_available_servicenow.png?alt=media" alt=""><figcaption><p>The ServiceNow Tile</p></figcaption></figure>

* Under the Data Source heading, input the Instance URL and select your method of authentication from the dropdown

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-5c3673e9241e3fd25ed216c86943e194904ad1d0%2Fapp_system_integrations_available_servicenow_data_config-1.png?alt=media" alt=""><figcaption><p>The ServiceNow Data Source Configuration (pt 1)</p></figcaption></figure>

* If you selected Basic, input the username and password

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-6573209cce1f2ed329e45094890059d73ccdeb0a%2Fapp_system_integrations_available_servicenow_data_config-2.png?alt=media" alt=""><figcaption><p>The ServiceNow Data Source Configuration (pt 2)</p></figcaption></figure>

* If you selected OAuthInbound, input the Client ID and Secret

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-6ce83ed62e7e6d1df79d5eaef1c00e3ce194e954%2Fapp_system_integrations_available_servicenow_data_config-3.png?alt=media" alt=""><figcaption><p>The ServiceNow Data Source Configuration (pt 3)</p></figcaption></figure>

* In the "Table and Query Pairs" section, you must add the [ServiceNow tables](https://www.servicenow.com/docs/r/washingtondc/api-reference/rest-apis/c_TableAPI.html) you want Dropzone to access
* To do so, input the name of the table (such as "incident" or "asset") in the Table Name section
* Under "Encoded Query," input a ServiceNow [encoded query string](https://www.servicenow.com/docs/r/platform-user-interface/c_EncodedQueryStrings.html)
* Click "Add Item" to add more tables

<figure><img src="https://435022081-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBVcKuiytGCsIDpL70BC%2Fuploads%2Fgit-blob-075bdd04244efdc69d8a07500b38f8065ddd5a84%2Fapp_system_integrations_available_servicenow_data_config-4.png?alt=media" alt=""><figcaption><p>The ServiceNow Data Source Configuration (pt 4)</p></figcaption></figure>

* Click "Test & Save" to finish

If you have any errors or questions, engage your Dropzone AI support representative.
