Extract and Assert Salesforce Layout
Extracting a page layout
This test step extracts all fields and the master Page Layout details of a target Salesforce object into an Excel sheet.
This test step is helpful when you want to extract or check over an entire Salesforce page layout. It is typically used with the Assert Salesforce Layout test step, which compares an extracted page layout from one Salesforce org to a current page layout. This is useful for comparing page layouts between sandboxes (for example) or checking that no changes have occurred in an existing org.
The API can also be used to test field permissions of the logged-in user of a given Salesforce connection.
To use this API, locate the Extract Salesforce Layout test step in the Test Palette and click and drag it into your test case.
Update the parameters as follows.
- Connection Name: The Salesforce Connection relating to the Salesforce org from which you want to use to extract the layout information and the user details you want to use to do it
- Object Name: The Salesforce object whose fields and page layout need to be extracted. Refer to the Org Browser for the exact name of the object.
- Result File: The file format in which to save the information (default is Excel Workbook)
- Workbook: Choose the destination Excel Workbook on your local machine. An Excel named ‘Workbook’ will be created in your Test Project Folder by default.
- Worksheet: Leave this info blank. A new sheet named the Object will be added with the field information. Additionally, a sheet named Master will be added containing the page layout information for that object.
- Include Field Permissions: If checked, add a list of access permissions to each and every field on that object for all profiles in that SF org.
- Then save the test case
Example
The screenshot above shows the use of an Extract Salesforce Layout API to extract the Page Layout and field details of the Contact object from a connected Salesforce Org identified as SFConnection.
Page layout details
Field details
Asserting a page layout
Once you have extracted a page layout using the Extract Salesforce Layout API, you may want to check some of its information using the Assert Salesforce Layout API. This will compare a local Excel Workbook, created using the Salesforce Extract Layout API, with a live page layout in a Salesforce org. Like the Extract Layout API, the Assert Layout API will use a Connection to extract layout and field information based on the Connection user’s permissions.
Note that the format of the spreadsheets must be an exact match for the API to work effectively. This is why generating the local Excel Workbook is sensible using an Extract Salesforce Layout API test step.
To use this API, locate the Assert Salesforce Layout API in the API palette and click and drag it into your Test Case.
Complete the parameters as follows:
- Connection Name: The Salesforce Connection relating to the Salesforce org from which you want to use to extract the live page layout information and the user details you want to use to do it
- Object Name: The Salesforce object whose fields and page layout need to be extracted. Refer to the Org Browser for the exact name of the object.
- Expected Layout File: The file format used by your local Layout file (default is Excel Workbook)
- Workbook: The local destination of the Excel Workbook created by an earlier Extract Salesforce Layout API step
- Include Field Permissions: Tick this if your local Workbook file was extracted using ‘Include Field Permissions’ ticked on the Extract Salesforce Layout API test step.
- Then save the test case
Example
Results
The Test Step will pass if the contents of the local Workbook match with the live page layout information relating to the Connection and Object selected. If there are discrepancies, these will appear in the Test Runner and Test Run Report. Note that all discrepancies will be included along with expected and actual values.
In Test Runner
In the Test Run Report
- 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
- API Testing
- Behavior-Driven Development
- Consolidating Multiple Test Execution Reports
- Creating and Importing Projects
- 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 Automation
- 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 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
- Masking Provar Credentials on CI
- Salesforce Testing
- Best Practices
- Improve Your Metadata Performance
- Java 21 Upgrade
- Salesforce Connection Best Practices
- 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