Layout

Represents the metadata associated with a page layout. For more information, see Page Layouts in Salesforce Help.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

To edit the Ideas layout, specify it by name in the package.xml file. In package.xml, use this code to retrieve the Ideas layout. In the <members> tag, specify the object name (Idea) and then the layout name (Idea Layout), separated by a hyphen.

This type extends Metadata and inherits its fields.

Layouts are stored in the layouts directory of the corresponding package directory. The extension is .layout.

Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet components that are retrieved in the same package.

Layouts are available in API version 13.0 and later.

  • Type: string[]
  • Required: No
  • Description: The custom buttons for this layout. Each button is a reference to a WebLink on the same object. For example, a ButtonLink refers to a Weblink on the same standard or custom object named ButtonLink.
  • Type: CustomConsoleComponents
  • Required: No
  • Description: Represents custom console components (Visualforce pages, lookup fields, or related lists; Canvas apps not available) on a page layout. Custom console components only display in the Salesforce console.
  • Type: boolean
  • Required: No
  • Description: Only relevant if showEmailCheckbox is set; indicates the default value of that checkbox.
  • Type: string[]
  • Required: No
  • Description: List of standard buttons to exclude from this layout. For example, <excludeButtons>Delete</excludeButtons> excludes the Delete button from this layout.
  • Type: FeedLayout
  • Required: No
  • Description: Represents the values that define the feed view of a feed-based page layout. Feed-based layouts are available on Account, Case, Contact, Lead, Opportunity, custom, and external objects. They include a feed view and a detail view.
  • Type: LayoutHeader (enumeration of type string)[]
  • Required: No
  • Description: Layout headers are currently only used for tagging, and only appear in the UI if tagging is enabled. Valid string values are:
  • Possible values:
    • PersonalTagging — tag is private to user.
    • PublicTagging — tag is viewable any other user who can access the record.
  • Type: LayoutSection[]
  • Required: No
  • Description: The main sections of the layout containing fields, s-controls, and custom links. The order here determines the layout order.
  • Type: MiniLayout
  • Required: No
  • Description: A mini layout is used in the mini view of a record in the Console tab, hover details, and event overlays.
  • Type: string[]
  • Required: No
  • Description: Fields for the special multiline layout fields that appear in OpportunityProduct layouts. These fields are otherwise similar to miniLayoutFields.
  • Type: PlatformActionList
  • Required: No
  • Introduced: API version 34.0
  • Description: The list of actions and their order that appear in the Salesforce mobile app action bar for the layout.
  • Type: QuickActionList
  • Required: No
  • Introduced: API version 28.0
  • Description: The list of quick actions that display in the full Salesforce site for the page layout.
  • Type: RelatedContent
  • Required: No
  • Introduced: API version 29.0
  • Description: The Related Content section of the page layout.
  • Type: RelatedListItem[]
  • Required: No
  • Description: The related lists for the layout, listed in the order they appear in the user interface.
  • Type: string[]
  • Required: No
  • Description: The list of related objects that appears in the mini view of the console. In database terms, these objects are foreign key fields on the object for the layout. For more information, see Choose Related Objects for the Agent Console’s Mini View in Salesforce Help.
  • Type: boolean
  • Required: No
  • Description: Only relevant if showRunAssignmentRulesCheckbox is set; indicates the default value of that checkbox.
  • Type: boolean
  • Required: No
  • Description: Only allowed on Case, CaseClose, and Task layouts. If set, a checkbox appears to show email.
  • Type: boolean
  • Required: No
  • Introduced: API version 22.0
  • Description: If set, the highlights panel displays on pages in the Salesforce console.
  • Type: boolean
  • Required: No
  • Introduced: API version 22.0
  • Description: If set, the interaction log displays on pages in the Salesforce console.
  • Type: boolean
  • Required: No
  • Introduced: API version 20.0
  • Description: Only allowed on Case layouts. If set, the Knowledge sidebar displays on cases in the Salesforce console.
  • Type: boolean
  • Required: No
  • Description: Only allowed on Case, Lead, and Account objects. If set, a checkbox appears on the page to show assignment rules.
  • Type: boolean
  • Required: No
  • Description: Only allowed on CaseClose layout. If set, the built-in solution information section shows up on the page.
  • Type: boolean
  • Required: No
  • Description: Only allowed on Case layout. If set, the Submit & Add Attachment button displays on case edit pages to portal users in the Customer Portal.
  • Type: SummaryLayout
  • Required: No
  • Introduced: API version 18.0
  • Description: Controls the appearance of the highlights panel in Salesforce Classic, which summarizes key fields in a grid at the top of a page layout, when Case Feed is enabled.

Represents the settings for a CRM Analytics dashboard on a standard or custom page.

Introduced in API version 34.0.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the type of CRM Analytics asset to add. The available asset type is dashboard.
  • Type: string
  • Required: Yes
  • Description: Required. Unique development name of the dashboard to add.
  • Type: string
  • Required: No
  • Description: Error string; only populated if an error occurred in the underlying dashboard.
  • Type: string
  • Required: No
  • Description: Communicates initial dashboard filters for mapping data fields in the dashboard to the object’s fields, so that the dashboard shows only the data that’s relevant for the record being viewed.
  • Type: int
  • Required: No
  • Description: Specifies the height of the dashboard, in pixels. The default is 400.
  • Type: boolean
  • Required: No
  • Description: Controls whether users see a dashboard that has an error. When this attribute is set to true, if the dashboard has an error, the dashboard doesn’t appear on the page. When set to false, the dashboard appears but doesn’t show any data except the error. An error can happen when a user doesn’t have access to CRM Analytics or to the dashboard. The default is true.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Introduced: API version 37.0
  • Description: If set to true, and the dashboard is shareable, then the dashboard shows the Share icon. Users can click the icon to open the Share dialog and post or download from the dashboard. If set to false, the dashboard doesn’t show the Share icon.
  • Type: boolean
  • Required: No
  • Description: If true, includes the dashboard’s title above the dashboard. If false, the dashboard appears without a title. The default is true.
  • Type: string
  • Required: No
  • Description: Specifies the width of the dashboard, in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%. The default is 100%.

Represents a custom console component (Visualforce page, lookup field, or related lists; Canvas apps not available) on a section of a page layout. Custom console components only appear in the Salesforce console.

Introduced in API version 25.0.

  • Type: int
  • Required: Yes
  • Description: Required for components with a location of top or bottom. The height of the custom console component. The value must be specified in pixels and be greater than 0 but less than 999.
  • Type: string
  • Required: Yes
  • Description: Required. The location of the custom console component on the page layout. Valid values are right, left, top, and bottom. A component can have one location for each page layout.
  • Type: string
  • Required: Yes
  • Description: Required. The unique name of the custom console component. For example, ConsoleComponentPage.
  • Type: int
  • Required: Yes
  • Description: Required for components with a location of left or right. The width of the custom console component. The value must be specified in pixels and be greater than 0 but less than 999.

Represents a location and style to display more than one custom console component in the sidebars of the Salesforce console. For example, you can show multiple components in the right sidebar of the console with a style of either stack, tabs, or accordion.

Introduced in API version 30.0.

  • Type: int
  • Required: No
  • Description: Required for components with a location of top or bottom. The height of the components’ container. The unit field determines the unit of measurement, in pixels or percent.
  • Type: boolean
  • Required: Yes
  • Introduced: API version 32.0
  • Description: Required. If set to true, stacked console components in the sidebars autosize vertically. Set to true by default for newly created console components.
  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: Required. The location of the components’ container. Valid values include:
  • Possible values:
    • right
    • left
    • top
    • bottom
  • Type: SidebarComponent[]
  • Required: No
  • Description: Represents a specific custom console component to display in the components’ container.
  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: Required. The style of the container to display multiple components. Valid values include:
  • Possible values:
    • stack — a content area with multiple frames.
    • tabs — a single content area with a list of multiple panels.
    • accordian — a collapsible content area.

  • Type: string

  • Required: Yes

  • Description: Required. The unit of measurement, in pixels or percent, for the height or width of the components’ container.

    Pixel values are simply the number of pixels, for example, 500, and must be greater than 0 but less than 999. Percentage values must include the percent sign, for example, 20%, and must be greater than 0 but less than 100.

  • Type: int
  • Required: No
  • Description: Required for components with a location of right or left. The width of the components’ container. The unit field determines the unit of measurement, in pixels or percent.

Represents custom console components (Visualforce pages, lookup fields, or related lists; Canvas apps not available) on a page layout. Custom console components only appear in the Salesforce console.

Introduced in API version 25.0.

  • Type: PrimaryTabComponents
  • Required: No
  • Introduced: API version 25.0
  • Description: Represents custom console components on primary tabs in the Salesforce console.
  • Type: SubtabComponents
  • Required: No
  • Introduced: API version 25.0
  • Description: Represents custom console components on subtabs in the Salesforce console.

Represents the values that define the feed view of a feed-based page layout. Feed-based layouts are available on Account, Case, Contact, Lead, Opportunity, custom, and external objects. They include a feed view and a detail view.

Introduced in API version 30.0.

  • Type: boolean
  • Required: No
  • Description: Specifies whether the publisher is automatically collapsed when the page loads (true) or not (false).
  • Type: boolean
  • Required: No
  • Description: Specifies whether the feed-based page layout uses a compact feed (true) or not (false). If set to true, feed items on the page are collapsed by default, and the feed view has an updated design.
  • Type: FeedLayoutFilterPosition (enumeration of type string)
  • Required: No
  • Description: Where the feed filters list is included in the layout.
  • Possible values:
    • centerDropDown — as a dropdown list in the center column.
    • leftFixed — as a fixed list in the left column.
    • leftFloat — as a floating list in the left column.
  • Type: FeedLayoutFilter[]
  • Required: No
  • Description: The individual filters displayed in the feed filters list.
  • Type: boolean
  • Required: No
  • Description: Specifies whether the feed expands horizontally to take up all available space on the page (true) or not (false).
  • Type: boolean
  • Required: No
  • Description: Specifies whether the sidebar is hidden (true) or not (false).
  • Type: boolean
  • Required: No
  • Type: FeedLayoutComponent[]
  • Required: No
  • Description: The individual components displayed in the left column of the feed view.
  • Type: FeedLayoutComponent[]
  • Required: No
  • Description: The individual components displayed in the right column of the feed view.
  • Type: boolean
  • Required: No

Represents a component in the feed view of a feed-based page layout.

Introduced in API version 30.0.

  • Type: FeedLayoutComponentType (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of component.
  • Possible values:
    • HelpAndToolLinks — icons that link to the help topic for the page, the page layout, and, the printable view of the page. Available only on Case layouts.
    • CustomButtons — a custom button.
    • Following — an icon that toggles between a Follow button (if the user viewing a record doesn’t already follow it) and a Following indicator (if the user viewing a record does follow it).
    • Followers — a list of users who follow the record.
    • CustomLinks — a custom link.
    • Milestones — the milestone tracker, which lets users see the status of a milestone on a case. Available only on Case layouts.
    • Topics — a list of topics related to the record.
    • CaseUnifiedFiles — a list of all files that are attached to the case.
    • Visualforce — a custom Visualforce component.
  • Type: int
  • Required: No
  • Description: The height, in pixels, of the component. Doesn’t apply to standardComponents
  • Type: string
  • Required: No
  • Description: The name of a Visualforce page being used as a custom component.

Represents a feed filter option in the feed view of a feed-based page layout. A filter must have only standardFilter or feedItemType set.

Introduced in API version 30.0.

  • Type: string
  • Required: No
  • Description: The name of a CustomFeedFilter component. Names are prefixed with the name of the parent object. For example, Case.MyCustomFeedFilter.
  • Type: FeedLayoutFilterType (enumeration of type string)
  • Required: Yes
  • Description: The type of filter.
  • Possible values:
    • AllUpdates — shows all feed items on a record.
    • FeedItemType — shows feed items only for a particular type of activity on the record.
  • Type: FeedItemType (enumeration of type string)
  • Required: No
  • Description: The type of feed item to display.
  • Possible values:
    • ActivityEvent — feed items related to activity on tasks and events associated with a case. Available only on Case layouts.
    • AdvancedTextPost — feed items related to group announcements posted on a feed. This value is available in API version 31.0 and later.
    • AnnouncementPost — Not used.
    • ApprovalPost — feed items related to approvals that are submitted on a feed.
    • AttachArticleEvent — feed items for activity related to attaching articles to cases. Available only on Case layouts.
    • BasicTemplateFeedItem — Not used.
    • CallLogPost — feed items for activity from the Log a Call action. Available only on layouts for objects that support Activities (tasks and events).
    • CanvasPost — feed items related to posts that a canvas app makes on a feed.
    • CaseCommentPost — feed items for activity from the Case Note action. Available only on Case layouts.
    • ChangeStatusPost — feed items for activity from the Change Status action. Available only on Case layouts.
    • ChatTranscriptPost — feed items for activity related to attaching Chat transcripts to cases. Available only on Case layouts.
    • CollaborationGroupCreated — feed items related to creating a public group.
    • CollaborationGroupUnarchived — Not used.
    • ContentPost — feed items related to attaching a file to a post.
    • CreatedRecordEvent — feed items related to creating a record from the publisher.
    • DashboardComponentSnapshot — feed items related to posting a dashboard snapshot on a feed.
    • EmailMessageEvent — feed items for activity from the Email action. Available only on Case layouts.
    • FacebookPost — Not used.
    • LinkPost — feed items related to attaching a URL to a post.
    • MilestoneEvent — feed items for changes to the milestone status on a case. Available only on Case layouts.
    • PollPost — feed items related to posting a poll on a feed.
    • ProfileSkillPost — feed items related to skills added to a user’s Chatter profile. This value is available in API version 31.0 and later.
    • QuestionPost — feed items related to posting a question on a feed. This value is available in API version 31.0 and later.
    • ReplyPost — feed items for activity from the Portal action. Available only on Case layouts.
    • RypplePost — feed items related to creating a Thanks badge in WDC.
    • SocialPost — feed items for activity on Twitter from the Social Post action.
    • TextPost — feed items for creating a text post from the publisher.
    • TrackedChange — feed items related to a change or group of changes to a tracked field.
    • UserStatus — Not used.

LayoutColumn represents the items in a column within a layout section.

  • Type: LayoutItem[]
  • Required: No
  • Description: The individual items within a column (ordered from top to bottom).
  • Type: string
  • Required: No
  • Description: This field is reserved for Salesforce. The field resolves an issue with some SOAP libraries. Any value entered in the field is ignored.

LayoutItem represents the valid values that define a layout item. An item must have only one of the following values set: component, customLink, field, s-control, page, analyticsCloudComponent, or reportChartComponent.

  • Type: UiBehavior (enumeration of type string)

  • Required: No

  • Description: Determines the field behavior. Valid string values:

    Explicitly specifying UiBehavior for Knowledge articles results in an exception.

  • Possible values:

    • Edit — The layout field can be edited but isn’t required.
    • Required — The layout field can be edited and is required.
    • Readonly — The layout field is read-only.
  • Type: string
  • Required: No
  • Introduced: API version 31.0
  • Description: Reference to a canvas app.

  • Type: string

  • Required: No

  • Introduced: API version 30.0

  • Description: Reference to a component. Value must be sfa:socialCard.

    This field is allowed only inside a RelatedContentItem. sfa:socialCard is supported only on page layouts for contacts, accounts, and leads.

  • Type: string
  • Required: No
  • Description: The customLink reference. This field is allowed only inside a CustomLink layoutSection.
  • Type: boolean
  • Required: No
  • Description: Controls if this layout item is a blank space.
  • Type: string
  • Required: No
  • Description: The field name reference, relative to the layout object, for example Description or MyField__c.
  • Type: int
  • Required: No
  • Description: For s-control and pages only, the height in pixels.
  • Type: string
  • Required: No
  • Description: Reference to a Visualforce page.
  • Type: string
  • Required: No
  • Description: Reference to an s-control.
  • Type: boolean
  • Required: No
  • Description: For s-control and pages only, whether to show the label.
  • Type: boolean
  • Required: No
  • Description: For s-control and pages only, whether to show scrollbars.
  • Type: string
  • Required: No
  • Description: For s-control and pages only, the width in pixels or percent. Pixel values are simply the number of pixels, for example, 500. Percentage values must include the percent sign, for example, 20%.

LayoutSection represents a section of a page layout, such as the Custom Links section.

  • Type: boolean
  • Required: No
  • Description: Indicates if this section’s label is custom or standard (built-in). Custom labels can be any text, but must be translated. Standard labels have a predefined set of valid values, for example System Information, which are automatically translated.
  • Type: boolean
  • Required: No
  • Description: Controls if this section appears in the detail page. In the UI, this setting corresponds to the checkbox in the section details dialog.
  • Type: boolean
  • Required: No
  • Description: Controls if this section appears in the edit page.
  • Type: string
  • Required: No
  • Description: The label; either standard or custom, based on the customLabel flag.
  • Type: LayoutColumn[]
  • Required: No
  • Description: The columns of the layout, depending on the style. 1, 2, or 3 columns, ordered left to right, are possible.
  • Type: LayoutSectionStyle (enumeration of type string)
  • Required: Yes
  • Description: The style of the layout:
  • Possible values:
    • TwoColumnsTopToBottom — Two columns, tab goes top to bottom
    • TwoColumnsLeftToRight — Two columns, tab goes left to right
    • OneColumn — One column
    • CustomLinks — Contains custom links only

Represents a mini view of a record in the Console tab, hover details, and event overlays.

  • Type: string[]
  • Required: No
  • Description: The fields for the mini-layout, listed in the order they appear in the UI. Fields that appear here must appear in the main layout.
  • Type: RelatedListItem[]
  • Required: No
  • Description: The mini related list, listed in the order they appear in the UI. You can’t set sorting on mini related lists. Fields that appear here must appear in the main layout.

PlatformActionList represents the list of actions and their order that appear in the Salesforce mobile app action bar for the layout.

Introduced in API version 34.0.

  • Type: PlatformActionListContext (enumeration of type string)
  • Required: Yes
  • Description: Required. The context of the action list.
  • Possible values:
    • Assistant
    • BannerPhoto
    • Chatter
    • Dockable
    • FeedElement
    • Flexipage
    • Global
    • ListView
    • ListViewDefinition
    • ListViewRecord
    • Lookup
    • MruList
    • MruRow
    • ObjectHomeChart
    • Photo
    • Record
    • RecordEdit
    • RelatedList
    • RelatedListRecord
  • Type: string
  • Required: No
  • Description: When the ActionListContext is RelatedList or RelatedListRecord, this field represents the API name of the related list to which the action belongs.

PlatformActionListItem represents an action in the PlatformActionList.

Introduced in API version 34.0.

  • Type: string
  • Required: Yes
  • Description: The API name for the action in the list.
  • Type: PlatformActionType (enumeration of type string)
  • Required: Yes
  • Description: The type of action.
  • Possible values:
    • ActionLink — An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce Chatter feed UI.
    • CustomButton — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
    • InvocableAction
    • ProductivityAction — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions.
    • QuickAction — A global or object-specific action.
    • StandardButton — A predefined Salesforce button such as New, Edit, and Delete.
  • Type: int
  • Required: Yes
  • Description: The placement of the action in the list.
  • Type: string
  • Required: No
  • Description: The subtype of the action. For quick actions, the subtype is QuickActionType. For custom buttons, the subtype is WebLinkTypeEnum. For action links, subtypes are Api, ApiAsync, Download, and Ui. Standard buttons and productivity actions have no subtype.

Represents custom console components on primary tabs in the Salesforce console.

Introduced in API version 25.0.

  • Type: ConsoleComponent[]
  • Required: No
  • Description: Represents a custom console component (Visualforce page, lookup field, or related lists; Canvas apps not available) on a section of a page layout. Custom console components only appear in the Salesforce console. This field is available in API version 29.0 and earlier.
  • Type: Container[]
  • Required: No
  • Introduced: API version 30.0
  • Description: Represents a location and style to display more than one custom console component on the sidebars of the Salesforce console. You can specify up to five components for each of the four locations (left, right, top, and bottom).

QuickActionList represents the list of actions associated with the page layout.

Introduced in API version 28.0.

QuickActionListItem represents an action in the QuickActionList.

Introduced in API version 28.0.

  • Type: string
  • Required: Yes
  • Description: The API name of the action.

RelatedContent represents the Mobile Cards section of the page layout.

Introduced in API version 29.0.

  • Type: RelatedContentItem[]
  • Required: No
  • Description: A list of layout items in the Mobile Cards section of the page layout.

RelatedContentItem represents an individual item in the RelatedContentItem list.

Introduced in API version 29.0.

Represents related list custom components on the sidebars of the Salesforce console.

Introduced in API version 31.0.

  • Type: boolean
  • Required: Yes
  • Description: If set to true, the related list is hidden from detail pages where it appears as a component to prevent duplicate information from showing.
  • Type: string
  • Required: Yes
  • Description: The name of the component as it appears to console users.

RelatedListItem represents a related list in a page layout.

  • Type: string[]
  • Required: No
  • Description: A list of custom buttons that are used on the related list.
  • Type: string[]
  • Required: No
  • Description: A list of buttons that are excluded from the related list.

  • Type: string[]

  • Required: No

  • Description: A list of fields that are displayed in the related list.

    Retrieval of standard fields on related lists uses aliases instead of field or API names. For example, the Fax, Mobile, and Home Phone fields are retrieved as Phone2, Phone3, and Phone4, respectively.

  • Type: string[]
  • Required: No
  • Description: A list of quick actions that are used on the related list.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the related list.
  • Type: string
  • Required: No
  • Description: The name of the field that is used for sorting.
  • Type: SortOrder (enumeration of type string)
  • Required: No
  • Description: If the sortField is set, the sortOrder field determines the sort order.
  • Possible values:
    • Asc — Sort in ascending order
    • Desc — Sort in descending order

Represents the settings for a report chart on a standard or custom page.

  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: Indicates whether to use cached data when displaying the chart. When the attribute is set to true, data is cached for 24 hours. If the attribute is set to false, the report isn’t run every time the page is refreshed.
  • Type: string
  • Required: No
  • Description: Unique development name of the field by which a report chart is filtered to return data relevant to the page. If set, the ID field for the parent object of the page or report type is the chart data filter. The parent object for the report type and the page must match for a chart to return relevant data.
  • Type: string
  • Required: No
  • Introduced: API version 31.0
  • Description: Error string; only populated if an error occurred in the underlying report.
  • Type: boolean
  • Required: No
  • Introduced: API version 29.0
  • Description: Controls whether users see a chart that has an error. When there’s an error and this attribute is set, the chart doesn’t show any data except the error. An error can happen for many reasons, such as when a user doesn’t have access to fields used by the chart or a chart has been removed from the report. Set the attribute to true to hide the chart from a page on error.
  • Type: boolean
  • Required: No
  • Description: If true, filters the report chart to return data that’s relevant to the page.
  • Type: string
  • Required: Yes
  • Description: Unique development name of a report that includes a chart.
  • Type: boolean
  • Required: No
  • Description: If true, applies the title from the report to the chart.
  • Type: ReportChartComponentSize (enumeration of type string)
  • Required: No
  • Description: The chart size is medium when no value is specified.
  • Possible values:
    • SMALL
    • MEDIUM
    • LARGE

Represents a specific custom console component to display in a container that hosts multiple components in one of the sidebars of the Salesforce console. You can specify up to five components for each of the four container locations (left, right, top, and bottom).

Introduced in API version 30.0.

  • Type: string

  • Required: Yes

  • Introduced: API version 31.0

  • Description: Specifies the component type. Valid values are KnowledgeOne, Lookup, Milestones, RelatedList, Topics, Files, and CaseExperts. The Files and CaseExperts values are available in API version 32.0 and later.

    Case Experts is available through a pilot program.

  • Type: string
  • Required: No
  • Introduced: API version 42.0
  • Description: If the component is a lookup field, the name of the quick action used to create a record.
  • Type: boolean
  • Required: No
  • Introduced: API version 42.0
  • Description: If the component is a lookup field, lets users associate a record with this field. If false, the createAction and updateAction can’t be retrieved.
  • Type: int
  • Required: No
  • Description: Required for components with a location of top or bottom. The height of the component in the container. The unit field determines the unit of measurement, in pixels or percent.
  • Type: string
  • Required: No
  • Description: The name of the component as it appears to console users. Available for components in a container with the style of tabs or accordion.
  • Type: string
  • Required: No
  • Description: If the component is a lookup field, the name of the field.
  • Type: string
  • Required: No
  • Description: If the component is a Visualforce page, the name of the Visualforce page.
  • Type: RelatedList[]
  • Required: No
  • Introduced: API version 31.0
  • Description: If the component is a related list, the name of the list.

  • Type: string

  • Required: No

  • Description: The unit of measurement, in pixels or percent, for the height or width of the component in the container.

    Pixel values are simply the number of pixels, for example, 500, and must be greater than 0 but less than 999. Percentage values must include the percent sign, for example, 20%, and must be greater than 0 but less than 100.

  • Type: string
  • Required: No
  • Introduced: API version 42.0
  • Description: If the component is a lookup field, the name of the quick action used to update a record.
  • Type: int
  • Required: No
  • Description: Required for components with a location of right or left. The width of the component in the container. The unit field determines the unit of measurement, in pixels or percent.

Represents custom console components on subtabs in the Salesforce console.

Introduced in API version 25.0.

  • Type: ConsoleComponent[]
  • Required: No
  • Description: Represents a custom console component (Visualforce page, lookup field, or related lists; Canvas apps not available) on a section of a page layout. Custom console components only appear in the Salesforce console. This field is available in API version 29.0 and earlier.
  • Type: Container[]
  • Required: No
  • Introduced: API version 30.0
  • Description: Represents a location and style to display more than one custom console component on the sidebars of the Salesforce console. You can specify up to five components for each of the four locations (left, right, top, and bottom).

When Case Feed is enabled, controls the appearance of the highlights panel in Salesforce Classic, which summarizes key fields in a grid at the top of a page layout.

Introduced in API version 25.0.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the layout label.
  • Type: int
  • Required: Yes
  • Description: Required. Number of columns in the highlights pane, from 1 through 4 (inclusive).
  • Type: int
  • Required: No
  • Description: Required. Number of rows in each column, either 1 or 2.
  • Type: int
  • Required: No
  • Description: Reserved for future use. If provided, the setting is visible to users.
  • Type: SummaryLayoutItem[]
  • Required: No
  • Description: Controls the appearance of an individual field and its column and row position within the highlights panel grid, when Case Feed is enabled. At least one is required.

  • Type: SummaryLayoutStyle (enumeration of type string)

  • Required: Yes

  • Description: Highlights panel style. Valid string values are:

    • Default
    • QuoteTemplate
    • DefaultQuoteTemplate
    • CaseInteraction
    • QuickActionLayoutLeftRight (Available in API version 28.0 and later.)
    • QuickActionLayoutTopDown (Available in API version 28.0 and later.)

Controls the appearance of an individual field and its column and row position within the highlights panel grid, when Case Feed is enabled. You can have two fields per each grid in a highlights panel.

Introduced in API version 25.0.

  • Type: string
  • Required: No
  • Description: The customLink reference, if the item is a custom link.
  • Type: string
  • Required: No
  • Description: The field name reference, relative to the page layout. Must be a standard or custom field that also exists on the detail page.
  • Type: int
  • Required: Yes
  • Description: Required. The item’s column position in the highlights panel grid. Must be within the range of sizeX.
  • Type: int
  • Required: No
  • Description: Required. The item’s row position in the highlights panel grid. Must be within the range of sizeY.
  • Type: int
  • Required: No
  • Description: Reserved for future use. If provided, the setting is visible to users.

This sample defines a page layout.

This example shows a layout using <summaryLayout>.

This example shows a feed-based layout.

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.