- About the ServiceNow connector
- ServiceNow authentication
- ServiceNow events
ServiceNow authentication
Prerequisites
To establish the connection, you need to give the connector the ability to retrieve the OAuth access token and enable the activities to successfully send requests to the ServiceNow API.
Multi Authentication
You can read more on Multi-Authentication here.
- Complete the Setup OAuth steps in the ServiceNow documentation.
- Select Integration Service from Automation Cloud.
- From the Connectors list, select ServiceNow.
You can also use the search bar to narrow down the connector.
- Select the Add connection button.
- You are now redirected to the connection page.
- Click the ⚙ icon to change your Authentication type.
- Select the appropriate authentication mechanism.
- Enter the required information and click Connect.
Setup OAuth
Complete the Setup OAuth steps in the ServiceNow documentation.
While the documented steps are likely the same across all ServiceNow platform regions, it's recommended that you follow the steps for your specific region in case there are differences (e.g., Madrid, New York, etc.)
For reference, below is how we setup OAuth for our examples.
- Sign in to your ServiceNow instance (e.g.,
https://<span>dev74293.service-now.com/login</span>
) -
Go to System Definitions > Plugins and verify the OAuth plugin Status is set to Active.
-
Go to System OAuth > Application Registry and click New.
-
When asked What kind of OAuth application?, click Create an OAuth API endpoint for external clients.
-
-
Enter a Name for your application (e.g.
UiPathQuickstart
) and click Submit (if successful, you're redirected back to your Application Registries list). - In the Application Registries list, find your new application and click on its Name to open the details page.
- Click on the lock icon next to Client Secret to show the value.
- Take note of the Client Id and Client Secret values.
-
Type the following redirect URL in its corresponding field:
https://cloud.uipath.com/provisioning_/callback
.
Add the ServiceNow connection
To create a connection to your ServiceNow instance, you need to perform the following steps:
- Select Integration Service from Automation Cloud. You can also use the search bar to narrow down the connector.
- Select the Add connection button.
- You are now redirected to the connection page.
Enter the Site URL,Client ID, and Client
secret and click Connect.
- Next, enter your ServiceNow username and password. The app asks for your permission to connect to your ServiceNow account and to interact with records. Click Allow.
- Your connection has been added.
For more information on creating connections with ServiceNow, refer to ServiceNow Product Documentation.
ServiceNow roles and permissions
ServiceNow Table | Operation | Access reason |
Tables
(sys_db_object )
|
read |
The Tables module/table functions as a
repository that holds a row corresponding to each
table in your ServiceNow instance. It is utilized
to compile a list of tables for the purpose of
executing actions or triggering events. This is
required to load all your tables when you click on
the Select Object dropdown for you CRUD
activities.
|
Dictionary
(sys_dictionary )
|
read | This table encompasses data about respective columns of a particular table within your ServiceNow instance. This table is required to load input and output fields when you select a table for carrying out an action. |
Choices
(sys_choice )
|
read | The Choice table contains values for options that appear in choice lists and also for look ups in our curated activities. Without this the design time look ups in our activities will fail to load. |
User(sys_user) |
read | The Choice table contains translated text for options that appear in choice lists and also for look ups in our curated activities. Without this the design time user related look ups in our activities will fail to load. |
Furthermore, the user must also possess the requisite access control for
the tables essential to the integration scenario. For instance, if
you intend to establish an integration user capable of executing
typical ITIL helpdesk actions
(e.g., opening, updating, and closing incidents, problems, changes,
and configuration management items), you should assign the
itil
role.
Creating Custom Rules
Certain Base system roles,
such as admin
already encompass access control for
these tables. But, if you don't want to assign base system roles and
aim to provide only the essential access control required for using
the ServiceNow connector, you may consider crafting a custom role
with the necessary access permissions.
To grant access exclusively to specific tables or tables not covered by the default base system roles, so we recommend the creation of custom roles and the assignment of the appropriate access control as needed.
After the previously mentioned steps have been carried out, it is imperative to provide your new role with the following access controls in order to utilize the ServiceNow connector/activities.
Table | Type | Operation |
Tables
(sys_db_object )
|
record | read |
Dictionary
(sys_dictionary )
|
record | read |
Choices
(sys_choice )
|
record | read |
User (sys_user) |
record | read |
Editing or creating access control is a capability exclusive to a
user possessing the security_admin
role. If
you have any uncertainties, it is advisable to consult your
ServiceNow administrator. You can find additional
information in elevated privilege
roles.
On top of the above, for carrying out activity or trigger executions, you need to provide other access controls as well.
For instance, if your specific scenario involves initiating a workflow with a ServiceNow incident or creating a ServiceNow incident, the following access controls need to be granted.
Table | Type | Operation |
Incident | record | read |
Incident | record | write |