ServiceNow App v10
Release date: January 29th, 2024
New general features and changes
This release brings significant enhancements to LiveCheck, Write-offs, and API key management features. Additionally, a new installation process has been introduced for a better user experience.
New installation process
The installation process has been changed from the version 9.6. In version 10, the Update Set is no longer required to install the new version. Instead, you will need to use a new component called the Global Component Installer.
→ How to install the application v10 from the store:
- Log in ServiceNow account.
- Go to the ServiceNow store.
- Look for the Quality Clouds app.
- Install the version v.10 or update the version you have.
- Go to 'All'.
- Type 'Quality Clouds Guided Setup' and follow the instructions to ensure that all features are properly configured.
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.
What happens if the Global Components are installed incorrectly?
If the Global Components are installed incorrectly, every time you attempt to use the LiveCheck functionality, an error message will appear. This message will prompt you to visit the Global Component Installer and install the missing required components.
Enhancements to LiveCheck
- LiveCheck functionality is delivered via the Global Component installer. See the Guided Setup instructions on how to use this Global Component installer.
- When "Revert to this version" is used from the list of versions in any Configuration Element which supports LiveCheck, the list of LiveCheck issues is reset. The issues from the previously active version are no longer shown.
- In this version, to view the Related Lists of Quality Clouds and specially the Quality Clouds LiveCheck and LiveCheck issues you need to click on the Quality Clouds view:
Enhancements to Write-off functionality
- Write-offs approved in the Quality Clouds portal with an expiration date will display the expiration date in the ServiceNow app.
When a write-off is requested from the ServiceNow app, a new kanban card in the column 'In Progress' will appear in the Peer Review dashboard. By clicking on the issue, approve the issue and add an expiration date.
After this action, in the ServiceNow application it's necessary to launch a LiveCheck. Once the scan is finished, you will be able to view the same expiration date that was added in the Peer Review dashboard.
- Write-offs will display the unique, human-readable identifier generated by the Peer Review component so that, they can be tracked in the Peer Review dashboard.
Enhancements to API key functionality
- API keys are encrypted using the ServiceNow encryption APIs supported from Vancouver onwards.
- API key expiration date is available for each API key.
Once the API key has been created in the Quality Clouds admin portal, when adding the new API key in the ServiceNow app the expiration date will be automatically displayed.
→ How to view the expiration date for API keys in ServiceNow:
- Log in ServiceNow account.
- Go to 'All'.
- Type 'API keys' from the Quality Clouds app.
- Click on 'Enter My Key'.
- Paste the API key created in the Quality Clouds admin portal.
- Click 'Save'.
- View the 'Expiration Date'.
- In this version, API keys that are still active but close to their expiration date can be renewed from the app. A message will inform users how many days are left for the API key to be expired and guide them to renew the API key by clicking on the link. A new window will open
A new window will open where you will be able to renew the API key by clicking the button 'Renew API Key':
When the API key has been renewed this message will appear:
- Revoked API keys are periodically removed from the instance.
- When a user who is part of a Quality Clouds group does not have an API key, a reminder message will appear, prompting them to request an API key.
- Minor bug fixes