Setup

Introduction

To successfully establish a connection and send requests to the ServiceNow API, the ServiceNow Scope activity needs a end point URL for your ServiceNow tenant (Endpoint URL), a user name (UserName) and password (Password). You may optionally retrieve an OAuth access token from your ServiceNow tenant. To retrieve the OAuth access token it needs your ServiceNow instance Client ID, Client Secret, and endpoint URL.

If you choose to use OAuth, you must give the ServiceNow Scope activity the ability to retrieve the OAuth access token and enable the other activities to successfully send requests to the ServiceNow API, you must complete the following steps:

1. Setup OAuth.
2. Create Credential Assets.
3. Build your project.
   
   

   

   
   

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.

Note: If you already setup OAuth for your ServiceNow instance, take note of the Client Id and Client Secret assigned to your application registry and proceed to the 2. Create Credential Assets step.

1. Sign in to your ServiceNow instance (e.g., https://dev74293.service-now.com/login)

2. Go to System Definitions > Plugins and verify the OAuth plugin Status is set to Active.

   
   

   

   
   

3. 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.

     
     

     

     
     

4. Enter a Name for your application (e.g., UiPathQuickstart) and click Submit (if successful, you are redirected back to your Application Registries list).

   
   

   

   
   
5. In the Application Registries list, find your new application and click on its Name to open the details page.
6. Click on the lock icon next to Client Secret to show the value.

7. Take note of the Client Id and Client Secret values (you'll enter these in the ServiceNow Scope activity).

   
   

   

   
   
8. If you want this OAuth application to support OAuth2 you must set the Redirect URL to http://127.0.0.1:10001/authorize/.
   Important:

   Starting with v1.3.8, we added support for local port. The Local Port parameter, available in ServiceNow Application Scope, is optional and configurable. By default, its value is set to 10001 (e.g., http://127.0.0.1:10001/authorize/). When you configure your OAuth application, set the Redirect URL to: http://127.0.0.1:{LocalPort}/authorize/. For example, for local port 10002, the Redirect URL would be http://127.0.0.1:10002/authorize/. It is not advisable to change the local port in the same project. If the port changes, create a new project or workflow to avoid caching errors, if any.
   
   

   

   
   

Create credential assets

The ServiceNow Scope activity requires SecureString inputs for your ServiceNow credentials (Password and ClientSecret). To generate the SecureString variables, it's recommended that you create two Credential Assets in your Orchestrator Tenant.

1. Sign in to the Orchestrator Tenant that you want to use for your project.
2. In the left-hand navigation, click Assets (this opens the Assets page).

3. Click the + icon to create a new Asset (this opens the Create Asset window).

   
   

   

   
   
4. Enter a Name and select Credential under Type.
5. In the Username field, enter the ClientId of your ServiceNow application registry.
6. In the Password field, enter the ClientSecret of your ServiceNow application registry.

7. Click Create.

   
   

   

   
   

8. Repeat steps 3-7 to create another Asset for your ServiceNow Username and Password.

   
   

   

   
   

Build your project

1. Create a new automation project.

   1. Open UiPath Studio.
   2. Under New Project, click Process (this opens a New Blank Process window).
   3. Enter a project Name, Location, and Description.

   4. Click Create.

      
      

      

      
      

2. Install the UiPath.ServiceNowActivities package.

   1. In the Design ribbon, click Manage Packages (this opens the Manage Packages window).
   2. Under All Packages, click Beta
   3. In the Search bar, enter ServiceNow.

   4. Click, install and accept the license for the UiPath.ServiceNow.Activities.

      • For more information about Uipath Studio packages, see Managing Packages in the Studio Guide.

You're done!

Now that you have completed the setup, you can start adding the ServiceNow activities to your project.

Next steps

For a hands-on learning experience and to quickly start using the activities, see the Quickstart guide. This guide provides step-by-step instructions to help you create a working sample of the different activities so that you can verify the connection to your ServiceNow instance and get familiar with the input/output properties.

To learn more about the ServiceNow activities (including example property inputs/outputs), see the Activities page for a complete activity list and links to the activity detail pages.