Set up your instance(s)Once you have received valid credentials for the Scan Tool Website, 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:
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 combination of username and login URL. The Org Id will be extracted on the first scan and displayed in the dashboards.
Short and meaningful description of the instance. For example: MyCompany UAT
SOAP API Credentials
The below configuration parameters are required to use the SOAP API.
Username used to access the Salesforce Instance. This must be an active Salesforce user in your Org. The user must have the "Modify All Data" permission.
This is the password for the user which will be used to access your Salesforce Org.
The WebServiceAPI security token for the user which will be used to access your Salesforce Org. If you do not know what the value for this token is, or have never used it, you can reset it by taking these steps:
- Log into the Org with the user which will be used to access your Salesforce Org.
- Access the personal settings page, enter Reset in the Quick Find box, then select Reset My Security Token.
- Click Reset Security Token. The new security token is sent to the email address in your Salesforce personal settings.
Salesforce login URL, depending on if it's a Sandbox or Production instance.
Note: If you use a custom domain, enter your custom login URL instead of the above.
Environment type of the instance. This is only used to add descriptive context to your instance.Environment
REST API Credentials
The below configuration parameters are required to use the REST API. These are only required if you've signed up for the Operational Scan option.
The process to create a Connected App is described on this page: Create a Connected App for access via the REST API
This is the Consumer Key for the Connected App which will be used to access the REST API.
This is the Consumer Secret for the Connected App which will be used to access the REST API.
Do not persist credentials
This is an optional setting which can be activated in case you prefer to not have Quality Clouds store the credentials to your Org. If this option is chosen, the username, password, and API authentication token must be entered every time that the scan is triggered manually. Also, selecting this option means that scans can not be scheduled, and must always be launched manually.
2. 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 sidebarand the Scan Launch form will popup. Click on the launch icon next to the instance you want to scan, and that's it!