Has your Automated UI Test failed due to a Salesforce marketing or discoverability popup? Follow this guide to disable this feature across your org.
If you're using Gearset Automated UI Testing, any in-app guidance pop-ups will be dismissed automatically without needing to follow this guide.
This guide may still be helpful if you're running UI testing using one of our third party integrations.
What is Salesforce In-App Guidance?
In-App Guidance is a Salesforce enablement tool that helps users discover and learn how to use new features. This takes the form of prompts and walkthroughs that appear as pop-ups whilst a user is interacting with the page.
By default, Salesforce provides a set of Standard In-App Guidance popups which appears up to once every 24 hours. However, this can be customised and admins also have the ability to create their own guidance for their users.
Note that this is different to Guidance Center, which is another enablement tool that appears as an additional panel that can be opened by clicking on its icon in the global header.
This example shows a blue Standard In-App Guidance Popup that walks the user through using the right-hand Guidance Center.
How does In-App Guidance affect my UI Tests?
Whilst In-App Guidance can be useful to educate your users, it can often cause problems during UI testing.
UI tests are written following a specific set of steps of how to interact with the page, and when pop-ups randomly appear that block other content, this can cause the test to fail.
Disabling Standard In-App Guidance Popups
It is possible to disable Salesforce Standard In-App Guidance Popups, however this is a setting that applies globally to your org and not to an individual user.
Salesforce also provides a guide on How to Turn Off Salesforce Standard In-App Guidance on their help pages.
Navigate to the User Engagement > In-App Guidance page in the Salesforce Setup menu, then click on Settings.
Uncheck the Salesforce Standard In-App Guidance checkbox, then click Save.
You should have now successfully disabled Salesforce Standard In-App Guidance, so these pop-ups will no longer appear.