The following steps are used to configure your ServiceNow instance in order to connect to it from Quality Clouds.
1. Grant IP address access
For instances with IP restrictions, make sure you add exceptions for the following Quality Clouds IP addresses (in the IP Address Access Control in ServiceNow):
On your network infrastructure level, make sure traffic is allowed from the IP.
2. Decide on admin vs non-admin access
Quality Clouds uses the REST API to connect to and scan the code and configuration of your ServiceNow instance. This means that a valid username / password must be configured in Quality Clouds in order for the scan to execute successfully.
The first decision to make is whether you will grant the admin role to the user which Quality Clouds will use to connect to your instance. Bear in mind that the
snc_read_only role can (and should) also be assigned to this user, which makes all access read-only. Also, this user can be a Web-service-only user, so it will not be possible to log into the ServiceNow UI with that user.
If you are not comfortable with granting the admin role, it is also possible to use a Quality Clouds specific role. The creation of this role, and of the ACLs which grant read only access on the required tables to the role, are available as an Update Set which you can install in your instance.
In general, using a read-only admin user is the preferred option, as it allows customers to ignore the Delta Update Sets and automatically enjoy all the new functionality provided by Quality Clouds releases.
In order to help you make the decision which is right for you, the below table summarizes the key differences between each approach.
One time only - Initial setup
Delta Update set needs to be applied whenever Quality Clouds includes additional tables to scan.
Typically twice a year.
Read-only visibility to
Only tables required by Quality Clouds.
Quality Clouds rule coverage
99% - The Best Practices "Modules pointing to big tables without filters" and "Custom Tables with no records" can not be guaranteed to work unless additional roles are granted.
ServiceNow scoped applications which are created upon plugin activation can not be identified. All their CEs will be assigned to the Global Scope.
For admin user
If you decide to use a read-only admin user, simply enter the credentials for the user on the Instance Configuration page on the Quality Clouds scan web site, as described on the page Defining ServiceNow instances.
For non-admin user
If you decide to use a non-admin user, retrieve and apply relevant update sets, as described on Configuring for non-admin user.
For ServiceNow instances with encrypted data
Edge encryption does not affect Quality Clouds scans nor does it need any extra configuration.
For ServiceNow instances with SSO system
Make sure that the user to be launching scans in Quality Clouds uses local authentication and is able to use the REST API.
3. Configure the user
We recommend creating a dedicated user for setting up access and running scans from Quality Clouds.
Ensure that the user configured to run the scans has the following characteristics:
use local authentication mode
have read access to the following tables:
ServiceNow tables accessed by Quality Clouds
Following is the list of all tables accessed by Quality Clouds for each ServiceNow instance:
* The only fields accessed on sys_user table are: userid, active. No personal information is accessed.
** We no longer require access to the user profile related tables.
4. (optionally) Enable collection of client-side performance data
Optionally, to enable the collection of client-side performance data, install and enable the ServiceNow Client Transaction Timings plugin.
If this plugin is not active, the client-side performance widgets in the Performance Dashboard will not be populated. For detailed instructions on how to do this, check the ServiceNow documentation article.