Set up your QC Environment for Salesforce

1.- Set up your instance(s)

Once you have received valid credentials for the Quality Clouds Portal, in order to launch your first scan you must first create a valid instance. To do so, enter the https://scan.qualityclouds.com website and click the settings menu on the left navigation bar.


Here you can set up the instance(s) you want to scan. You should have one Salesforce instance available already, which will have been set up during the on-boarding process. All you need to do is to fill in the authentication details so that Quality Clouds can connect to and scan your Org, as below:

Org/Git

If you want to scan a Salesforce Org, you must choose 'Org' in the selector, so that Quality Clouds will gather the information directly from the instance. In case you want to scan a Git repository (with code that will be deployed in an Org), you must choose 'Git'.

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.

Go Live Date

Date on which the instance was first started, serves as a baseline for Org changes.

Org

Following attributes apply only for type 'Org' instances:

Org URL

URL of the Salesforce instance. This is descriptive only, and normally it will be pre-filled during the onboarding process. The Org which will be scanned is determined by the access credentials (Key and Secret). The Org Id will be extracted on the first scan and displayed in the dashboards. 

Connected App Consumer Key

This is the Consumer Key for the Connected App which will be used to obtain an OAuth token for authentication against the Org. 

The process to create a Connected App is described on this page: Create a Connected App for access via the REST API

Connected App Consumer Secret

This is the Consumer Secret for the Connected App which will be used to obtain an OAuth token for authentication against the Org.  

The process to create a Connected App is described on this page: Create a Connected App for access via the REST API

Login URL

Salesforce login URL. The production or sandbox URLs can be selected. If you use a custom domain, select the "Custom Domain" option, and fill in the URL for your custom login domain

Git

Following attributes apply only for type 'Git' instances:

Feature Branch

Enable if you want to scan a feature branch. When selected, the scan will report only differences between the specified feature branch and the master branch. As feature branches names can vary, branch name will be requested before scanning (Branch edit will disappear when Feature Branch option is enabled)

Method

Access method to the Git repository. Currently limited to User/Password.

Git Flavor

Git Repository type, to select among: GitHub/GitLab, Bitbucket, Azure DevOps/Visual Studio.

Git Repository URL

URL of the Git Repository. For example: https://github.com/myrepository.git

Branch

Name of the branch to scan. If 'Feature Branch' option is enabled, this attribute is not available (will be requested before the scan).

User ID

Username to access the Git Repository

Password

Password credential for the Git User.


2.- Obtain the OAuth Token

(Only applies to Org Instances)

Once the instance has been configured, it will appear on your list of available Salesforce instances, as in the below image. Before the instance can be scanned, however, Quality Clouds needs to obtain an OAuth token via the Connected App. In order to do this, click on the right arrow icon (next to the plug icon in the image below). Once you do, you will be redirected to the Salesforce login page, where you can enter the credentials of the user which will be used to access the Org. These user id and password are not available for Quality Clouds, and they are never persisted in the Quality Clouds environment.


3.- Test the connection

Once all the above steps are completed, you can verify that the configuration is correctly completed by clicking the plug icon next to your instance definition. This will run a connectivity test against the Org and confirm that the scan is ready to run. If the test returns an error, please contact help@qualityclouds.com to troubleshoot.

What's here


4.- Launch the scan

Scans are launched either manually or scheduled to be launched automatically, depending on your licensing plan. If your account allows manual scans, you can launch them using the launch scan icon on the top of the left sidebar  and the Scan Launch form will popup. Click on the launch icon next to the instance you want to scan, and that's it!