Understand, secure, and optimize your Salesforce org with a comprehensive org health check.
Seamlessly integrated into your Gearset Pipelines and powered by Code Reviews, our Salesforce org health check provides invaluable insights into your environment. You can proactively identify and fix risks, ensuring a healthy Salesforce environment by strengthening your security settings and following best practices for optimal performance and code quality.
Get a clear health check score and detailed reports to easily maintain a strong security posture and protect your business operations from security threats.
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
Navigate to your Pipeline in Gearset.
On the release environment, locate and click the 'Get org health scan' button.
Carefully review and accept the terms and conditions.
Authorize Code Reviews 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 Code Reviews retrieves and analyzes your metadata. Subsequent scans are typically much faster.
Step 3: Access and Analyze Your Results in Code Reviews
Return to your Gearset Pipeline's release environment.
Click the 'View scan results' button. This will redirect you to the Code Reviews platform.
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.
You will now have full access to your detailed org health scan results, presented by Code Reviews.
Important Considerations:
Administrator Access: This feature is currently only available to team owners. You can learn more about adding team members and controlling access by clicking here.
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 Code Reviews 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!
What's Next?
Now that you have your detailed org health scan results, you can use them to improve your Salesforce environment. Code Review's report gives you actionable insights into potential security threats, code quality issues, and performance bottlenecks.
Review and Prioritize: The scan provides a health check score and detailed reports, highlighting the most critical issues first. Focus on addressing high-priority security risks and vulnerabilities.
Fix Risks and Vulnerabilities: Use the remediation guidance provided in the Clayton report to fix issues identified in your security configurations and Apex code. This helps you maintain a strong security posture.
Create Quality Gates: To prevent new issues from entering your org, consider integrating Code Review's findings into your deployment process. You can create quality gates in your Gearset pipeline to automatically block deployments that don't meet your standards. To enforce that violations are fixed before merging, you can configure branch protections in your version control provider (GitHub, GitLab, Bitbucket, and Azure Devops).
Continuous Improvement: Schedule regular org health scans to monitor your progress and ensure you're maintaining a healthy Salesforce org. Subsequent scans will be faster and will show you if new issues have been introduced.
If you want violations to block merging until they are fixed, configure branch protections in your version control provider (GitHub, GitLab, Bitbucket, and Azure Devops).