Defining ServiceNow instances

Before performing these steps, make sure you have the following information:

Setting up your instances

In order to be able to scan your instances, you need to point Quality Clouds to them.

→ To create an instance in Quality Clouds

If using Certificate-Based Authentication


Enforce security using Certificate-based authentication for ServiceNow.

What is Certificate-based authentication?

Certificate-based authentication verifies user logins or API requests using trusted certificates issued by a Certificate Authority (CA). This authentication method can be used to authenticate requests to ServiceNow SOAP and REST APIs. Since the interaction between Quality Clouds and ServiceNow instances is implemented via the REST API, it is possible to support Certificate Based authentication for this interaction, as an alternative to the Basic authentication mechanism.

Why use a certification-based authentication?

To provide enhanced security in the connection between Quality Clouds and your ServiceNow instance.

How does the certificate-based authentication work in Quality Clouds?

  1. Request the public certificate from Quality Clouds.
  2. Install the certificate in ServiceNow instance. Follow the ServiceNow instructions on how to install the Quality Clouds certificate in your instance.
  3. Make sure that the installed Quality Clouds certificate is mapped to a user with the required permissions to enable a Quality Clouds scan.
  4. Activate the 'Certificate' toggle in the Quality Clouds Admin portal, ServiceNow instance section.
  5. Verify the connectivity by clicking the 'Test connection' icon.


  1. Login to the Quality Clouds Admin portal at https://portal.qualityclouds.com/.
  2. Go to Account.
  3. Go to the Instances section.
  4. Select the ServiceNow tab (if you use several SaaS with Quality Clouds).
  5. Click + (Add button). 
  6. Enable the 'CERTIFICATE' toggle.
  7. Fill in the following information:
    • URL – URL of the ServiceNow instance. If your ServiceNow instance uses SSO or any other external authentication method, make sure that the account you provide has local authentication in ServiceNow (does not need to be authenticated by external providers) and is able to use the REST API.
    • Description -Short and meaningful description of the instance. For example: MyCompany UAT
    • Environment – Environment type of the instance. This is used to add descriptive context to your instance.NoteServiceNow production (PROD) instances are subject to an extra check: Debugging properties enabled in production environments.
    • Go-live Date – Date on which the instance was first started, serves as a baseline for instance changes.
    • Tags – Use tags to add specific information for better instance recognition.
  8. Click Save.



If using Basic Authentication

  1. Login to the Quality Clouds Admin portal at https://portal.qualityclouds.com/.
  2. Go to Account.
  3. Go to the Instances section.
  4. Select the ServiceNow tab (if you use several SaaS with Quality Clouds).
  5. Click + (Add button). 
  6. Enable the 'BASIC' toggle.
  7. Fill in the following information:
    • URL – URL of the ServiceNow instance. If your ServiceNow instance uses SSO or any other external authentication method, make sure that the account you provide has local authentication in ServiceNow (does not need to be authenticated by external providers) and is able to use the REST API.
    • Description -Short and meaningful description of the instance. For example: MyCompany UAT
    • Username and Password – ServiceNow credentials to access the instance via the REST API. The user selected must use local authentication in ServiceNow, and have the required permissions to enable a Quality Clouds scan.
    • Environment – Environment type of the instance. This is used to add descriptive context to your instance.NoteServiceNow production (PROD) instances are subject to an extra check: Debugging properties enabled in production environments.
    • Go-live Date – Date on which the instance was first started, serves as a baseline for Org changes.
    • Tags – Use tags to add specific information for better instance recognition.
    • Addons related – These are the add-ons included in your contract.
  8. Click Save.

→ Configure the Quality Gates

  1. When setting or editing an instance, click on the ‘Quality Gates’ tab.
  2. Enable the Quality Gates toggle.
  3. Add the Activation Date.
  4. Configure the Blocking rules table and smart tagging.
  5. Click ‘Save‘.

Click here to learn how Quality Gates work.

→ Configure the Peer Review

  1. When setting or editing an instance, click on the ‘Peer Review’ tab.
  2. Enable the Peer Review toggle.
  3. Select where and when to get notified when Peer Reviews are pending:
    • Where: None, Email or Portal.
    • When: None, Daily, Weekly or Monthly.
  4. In the Peer Review Workflow section select ‘Write Off assignation’:
    • Manual Assign
    • Auto Assign
    • Developer Assign
  5. Select the Default assignee email on the dropdown menu. Enable it if you want the default assignee to be notified when a write-off is assigned.
  6. Enable or disable the Source Code toggle.
  7. Click ‘Save‘.
  • Manual Assign will hide the Default Assignee drop-down menu. 
  • Auto Assign will show the Default Assignee and there won’t be any other option than to select one person from the list.






You can now continue with the following steps:

  1. Test connectivity.
  2. Schedule scans or Run scans manually.

What's here




Last modified on Apr 3, 2024