Check list

Connecting SN for new Customer v10 #

Step 1 #

You must have the following:

• Have/created ServiceNow instance. To create a ServiceNow instance, click here.
• Download/installed QualityClouds App.

→ How to install the application v10 from the store:

1. Log in ServiceNow account.
2. Go to the ServiceNow store.
3. Look for the Quality Clouds app.
4. Install the version v.10.

Step 2 #

Once the application is installed correctly, login to Quality Clouds Admin Portal and register your instance.

• Before registering your instance, you will need to create a user (Admin or QC access) and Read-Only (role).
• Define your ServiceNow instance, click here to learn how.

Step 3 #

Proceed with a Connectivity Test to ensure the credentials introduced are correct and all tables are accessible for the Quality Clouds user. 

Step 4 #

Go to the SN App and follow the Guided Set up as following:

• Define an Admin user for the global component installer (this is one time activity – Please note the Auth profile can be deleted once the installation is completed).
• Execute the component Installer (Mandatory and optional components).
• Create the first API key on the QC Portal.
• Copy the API Key in the SN App.
• Import configuration.
• Add users to the QC API Key generation group (all user added to this group will be provided with an API Key automatically.
• Create a QC Admin user, specifically for the LC configuration (Please note if you add this user into the QC Admin group, the proper role and the API key will be provided automatically).
• Set the username and Password for the created user (above) the following system properties: x_qucl_qc_snow.write.access.username and x_qucl_qc_snow.write.access.password
• Within the Quality Clouds scheduled job table, please populate the field ‘run as’ with a user that has a valid API Key.

Updating ServiceNow v10 from 9.5 or 9.6 versions #

Step 1 #

Go to the ServiceNow store and update the current version.

→ How to update the application to the v10?

1. Log in ServiceNow account.
2. Go to the ServiceNow store.
3. Look for the Quality Clouds app.
4. Update the version you currently have. 
5. In ServiceNow app, go to ‘All‘.
6. Type ‘Quality Clouds Guided Setup‘ and follow the instructions to ensure that all features are properly configured.

Step 2 #

Follow the Quality Clouds Guided Setup:

• Define an Admin user for the global component installer (this is a one-time activity – Please note the Auth profile can be deleted once the installation is completed)
• Execute the component Installer (Mandatory and optional components)
• Execute a fix script (in the global scope) to deactivate the Quality Clouds deprecated components) – Link is in the guided setup QC – Deactivate deprecated components

The first step of the ‘Guided Setup’ guides you through the installation of the global components for ServiceNow version 10. These components are essential for the proper functioning of the app.

3 step process to install Global Components:

• Configure an auth profile for the Component Installer.

The component Installer uses the ServiceNow Table API to create all the required components. As the table API needs authentication, you need to define an auth profile in order to use the Table API.

Note: the user specified on the auth profile needs to have the admin role in order to be able to create and delete records in all the required tables.

• Install the components in the Global scope.

 Once the auth profile is defined, you need to navigate to the Global Component Installer Page to install the required components in the Global scope to support the LiveCheck functionality.

You will be able to install the components one by one or install all the components in a single action by clicking on ‘Install all Required Components’ or ‘Install all Optional Components’. In the ‘Action’ column, you can click on ‘Update’ if you are transitioning from a later version or click on ‘Accept’ if it’s your first time using this app.

Please note that LiveCheck functionality will not be available unless all Required Components are installed.

The ‘QC -Execute AsyncLiveCheck when complete ‘ Optional Component must be installed for the Quality Gates to work.

• Deactivate deprecated content from old App versions.

If you’re upgrading the Quality Clouds App from the 9.6.x version or older, then you will need to copy the code contained in the following fix script and execute it on Scripts – background on the Global scope to deactivate the deprecated Global elements from older versions of the APP.

In case of a new installation, or If you’re upgrading the APP from version 10.x or higher, then you can skip this step.

• If upgrading from 9.5 version you’ll need to encrypt the already existing API Keys, so please execute the scheduled job – QC – Encrypt values for existing API Keys.
• Please execute the following scheduled job – QC – Update API Keys expiration date.
• Import Configuration.
• If upgrading from 9.5 version you’ll need to:
  • Create a QC Admin user, specifically for the LC configuration (Please note if you add this user to the QC Admin group, the proper role and the API key will be provided automatically)
  • Set the username and Password for the created user (above) the following system properties: x_qucl_qc_snow.write.access.username and x_qucl_qc_snow.write.access.password

Step 3 #

Within the Quality Clouds scheduled job table, please populate the field ‘run as’ with a user that has a valid API Key.