QualityClouds for Salesforce AppExchange Application

Introduction

The QualityClouds for Salesforce application allows direct integration between your Salesforce Orgs and the Quality Clouds API server. This allows you to retrieve the Org configurations you have defined in Quality Clouds, and to launch scans against them.

Installing and configuring the app

The application is currently being certified for delivery via the Salesforce App Exchange. While this is ongoing, please send an email to help@qualityclouds.com to receive a direct link to install the application.

Once the app is installed, you need to add the Quality Clouds tab to your Salesforce UI. To do this, click on the App Launcher icon (), and type "Quality Clouds" in the search box. Then select "Quality Clouds" from the "All Items" menu, and the tab will be opened next to your currently displayed tabs (see image below).



On the initial Quality Clouds page, click on the the "Go to Settings" button to enter your Quality Clouds credentials and obtain an OAuth token to use the Quality Clouds API. The Settings screen is shown below. The username and password are the ones you use to log into https://scan.qualityclouds.com. After you've entered them, click on the "Get Token" button. This will obtain an OAuth token from Quality Clouds, whose expiration date will be displayed on the "OAuth Status" Section. This token can be refreshed should it expire.

This completes the configuration for the Quality Clouds application. In order to start using it, the next step is to click on the "Go to Instances" button.

Retrieving your instances and launching scans

On the Instances page, you will see a list of all the instances you have defined in Quality Clouds. These instances may be Salesforce Orgs, or they may be source code repositories. Source code repositories are in turn divided into full branch repositories and feature branch repositories The difference is that feature branch repositories will run scans against a different feature branch on each scan, and will only scan differences between the feature branch and a reference branch. The name of the feature branch needs to be specified at the time that the scan is launched.

The first time that the instances page is accessed, the list of instances will be empty. Click on the Import/Update button to retrieve the list of your instances into the Salesforce app. The instances are defined by the following attributes, which are set on the Quality Clouds site when the instances are defined:

  • URL - The URL of the instance or code repository
  • Description - A free text description of the instance
  • Feature Branch - Flag which indicates whether the code repository scans should run against a feature branch

For each instance, you can click on the "View Detail" link, which will take you to the "Instance Details" screen. On this screen you can click the "Execute" button on the "Trigger a Scan" section to trigger a Quality Clouds scan against the instance. If the instance is a feature branch code repository instance, you will need to manually enter the name of the feature branch which you want to scan.

When the Trigger Scan button is pressed, the scan appears in the scans section below. You can query the status of the scan by clicking on the "Update" button next to the status label. The scan status will transition from Running to Success or Error, depending on the results of the scan.


Accessing Scan Results

For code repository feature branch scans, the users defined in the Quality Clouds admin site as recipients of feature branch scan results will receive an email with the issues detected in the scan. 

For live instance scans, or full branch code repository scans, the scan results will be available in the Quality Clouds dashboards.