Page Layouts (from the Metadata API)
Pull Page Layout structure per Object, including sections, columns, fields, and display behaviour, for all Objects or a specified Object.
Results are loaded to table ss_SysLayout
Parameters
Parameter | Purpose |
@ObjectName | Salesforce Object Name (for example Account). alternatively pass "All" to retrieve all Objects. |
@Env | SQL Sales Environment Name, see Setup |
@Special1 | Future use, not currently used |
@Special2 | Future use, not currently used |
Example of Use - All
exec ss_MetaLayout 'DEMO', 'All'
Example of Use - Single
exec ss_MetaLayout 'DEMO', 'Account'
ss_SysLayout table
Column Name | Purpose |
ObjectName | Salesforce object the layout belongs to. |
LayoutFullName | API name of the layout (typically ObjectName-LayoutName). |
LayoutName | User-friendly name of the layout. |
SectionNumber | Sequence number of the section within the layout. |
SectionLabel | Label of the section as displayed in the UI. |
SectionStyle | Layout style of the section (e.g. one column, two columns). |
SectionDetailHeading | Whether the section heading is shown on the detail (view) page (1 = shown, 0 = hidden). |
SectionEditHeading | Whether the section heading is shown on the edit page (1 = shown, 0 = hidden). |
SectionCustomLabel | Whether the section uses a custom label (1 = yes, 0 = standard). |
ColumnNumber | Column position within the section. |
ItemNumber | Position of the item within the column. |
ItemType | Type of layout item (e.g. Field, CustomLink, Visualforce, EmptySpace). |
Behavior | Behaviour of the item (e.g. Edit, ReadOnly, Required). |
FieldName | API name of the field displayed (if the item is a field). |
CustomLink | Name of a custom link if the item is a link component. |
Page | Visualforce page name if the item is a page component. |
SControl | S-Control reference (legacy, rarely used). |
ShowLabel | Whether the label is displayed for the component (1 = shown, 0 = hidden). |
ShowScrollbars | Whether scrollbars are enabled for components like Visualforce pages. |
Height | Height setting for components such as Visualforce pages. |
Width | Width setting for components such as Visualforce pages. |
EmptySpace | Placeholder/blank space used for layout formatting. |