Assert Salesforce 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.
Record Page Layout: If checked, this feature will fetch the Record Layout information for the record types.
Dynamic Form Layout: If checked, this feature will fetch the only record types that has dynamic forms enabled for that profile and application.
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.
Include Permission Set: If checked, add a list of field details relating to profile and permission sets.
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.