Skip to main content

Getting an org health scan from Pipelines

How to get an org health scan from Gearset Pipelines

Alec Short avatar
Written by Alec Short
Updated over a week ago

Get a Comprehensive Org Health Scan Directly from Gearset Pipelines

Understand, secure, and optimize your Salesforce org with in-depth health scans, now seamlessly integrated into your Gearset Pipelines and powered by Clayton Code Reviews.

Org health scans provide invaluable, objective insights into the quality, security, and maintainability of your Salesforce environment. By leveraging the power of Clayton directly within your Gearset Pipeline, you can ensure your org is always at its best.

How to Generate Your Org Health Scan:

It's a straightforward process to get a detailed overview of your org's health.

Step 1: Initiate the Scan from Your Pipeline

  1. Navigate to your Pipeline in Gearset.

  2. On the release environment, locate and click the 'Get org health scan' button.

  3. Carefully review and accept the terms and conditions.

  4. Authorize Clayton to connect to your Salesforce org. Make sure you're authorizing the intended org.

Step 2: Await Scan Completion

Once your org is authorized, the scan will begin automatically. You don't need to do anything further at this stage. We'll notify you as soon as your scan results are ready!


Please note: Depending on the size of your Salesforce Org, the initial scan might take a couple of hours as Clayton retrieves and analyzes your metadata. Subsequent scans are typically much faster.

Step 3: Access and Analyze Your Results in Clayton

  1. Return to your Gearset Pipeline's release environment.

  2. Click the 'View scan results' button. This will redirect you to the Clayton platform.

  3. Log in to Clayton using the exact same credentials you use for Gearset. For example, if you log into Gearset with your Google account, select Google as your login method for Clayton.

  4. You will now have full access to your detailed org health scan results, presented by Clayton.

Important Considerations:

  • Administrator Access: This feature is currently available to team owners only.

  • Release Environments: Org health scans can only be initiated from release environments within your Pipeline.

  • Seamless Login: Remember to use your existing Gearset credentials when logging into Clayton for a smooth experience.

  • Need Help? If you encounter any issues or have questions, please don't hesitate to reach out to our dedicated support team!

Did this answer your question?