Granting Org Permissions to Provar Automation
The purpose of this article is to explain what permissions you need to grant for Provar Automation to access your Salesforce org(s), why you need to grant them, and how you can flexibly manage this using a Permission Set so that you can maintain this from a single point within your Salesforce setup.
Note that in most cases, you can use an existing System Admin profile to provision the appropriate permissions. If this is impossible for your org, follow the steps below to assign these permissions in a Permission Set.
For Provar Automation to automatically understand your Salesforce Org configuration, you need to connect Provar to your org with extended privileges. Provar Automation automatically recognizes your Salesforce metadata, including page layouts, Flexipages, custom buttons, links, actions, fields, Visualforce pages, Lightning components, and more. In Provar Automation, we call this the Metadata Cache. Once downloaded, you can automatically synchronize any changes made as part of an application deployment each time you run your regression tests.
Creating a Provar Automation Permission Set
To handle the provisioning of permissions to Provar Automation, we recommend creating a Salesforce Permission Set, which can be assigned to the admin user used for testing with Provar Automation. Note that this permission set only needs to be granted to Salesforce Connection users requiring admin-level access and should not be applied to users where you use the Log-On As Connection functionality to test as a specific user/profile. Refer to Adding a Connection for more information on the different types of Salesforce Connections that Provar uses. Follow the steps below to create your Permission Set.
Create a New Permission Set
As a System Administrator, go into Setup, select the Permission Sets menu item, and click the New button:
Complete the new form. We suggest a name of Provar Metadata but this can be changed to whatever naming standard is preferred.
Add Mandatory Permissions
Select the following permissions and add them to the Permission Set created above.
- Modify All Data
- API Enabled
- Modify Metadata (Beta) – We recommend adding this now to be in place for the future. Refer to the FAQ section below for more information.
Select each property to add to the permission set and click the Edit button to activate the corresponding checkboxes. Note that checking Modify All Data will automatically check the Modify Metadata (Beta) permission and any other dependencies.
Remember to click the Save button to complete the action.
Optional Permissions
You may want to add permissions to this Permission Set based on your specific org implementation and test scenarios. Feel free to include any additional permissions required that you are aware of that are not automatically included in the profile of the user used in your Provar Automation Metadata connection. These may include Access Libraries, Lightning Console, Mass Email local custom fields, and specific record types.
Below are some additional suggestions for commonly added permissions. Note that these are only required if you use or test these features in your Salesforce instance. Repeat the steps above to add them to your Provar Automation Metadata Permission Set as required:
- Allow Access to Customized Actions if using Custom Actions and Chatter-based profiles
- View Data Categories in Setup if testing Salesforce Knowledge; this also exposes the Categories in the API
- Lightning Experience User if testing with the Lightning UI theme and not already granted by default to your user(s)
Assign a Permission Set
The final step is to assign your Permission Set. To do this, simply click the Manage Assignments button from the Permission Set page and then click the Add Assignment button. Select the primary user(s) needed for connecting from Provar Automation and accessing metadata, then click the Assign button.
You can remove the Permission Set from a single user from the corresponding user’s profile page or multiple users from the Manage Assignments page.
FAQ
Do these enhanced permissions give you access to our org in addition to giving Provar Automation access?
No, we only have access if you provide us access. The connection is exclusively for creating, maintaining, and executing test cases. We only have access to your orgs if you share login details with us or export a Provar Automation project and share it with us for customer support. This is true regardless of whether or not you use the Permission Set.
If I use a System Admin profile for my Provar Automation metadata user, do I still need to grant this Permission Set?
No, the System Admin profile has more permissions than granted by this Permission Set. However, you may need to add the optional permissions, such as for Lightning Experience User. See Step 3 above for more information.
Why do I have to grant Modify All Data? Isn’t the Modify Metadata permission sufficient?
The Modify Metadata permission is only a Beta feature and not complete without Modify All Data. (Refer to Modify Metadata Permission (Beta) for more information). We are working with the appropriate Salesforce Product Managers and other Salesforce Tool ISVs to ensure this provides the required level of access. In the future, we anticipate that Modify All Data may no longer be required, though it would remain helpful for complex test cases.
I’ve created and applied the Permission Set, but saw the message “The connection test failed: Sorry, your administrator has blocked access to the client.”
Your Salesforce administrator may have disabled access to 3rd party applications. Please refer to Solving Administrator has Blocked Access to Client Errors for more information.
- Provar Automation
- System Requirements
- Browser and Driver Recommendations
- Installing Provar Automation
- Updating Provar Automation
- Licensing Provar
- Granting Org Permissions to Provar Automation
- Optimizing Org and Connection Metadata Processing in Provar
- Using Provar Automation
- Provar Automation
- Creating a New Test Project
- Import Test Project from a File
- Import Test Project from a Remote Repository
- Import Test Project from Local Repository
- Commit a Local Test Project to Source Control
- API Testing
- Behavior-Driven Development
- Consolidating Multiple Test Execution Reports
- Creating Test Cases
- Custom Table Mapping
- Functions
- Debugging Tests
- Defining a Namespace Prefix on a Connection
- Defining Proxy Settings
- Environment Management
- Exporting Test Cases into a PDF
- Exporting Test Projects
- Japanese Language Support
- Override Auto-Retry for Test Step
- Mapping and Executing the Lightning Article Editor in Provar
- Managing Test Steps
- Namespace Org Testing
- NitroX
- Provar Test Builder
- ProvarDX
- Refresh and Recompile
- Reintroduction of CLI License Check
- Reload Org Cache
- Reporting
- Running Tests
- Searching Provar with Find Usages
- Secrets Management and Encryption
- Setup and Teardown Test Cases
- Tags and Service Level Agreements (SLAs)
- Test Cycles
- Test Data Generation
- Test Plans
- Testing Browser Options
- Tooltip Testing
- Using the Test Palette
- Using Custom APIs
- Callable Tests
- Data-Driven Testing
- Page Objects
- Block Locator Strategies
- Introduction to XPaths
- Creating an XPath
- JavaScript Locator Support
- Label Locator Strategies
- Maintaining Page Objects
- Mapping Non-Salesforce fields
- Page Object Operations
- ProvarX™
- Refresh and Reselect Field Locators in Test Builder
- Using Java Method Annotations for Custom Objects
- Applications Testing
- Provar Manager
- How to Use Provar Manager
- Provar Manager Setup
- Provar Manager Integrations
- Release Management
- Test Management
- Test Operations
- Provar Manager and Provar Automation
- Setting Up a Connection to Provar Manager
- Object Mapping Between Automation and Manager
- How to Upload Test Plans, Test Plan Folders, Test Plan Instances, and Test Cases
- Provar Manager Filters
- Uploading Callable Test Cases in Provar Manager
- Uploading Test Steps in Provar Manager
- How to Know if a File in Automation is Linked in Test Manager
- Test Execution Reporting
- Metadata Coverage with Manager
- Provar Grid
- DevOps
- Introduction to Provar DevOps
- Introduction to Test Scheduling
- Apache Ant
- Configuration for Sending Emails via the Automation Command Line Interface
- Continuous Integration
- AutoRABIT Salesforce DevOps in Provar Test
- Azure DevOps
- Running a Provar CI Task in Azure DevOps Pipelines
- Configuring the Automation secrets password in Microsoft Azure Pipelines
- Parallel Execution in Microsoft Azure Pipelines using Multiple build.xml Files
- Parallel Execution in Microsoft Azure Pipelines using Targets
- Parallel execution in Microsoft Azure Pipelines using Test Plans
- Bitbucket Pipelines
- CircleCI
- Copado
- Docker
- Flosum
- Gearset
- GitHub Actions
- Integrating GitHub Actions CI to Run Automation CI Task
- Remote Trigger in GitHub Actions
- Parameterization using Environment Variables in GitHub Actions
- Parallel Execution in GitHub Actions using Multiple build.xml Files
- Parallel Execution in GitHub Actions using Targets
- Parallel Execution in GitHub Actions using Test Plan
- Parallel Execution in GitHub Actions using Job Matrix
- GitLab Continuous Integration
- Travis CI
- Jenkins
- Execution Environment Security Configuration
- Provar Jenkins Plugin
- Parallel Execution
- Running Provar on Linux
- Reporting
- Salesforce DX
- Git
- Version Control
- Salesforce Testing
- Recommended Practices
- Salesforce Connection Best Practices
- Improve Your Metadata Performance
- Java 21 Upgrade
- Testing Best Practices
- Automation Planning
- Supported Testing Phases
- Provar Naming Standards
- Test Case Design
- Create records via API
- Avoid using static values
- Abort Unused Test Sessions/Runs
- Avoid Metadata performance issues
- Increase auto-retry waits for steps using a global variable
- Create different page objects for different pages
- The Best Ways to Change Callable Test Case Locations
- Working with the .testProject file and .secrets file
- Best practices for the .provarCaches folder
- Best practices for .pageObject files
- Troubleshooting
- How to Use Keytool Command for Importing Certificates
- Installing Provar After Upgrading to macOS Catalina
- Browsers
- Configurations and Permissions
- Connections
- DevOps
- Error Messages
- Provar Manager 3.0 Install Error Resolution
- Provar Manager Test Case Upload Resolution
- Administrator has Blocked Access to Client
- JavascriptException: Javascript Error
- macOS Big Sur Upgrade
- Resolving Failed to Create ChromeDriver Error
- Resolving Jenkins License Missing Error
- Resolving Metadata Timeout Errors
- Test Execution Fails – Firefox Not Installed
- Selenium 4 Upgrade
- Licensing, Installation and Firewalls
- Memory
- Test Builder and Test Cases
- Release Notes