Live Check for ServiceNow

What is the Live Check for ServiceNow?

Live Check is an add-on feature which allows developers to validate their code as they are writing it. See our solutions and pricing section to know more. 

You can only use Live Check if you have a ServiceNow admin role. Contact us to get the Live Check update set. 

The Live Check runs all the ServiceNow, Javascript, and custom rules against the definition of a single Configuration Element or an entire update set. This enables developers to receive immediate feedback to guarantee that best practices are being followed, without having to wait for the scheduled full scans to complete.

The Live Check is implemented as an additional update set which must be installed on an instance where the Quality Clouds ServiceNow Store application is already installed and configured. After the update set has been added, the Quality Clouds Live Check button will automatically appear on all of the Configuration Element definition forms. When the button is clicked, the definition of the Configuration Element is sent to the Quality Clouds API server, which executes the rules and returns a list of issues that have been detected. These issues are displayed in a Related List associated with the latest version of the Configuration Element.

Running Live Checks

Issues detected with the Live Check functionality do not impact the results of the regular scans and do not appear on the main views, only on the Live Check view.

To run Live Check, make sure you access the Configuration Element definition form, whether in Studio, or in the main ServiceNow interface.

  1. Once in the Configuration Element definition, click the Quality Clouds Live Check button. 

You have now sent the definition of the Configuration Element to the Quality Clouds API. 

The form reloads, and any detected issues are displayed in the related Quality Clouds Live Checks issues list.

  • If no rows appears on the related list, this means that the scan is still running. In this case, it is necessary to wait a few more seconds and reload the form again.
  • In the event that a scan returns without any detected issues, one row will display in the related list with Severity INFO, and the text Quality Clouds online checks completed. No issues found. If this is the case then the code complies with all of the best practices.

Running Live Checks on update sets

You can also run the Live Check on all the Configuration Elements which make up an Update Set. This can be done regardless of the state which the Update Set is on. It can also be performed on multiple Update Sets at the same time.

→ To run Live Check on single update set

Access the update set definition, and click on the Quality Clouds Live Check button.The list of issues is returned in the related list Quality Clouds Live Checks issues.

If no issues are detected, one row will display in the related list with Severity INFO, and the text Quality Clouds online checks completed. No issues found.

→ To run Live Check in multiple update sets

Access the list of Update Sets, select as many as you want to scan, and then select the Quality Clouds Live Check List from the drop down actions menu (see image below). The list of issues is now available in the related list for each update set once the checks complete.

Configuration Element Types where the Live Check can be used

The Live Check button will appear in the create / edit forms for all the below Configuration Element Types. 

  • Record Producer
  • Update Set
  • Custom Application
  • Dictionary Entry
  • Dictionary Entry Override
  • table (sys_db_object)
  • Data Policy
  • User Criteria
  • Widget, Client Script
  • Catalog Client Scripts
  • Email Script
  • Inbound Email Actions
  • scripted rest api
  • script action
  • Widget Angular Provider
  • UI policy
  • UI Policy Actionm
  • Table Transform Map
  • Widget (sp_widget)
  • Access Control
  • Scripted REST Resource
  • UI Script
  • Transform Script

For each of these, you should also see a related list labelled Quality Clouds Live Check Issues.

If the related list does not appear, simply right-click on the form header section, select Configure → Related Lists, and add the related list called <Configuration Item Type> to QC Check related list to the form. This is where any detected issues will be displayed. 

See it in a video

What's here

Related content

Scanning update sets in ServiceNow

Last modified on Jun 22, 2023