---
schema_version: "1"
id: 33ee8d2be1c15b942bee6687160cb6ca6d1292df59f64730fd5d6be195c313c4
title: Layout
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_layouts.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_layouts.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: da17f2481e626383e9a2190dde7cd5f65e23db492dfa4fdb4184a28b3464f028
description: Represents the metadata associated with a page layout. For more information, see Page Layouts in Salesforce Help.
---
# Layout

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

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

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.

<types\>
    <members\>Idea-Idea Layout</members\>
    <name\>Layout</name\>
</types\>

## File Suffix and Directory Location

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

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

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.

## Version

Layouts are available in API version 13.0 and later.

## Fields

This metadata type represents the valid values that define a page layout.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e129">Field Name</th>

              <th class="featureTableHeader  " id="d606498e132">Field Type</th>

              <th class="featureTableHeader  " id="d606498e135">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">customButtons</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">The custom buttons for this layout. Each button is a reference to
                a <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm" title="Represents a custom button or link defined in a custom object.">WebLink</a>
                on the same object. For example, a ButtonLink refers to a Weblink on
                the same standard or custom object named ButtonLink.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_customconsolecomponent"><a name="field_customconsolecomponent"><!-- --></a>customConsoleComponents</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#CustomConsoleComponent">CustomConsoleComponents</a></td>

              <td class="entry" headers="d606498e135" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">emailDefault</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only relevant if <a class="xref" href="#showEmailCheckbox">showEmailCheckbox</a> is set; indicates
                the default value of that checkbox.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">excludeButtons</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">List of standard buttons to exclude from this layout. For
                example, <samp class="codeph xml"><span class="tag">&lt;excludeButtons</span>&gt;Delete<span class="tag">&lt;/excludeButtons</span>&gt;</samp> excludes
                the <strong class="ph uicontrol">Delete</strong> button from this layout.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">feedLayout</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#FeedLayout">FeedLayout</a></td>

              <td class="entry" headers="d606498e135" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">headers</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">LayoutHeader[] (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d606498e135" data-title="Description">Layout headers are currently only used for tagging, and only
                appear in the UI if tagging is enabled. Valid string values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">PersonalTagging</samp>—tag is private to
                    user.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PublicTagging</samp>—tag is viewable any other
                    user who can access the record.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">layoutSections</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">
                <a class="xref" href="#LayoutSection">LayoutSection</a>[]
              </td>

              <td class="entry" headers="d606498e135" data-title="Description">The main sections of the layout containing fields, s-controls,
                and custom links. The order here determines the layout
                order.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_miniLayout"><a name="field_miniLayout"><!-- --></a>miniLayout</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#MiniLayout">MiniLayout</a></td>

              <td class="entry" headers="d606498e135" data-title="Description"><span class="ph" id="mini_layout_desc"><a name="mini_layout_desc"><!-- --></a>A mini layout is used in the mini view
                  of a record in the Console tab, hover details, and event
                  overlays.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">multilineLayoutFields</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="Description">Fields for the special multiline layout fields that appear in
                OpportunityProduct layouts. These fields are otherwise similar to
                <span class="keyword parmname">miniLayoutFields</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">platformActionList</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#PlatformActionList">PlatformActionList</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">The list of actions and their order that appear in the Salesforce
                mobile app action bar for the layout.<p class="p">This field is available in
                  API version 34.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_quickactionlist"><a name="field_quickactionlist"><!-- --></a>quickActionList</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#QuickActionList">QuickActionList</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="field_quickactionlist_desc"><a name="field_quickactionlist_desc"><!-- --></a>The list of quick actions
                  that display in the full Salesforce site for the page
                  layout.</span> This field is available in API version 28.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_relatedcontent"><a name="field_relatedcontent"><!-- --></a>relatedContent</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#RelatedContent">RelatedContent</a></td>

              <td class="entry" headers="d606498e135" data-title="Description">The Related Content section of the page layout. This field is
                available in API version 29.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">relatedLists</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">
                <a class="xref" href="#RelatedList">RelatedListItem</a>[]
              </td>

              <td class="entry" headers="d606498e135" data-title="Description">The related lists for the layout, listed in the order they appear
                in the user interface.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">relatedObjects</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e135" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">runAssignmentRulesDefault</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only relevant if <a class="xref" href="#showRunAssignmentRulesCheckbox"><span class="keyword parmname">showRunAssignmentRulesCheckbox</span></a>
                is set; indicates the default value of that checkbox.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showEmailCheckbox"><a name="showEmailCheckbox"><!-- --></a>showEmailCheckbox</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only allowed on Case, CaseClose, and Task layouts. If set, a
                checkbox appears to show email.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showHighlightsPanelCheckbox"><a name="showHighlightsPanelCheckbox"><!-- --></a>showHighlightsPanel</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="field_showhighlightspanel"><a name="field_showhighlightspanel"><!-- --></a>If set, the highlights panel
                  displays on pages in the Salesforce console.</span> This field is
                available in API version 22.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showInteractionLogPanelCheckbox"><a name="showInteractionLogPanelCheckbox"><!-- --></a>showInteractionLogPanel</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="show_interactionlog"><a name="show_interactionlog"><!-- --></a>If set, the interaction log displays
                  on pages in the Salesforce console.</span> This field is available
                in API version 22.0 and later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showKnowledgeComponent"><a name="showKnowledgeComponent"><!-- --></a>showKnowledgeComponent</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">
                <span class="ph" id="field_knowledge_sidebar"><a name="field_knowledge_sidebar"><!-- --></a>Only allowed on Case layouts. If
                  set, the Knowledge sidebar displays on cases in the Salesforce
                  console.</span> This field is available in API version 20.0 and
                later.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="showRunAssignmentRulesCheckbox"><a name="showRunAssignmentRulesCheckbox"><!-- --></a>showRunAssignmentRulesCheckbox</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only allowed on Case, Lead, and Account objects. If set, a
                checkbox appears on the page to show assignment rules.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">showSolutionSection</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description">Only allowed on CaseClose layout. If set, the built-in solution
                information section shows up on the page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname" id="field_showSubmitAndAttachButton"><a name="field_showSubmitAndAttachButton"><!-- --></a>showSubmitAndAttachButton</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e135" data-title="Description"><span class="ph" id="field_showSubmitAndAttachButton_desc"><a name="field_showSubmitAndAttachButton_desc"><!-- --></a>Only allowed on
                  Case layout. If set, the <strong class="ph uicontrol">Submit &amp; Add
                    Attachment</strong> button displays on case edit pages to
                  portal users in the Customer Portal.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e129" data-title="Field Name"><span class="keyword parmname">summaryLayout</span></td>

              <td class="entry" headers="d606498e132" data-title="Field Type"><a class="xref" href="#summaryLayout">SummaryLayout</a></td>

              <td class="entry" headers="d606498e135" data-title="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. This field is available in API
                version 18.0 and later.</td>

            </tr>

          </tbody>

        </table>

## CustomConsoleComponents

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. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| primaryTabComponents | [PrimaryTabComponents](#PrimaryTabComponents) | Represents custom console components on primary tabs in the Salesforce console. Available in API version 25.0 and later. |
| subtabComponents | [SubtabComponents](#SubtabComponents) | Represents custom console components on subtabs in the Salesforce console. Available in API version 25.0 and later. |

## PrimaryTabComponents

Represents custom console components on primary tabs in the Salesforce console. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| component | [ConsoleComponent](#ConsoleComponent)\[\] | 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. |
| containers | [Container](#Container)\[\] | 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). This field is available in API version 30.0 and later. |

## ConsoleComponent

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. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| height | int | 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. |
| location | string | 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. |
| visualforcePage | string | Required. The unique name of the custom console component. For example, ConsoleComponentPage. |
| width | int | 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. |

## Container

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. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e792">Field Name</th>

              <th class="featureTableHeader  " id="d606498e795">Field Type</th>

              <th class="featureTableHeader  " id="d606498e798">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required for components with a location of top or bottom. The
                height of the components’ container. The <a class="xref" href="#unitField"><span class="keyword parmname">unit</span></a> field determines the unit
                of measurement, in pixels or percent.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">isContainerAutoSizeEnabled</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. If set to <samp class="codeph nolang">true</samp>,
                stacked console components in the sidebars autosize vertically. Set
                to <samp class="codeph nolang">true</samp> by default for newly
                created console components. Available in API version 32.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">region</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. The location of the components’ container. Valid
                values include:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">right</samp></li>

                  <li class="li"><samp class="codeph nolang">left</samp></li>

                  <li class="li"><samp class="codeph nolang">top</samp></li>

                  <li class="li"><samp class="codeph nolang">bottom</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">sidebarComponents</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">
                <a class="xref" href="#SidebarComponent">SidebarComponent</a>[]
              </td>

              <td class="entry" headers="d606498e798" data-title="Description">Represents a specific custom console component to display in the
                components’ container.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">style</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. The style of the container to display multiple
                components. Valid values include:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">stack</samp>—a content
                    area with multiple frames.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">tabs</samp>—a single
                    content area with a list of multiple panels.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">accordian</samp>—a
                    collapsible content area.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname" id="unitField"><a name="unitField"><!-- --></a>unit</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required. The unit of measurement, in pixels or percent, for the
                height or width of the components’ container. <p class="p">Pixel values
                  are simply the number of pixels, for example, <samp class="codeph nolang">500</samp>, and must be greater than 0
                  but less than 999. Percentage values must include the percent
                  sign, for example, <samp class="codeph nolang">20%</samp>, and
                  must be greater than 0 but less than 100.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e792" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d606498e795" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e798" data-title="Description">Required for components with a location of right or left. The
                width of the components’ container. The
                <span class="keyword parmname">unit</span> field determines the unit of
                measurement, in pixels or percent.
              </td>

            </tr>

          </tbody>

        </table>

## SidebarComponent

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). Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e986">Field Name</th>

              <th class="featureTableHeader  " id="d606498e989">Field Type</th>

              <th class="featureTableHeader  " id="d606498e992">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">componentType</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">Specifies the component type. Valid values are <samp class="codeph nolang">KnowledgeOne</samp>, <samp class="codeph nolang">Lookup</samp>, <samp class="codeph nolang">Milestones</samp>, <samp class="codeph nolang">RelatedList</samp>, <samp class="codeph nolang">Topics</samp>, <samp class="codeph nolang">Files</samp>,
                and <samp class="codeph nolang">CaseExperts</samp>. This field is
                available in API version 31.0 and later. The <samp class="codeph nolang">Files</samp> and <samp class="codeph nolang">CaseExperts</samp> values are available in
                API version 32.0 and later.
                <p class="p">Case Experts is available through a pilot program.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">createAction</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a lookup field, the name of the quick action
                used to create a record. This field is available in API version 42.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">enableLinking</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e992" data-title="Description">
                <p class="p">If the component is a lookup field, lets users associate a record
                  with this field. This field is available in API version 42.0 and
                  later.</p>

                <p class="p">If false, the createAction and updateAction can’t be
                  retrieved.</p>

              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e992" data-title="Description">Required for components with a location of top or bottom. The
                height of the component in the container. The
                <span class="keyword parmname">unit</span> field determines the unit of
                measurement, in pixels or percent.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">lookup</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a lookup field, the name of the
                field.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a Visualforce page, the name of the
                Visualforce page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">relatedlists</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">
                <a class="xref" href="#RelatedList2">RelatedList</a>[]
              </td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a related list, the name of the list. This
                field is available in API version 31.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname" id="unitField2"><a name="unitField2"><!-- --></a>unit</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">The unit of measurement, in pixels or percent, for the height or
                width of the component in the container. <p class="p">Pixel values are simply
                  the number of pixels, for example, <samp class="codeph nolang">500</samp>, and must be greater than 0 but less than 999.
                  Percentage values must include the percent sign, for example,
                  <samp class="codeph nolang">20%</samp>, and must be
                  greater than 0 but less than 100.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">updateAction</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e992" data-title="Description">If the component is a lookup field, the name of the quick action
                used to update a record. This field is available in API version 42.0
                and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e986" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d606498e989" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e992" data-title="Description">Required for components with a location of right or left. The
                width of the component in the container. The
                <span class="keyword parmname">unit</span> field determines the unit of
                measurement, in pixels or percent.
              </td>

            </tr>

          </tbody>

        </table>

## RelatedList

Represents related list custom components on the sidebars of the Salesforce console. Available in API version 31.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| hideOnDetail | boolean | If set to true, the related list is hidden from detail pages where it appears as a component to prevent duplicate information from showing. |
| name | string | The name of the component as it appears to console users. |

## SubtabComponents

Represents custom console components on subtabs in the Salesforce console. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| component | [ConsoleComponent](#ConsoleComponent)\[\] | 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. |
| containers | [Container](#Container)\[\] | 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). This field is available in API version 30.0 and later. |

## FeedLayout

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. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d606498e1369">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1372">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1375">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">autocollapsePublisher</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Specifies whether the publisher is automatically collapsed when
                the page loads (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">compactFeed</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description"><span class="ph" id="compactFeed"><a name="compactFeed"><!-- --></a>Specifies whether the feed-based page layout
                  uses a compact feed (<samp class="codeph nolang">true</samp>)
                  or not (<samp class="codeph nolang">false</samp>). If set to
                  <samp class="codeph nolang">true</samp>, feed items on the
                  page are collapsed by default, and the feed view has an updated
                  design.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">feedFilterPosition</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">FeedLayoutFilterPosition (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Where the feed filters list is included in the layout. Valid
                values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">centerDropDown</samp>—as a dropdown list in the
                    center column.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">leftFixed</samp>—as a
                    fixed list in the left column.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">leftFloat</samp>—as a
                    floating list in the left column.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">feedFilters</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">
                <a class="xref" href="#FeedLayoutFilter">FeedLayoutFilter</a>[]
              </td>

              <td class="entry" headers="d606498e1375" data-title="Description">The individual filters displayed in the feed filters
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">fullWidthFeed</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Specifies whether the feed expands horizontally to take up all
                available space on the page (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">hideSidebar</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e1375" data-title="Description">Specifies whether the sidebar is hidden (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">leftComponents</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">
                <a class="xref" href="#FeedLayoutComponent">FeedLayoutComponent</a>[]
              </td>

              <td class="entry" headers="d606498e1375" data-title="Description">The individual components displayed in the left column of the
                feed view.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1369" data-title="Field Name"><span class="keyword parmname">rightComponents</span></td>

              <td class="entry" headers="d606498e1372" data-title="Field Type">
                <a class="xref" href="#FeedLayoutComponent">FeedLayoutComponent</a>[]
              </td>

              <td class="entry" headers="d606498e1375" data-title="Description">The individual components displayed in the right column of the
                feed view.</td>

            </tr>

          </tbody>

        </table>

## FeedLayoutComponent

Represents a component in the feed view of a feed-based page layout. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d606498e1573">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1576">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1579">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e1573" data-title="Field Name"><span class="keyword parmname">componentType</span></td>

              <td class="entry" headers="d606498e1576" data-title="Field Type">FeedLayoutComponentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1579" data-title="Description">Required. The type of component. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">HelpAndToolLinks</samp>—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.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomButtons</samp>—a
                    custom button.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Following</samp>—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).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Followers</samp>—a list
                    of users who follow the record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomLinks</samp>—a
                    custom link.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Milestones</samp>—the
                    milestone tracker, which lets users see the status of a
                    milestone on a case. Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Topics</samp>—a list of
                    topics related to the record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CaseUnifiedFiles</samp>—a list
                    of all files that are attached to the case.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Visualforce</samp>—a
                    custom Visualforce component.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1573" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e1576" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e1579" data-title="Description">The height, in pixels, of the component. Doesn’t apply to <samp class="codeph nolang">standardComponents</samp>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1573" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d606498e1576" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e1579" data-title="Description">The name of a Visualforce page being used as a custom
                component.</td>

            </tr>

          </tbody>

        </table>

## FeedLayoutFilter

Represents a feed filter option in the feed view of a feed-based page layout. A filter must have only standardFilter or feedItemType set. Available in API version 30.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d606498e1713">Field Name</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1716">Field Type</th>

              <th class="featureTableHeader vertical-align-top " id="d606498e1719">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e1713" data-title="Field Name"><span class="keyword parmname">feedFilterName</span></td>

              <td class="entry" headers="d606498e1716" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e1719" data-title="Description">The name of a CustomFeedFilter component. Names are prefixed with
                the name of the parent object. For example,
                <kbd class="ph userinput">Case.MyCustomFeedFilter</kbd>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1713" data-title="Field Name"><span class="keyword parmname">feedFilterType</span></td>

              <td class="entry" headers="d606498e1716" data-title="Field Type">FeedLayoutFilterType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1719" data-title="Description">The type of filter. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">AllUpdates</samp>—shows
                    all feed items on a record.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FeedItemType</samp>—shows feed items only for a
                    particular type of activity on the record.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e1713" data-title="Field Name"><span class="keyword parmname">feedItemType</span></td>

              <td class="entry" headers="d606498e1716" data-title="Field Type">FeedItemType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e1719" data-title="Description">The type of feed item to display. Valid values are:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ActivityEvent</samp>—feed items related to
                    activity on tasks and events associated with a case.
                    Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AdvancedTextPost</samp>–feed items related to
                    group announcements posted on a feed. This value is
                    available in API version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AnnouncementPost</samp>–Not used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ApprovalPost</samp>—feed items related to
                    approvals that are submitted on a feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">AttachArticleEvent</samp>—feed items for activity
                    related to attaching articles to cases. Available only on
                    Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BasicTemplateFeedItem</samp>—Not used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CallLogPost</samp>—feed
                    items for activity from the Log a Call action. Available
                    only on layouts for objects that support Activities (tasks
                    and events).
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CanvasPost</samp>—feed
                    items related to posts that a canvas app makes on a
                    feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CaseCommentPost</samp>—feed items for activity
                    from the Case Note action. Available only on Case
                    layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChangeStatusPost</samp>—feed items for activity
                    from the Change Status action. Available only on Case
                    layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ChatTranscriptPost</samp>—feed items for activity
                    related to attaching Chat transcripts to cases. Available
                    only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CollaborationGroupCreated</samp>—feed items
                    related to creating a public group.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CollaborationGroupUnarchived</samp>—Not
                    used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ContentPost</samp>—feed
                    items related to attaching a file to a post.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CreatedRecordEvent</samp>—feed items related to
                    creating a record from the publisher.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">DashboardComponentSnapshot</samp>—feed items
                    related to posting a dashboard snapshot on a feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">EmailMessageEvent</samp>—feed items for activity
                    from the Email action. Available only on Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">FacebookPost</samp>—Not
                    used.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LinkPost</samp>—feed
                    items related to attaching a URL to a post.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">MilestoneEvent</samp>—feed items for changes to
                    the milestone status on a case. Available only on Case
                    layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">PollPost</samp>—feed
                    items related to posting a poll on a feed.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ProfileSkillPost</samp>—feed items related to
                    skills added to a user’s Chatter profile. This value
                    is available in API version 31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QuestionPost</samp>—feed items related to posting
                    a question on a feed. This value is available in API version
                    31.0 and later.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ReplyPost</samp>—feed
                    items for activity from the Portal action. Available only on
                    Case layouts.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">RypplePost</samp>—feed
                    items related to creating a Thanks badge in WDC.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SocialPost</samp>—feed
                    items for activity on Twitter from the Social Post
                    action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TextPost</samp>—feed
                    items for creating a text post from the publisher.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang" id="type_trackedchange"><a name="type_trackedchange"><!-- --></a>TrackedChange</samp>—feed items related to a
                    change or group of changes to a tracked field.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">UserStatus</samp>—Not
                    used.
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## MiniLayout

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

| Field Name | Field Type | Description |
| --- | --- | --- |
| fields | string\[\] | 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. |
| relatedLists | [RelatedListItem](#RelatedList)\[\] | 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. |

## LayoutSection

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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2034">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2037">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2040">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">customLabel</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2040" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">detailHeading</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2040" data-title="Description">Controls if this section appears in the detail page. In the UI,
                this setting corresponds to the checkbox in the section details
                dialog.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">editHeading</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2040" data-title="Description">Controls if this section appears in the edit page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">label</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2040" data-title="Description">The label; either standard or custom, based on the
                <span class="keyword parmname">customLabel</span> flag.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">layoutColumns</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">
                <a class="xref" href="#LayoutColumn">LayoutColumn</a>[]
              </td>

              <td class="entry" headers="d606498e2040" data-title="Description">The columns of the layout, depending on the style. 1, 2, or 3
                columns, ordered left to right, are possible.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2034" data-title="Field Name"><span class="keyword parmname">style</span></td>

              <td class="entry" headers="d606498e2037" data-title="Field Type">LayoutSectionStyle (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e2040" data-title="Description">The style of the layout:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">TwoColumnsTopToBottom</samp> -
                    Two columns, tab goes top to bottom
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">TwoColumnsLeftToRight</samp> -
                    Two columns, tab goes left to right
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OneColumn</samp> - One
                    column
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomLinks</samp> - Contains
                    custom links only
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## LayoutColumn

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

| Field Name | Field Type | Description |
| --- | --- | --- |
| layoutItems | [LayoutItem](#LayoutItem)\[\] | The individual items within a column (ordered from top to bottom). |
| reserved | string | This field is reserved for Salesforce. The field resolves an issue with some SOAP libraries. Any value entered in the field is ignored. |

## LayoutItem

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.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2254">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2257">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2260">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">behavior</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">UiBehavior (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Determines the field behavior. Valid string values:<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Edit</samp>—The layout
                    field can be edited but isn’t required.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Required</samp>—The
                    layout field can be edited and is required.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Readonly</samp>—The
                    layout field is read-only.
                  </li>

                </ul>
                <p class="p">Explicitly
                  specifying UiBehavior for Knowledge articles results in an
                  exception.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">canvas</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">
                <span class="ph" id="layoutitem_canvas_short_desc"><a name="layoutitem_canvas_short_desc"><!-- --></a>Reference to a canvas
                  app.</span>
                <p class="p">This field is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">component</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Reference to a component. Value must be
                <kbd class="ph userinput">sfa:socialCard</kbd>.<p class="p">This field is available
                  in API version 30.0 and later. This field is allowed only inside
                  a <span class="keyword parmname">RelatedContentItem</span>.
                  <kbd class="ph userinput">sfa:socialCard</kbd> is supported only on
                  page layouts for contacts, accounts, and leads.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">customLink</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">The <span class="keyword parmname">customLink</span> reference. This field is
                allowed only inside a <span class="keyword parmname">CustomLink</span>
                <span class="keyword parmname">layoutSection</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">emptySpace</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Controls if this layout item is a blank space.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">field</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">The field name reference, relative to the layout object, for
                example <samp class="codeph nolang">Description</samp> or <samp class="codeph nolang">MyField__c</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, the height in pixels.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">page</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Reference to a Visualforce page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="analyticsCloud_component"><a name="analyticsCloud_component"><!-- --></a>analyticsCloudComponent</span></span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type"><a class="xref" href="#analyticsCloud_layoutitem">AnalyticsCloudComponentLayoutItem</a></td>

              <td class="entry" headers="d606498e2260" data-title="Description">
                <span class="ph" id="analyticsCloud_component_desc"><a name="analyticsCloud_component_desc"><!-- --></a>Refers to a CRM Analytics
                  dashboard that you can add to a standard or custom object
                  page.</span>
                <p class="p">This field is available in API version 34.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname"><span class="ph" id="reportChart_component"><a name="reportChart_component"><!-- --></a>reportChartComponent</span></span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type"><a class="xref" href="#reportchart_layoutitem">ReportChartComponentLayoutItem</a></td>

              <td class="entry" headers="d606498e2260" data-title="Description"><span class="ph" id="reportChart_component_desc"><a name="reportChart_component_desc"><!-- --></a>Refers to a report chart that
                  you can add to a standard or custom object page.</span></td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">scontrol</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">Reference to an s-control.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">showLabel</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, whether to show the label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">showScrollbars</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, whether to show scrollbars.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2254" data-title="Field Name"><span class="keyword parmname">width</span></td>

              <td class="entry" headers="d606498e2257" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2260" data-title="Description">For s-control and pages only, the width in pixels or percent.
                Pixel values are simply the number of pixels, for example, <samp class="codeph nolang">500</samp>. Percentage values must include
                the percent sign, for example, <samp class="codeph nolang">20%</samp>.</td>

            </tr>

          </tbody>

        </table>

## AnalyticsCloudComponentLayoutItem

Represents the settings for a CRM Analytics dashboard on a standard or custom page. Available in API version 34.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| assetType | string | Required. Specifies the type of CRM Analytics asset to add. The available asset type is dashboard. |
| devName | string | Required. Unique development name of the dashboard to add. |
| error | string | Error string; only populated if an error occurred in the underlying dashboard. |
| filter | string | 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. |
| height | int | Specifies the height of the dashboard, in pixels. The default is 400. |
| hideOnError | boolean | 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. |
| showSharing | boolean | 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. This field is available in API version 37.0 and later. |
| showTitle | boolean | If true, includes the dashboard’s title above the dashboard. If false, the dashboard appears without a title. The default is true. |
| width | string | 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%. |

## ReportChartComponentLayoutItem

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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2744">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2747">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2750">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">cacheData</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">
                <span class="ph" id="meta_reportChartCompLayoutItem_cacheData"><a name="meta_reportChartCompLayoutItem_cacheData"><!-- --></a>Indicates
                  whether to use cached data when displaying the chart. When the
                  attribute is set to <samp class="codeph nolang">true</samp>,
                  data is cached for 24 hours. If the attribute is set to <samp class="codeph nolang">false</samp>, the report isn’t run
                  every time the page is refreshed.</span>
                <p class="p">This field is available
                  in API version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">contextFilterableField</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2750" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">error</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2750" data-title="Description">
                <span class="ph" id="meta_reportChartCompLayoutItem_error"><a name="meta_reportChartCompLayoutItem_error"><!-- --></a>Error string; only
                  populated if an error occurred in the underlying
                  report.</span>
                <p class="p">This field is available in API version 31.0 and
                  later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">hideOnError</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">
                <span class="ph" id="meta_reportChartCompLayoutItem_hideOnError"><a name="meta_reportChartCompLayoutItem_hideOnError"><!-- --></a>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
                  <samp class="codeph nolang">true</samp> to hide the chart
                  from a page on error.</span>
                <p class="p">This field is available in API
                  version 29.0 and later.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">includeContext</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">If <samp class="codeph nolang">true</samp>, filters the report
                chart to return data that’s relevant to the page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">reportName</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2750" data-title="Description">Unique development name of a report that includes a
                chart.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">showTitle</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">boolean</td>

              <td class="entry" headers="d606498e2750" data-title="Description">If <samp class="codeph nolang">true</samp>, applies the title
                from the report to the chart.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2744" data-title="Field Name"><span class="keyword parmname">size</span></td>

              <td class="entry" headers="d606498e2747" data-title="Field Type">
                <p class="p">ReportChartComponentSize</p>
                (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)
              </td>

              <td class="entry" headers="d606498e2750" data-title="Description"> The chart size is medium when no value is specified. Valid values:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">SMALL</samp></li>

                  <li class="li"><samp class="codeph nolang">MEDIUM</samp></li>

                  <li class="li"><samp class="codeph nolang">LARGE</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## PlatformActionList

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

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e2932">Field Name</th>

              <th class="featureTableHeader  " id="d606498e2935">Field Type</th>

              <th class="featureTableHeader  " id="d606498e2938">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e2932" data-title="Field Name"><span class="keyword parmname">actionListContext</span></td>

              <td class="entry" headers="d606498e2935" data-title="Field Type">PlatformActionListContext (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e2938" data-title="Description">Required. The context of the action list. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Assistant</samp></li>

                  <li class="li"><samp class="codeph nolang">BannerPhoto</samp></li>

                  <li class="li"><samp class="codeph nolang">Chatter</samp></li>

                  <li class="li"><samp class="codeph nolang">Dockable</samp></li>

                  <li class="li"><samp class="codeph nolang">FeedElement</samp></li>

                  <li class="li"><samp class="codeph nolang">Flexipage</samp></li>

                  <li class="li"><samp class="codeph nolang">Global</samp></li>

                  <li class="li"><samp class="codeph nolang">ListView</samp></li>

                  <li class="li"><samp class="codeph nolang">ListViewDefinition</samp></li>

                  <li class="li"><samp class="codeph nolang">ListViewRecord</samp></li>

                  <li class="li"><samp class="codeph nolang">Lookup</samp></li>

                  <li class="li"><samp class="codeph nolang">MruList</samp></li>

                  <li class="li"><samp class="codeph nolang">MruRow</samp></li>

                  <li class="li"><samp class="codeph nolang">ObjectHomeChart</samp></li>

                  <li class="li"><samp class="codeph nolang">Photo</samp></li>

                  <li class="li"><samp class="codeph nolang">Record</samp></li>

                  <li class="li"><samp class="codeph nolang">RecordEdit</samp></li>

                  <li class="li"><samp class="codeph nolang">RelatedList</samp></li>

                  <li class="li"><samp class="codeph nolang">RelatedListRecord</samp></li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2932" data-title="Field Name"><span class="keyword parmname">platformActionListItems</span></td>

              <td class="entry" headers="d606498e2935" data-title="Field Type">
                <a class="xref" href="#PlatformActionListItem">PlatformActionListItem</a>[]
              </td>

              <td class="entry" headers="d606498e2938" data-title="Description">The actions in the PlatformActionList.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e2932" data-title="Field Name"><span class="keyword parmname">relatedSourceEntity</span></td>

              <td class="entry" headers="d606498e2935" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e2938" data-title="Description">When the <span class="keyword parmname">ActionListContext</span> is RelatedList or
                RelatedListRecord, this field represents the API name of the related
                list to which the action belongs.</td>

            </tr>

          </tbody>

        </table>

## PlatformActionListItem

PlatformActionListItem represents an action in the PlatformActionList. Available in API version 34.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e3102">Field Name</th>

              <th class="featureTableHeader  " id="d606498e3105">Field Type</th>

              <th class="featureTableHeader  " id="d606498e3108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">actionName</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The API name for the action in the list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">actionType</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">PlatformActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The type of action. Valid values are: <a name="PlatformActionTypeEnumValues"><!-- --></a>
                <ul class="ul bulletList" id="PlatformActionTypeEnumValues">
                  <li class="li">
                    <samp class="codeph nolang">ActionLink</samp>—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.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">CustomButton</samp>—When clicked, opens a URL or a
                    Visualforce page in a window or executes JavaScript.
                  </li>

                  <li class="li"><samp class="codeph nolang">InvocableAction</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">ProductivityAction</samp>—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.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp>—A
                    global or object-specific action.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">StandardButton</samp>—A
                    predefined Salesforce button such as New, Edit, and
                    Delete.
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The placement of the action in the list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3102" data-title="Field Name"><span class="keyword parmname">subtype</span></td>

              <td class="entry" headers="d606498e3105" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3108" data-title="Description">The subtype of the action. For quick actions, the subtype is
                <samp class="codeph nolang">QuickActionType</samp>. For custom
                buttons, the subtype is <samp class="codeph nolang">WebLinkTypeEnum</samp>. For action links, subtypes are
                <samp class="codeph nolang">Api</samp>, <samp class="codeph nolang">ApiAsync</samp>, <samp class="codeph nolang">Download</samp>, and <samp class="codeph nolang">Ui</samp>. Standard buttons and
                productivity actions have no subtype.
              </td>

            </tr>

          </tbody>

        </table>

## QuickActionList

QuickActionList represents the list of actions associated with the page layout. Available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| quickActionListItems | [QuickActionListItem](#QuickActionListItem)\[\] | Array of zero or more QuickActionList objects. |

## QuickActionListItem

QuickActionListItem represents an action in the QuickActionList. Available in API version 28.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| quickActionName | string | The API name of the action. |

## RelatedContent

RelatedContent represents the Mobile Cards section of the page layout. Available in API version 29.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| relatedContentItems | [RelatedContentItem](#RelatedContentItem)\[\] | A list of layout items in the Mobile Cards section of the page layout. |

## RelatedContentItem

RelatedContentItem represents an individual item in the [RelatedContentItem](#RelatedContentItem) list. Available in API version 29.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| layoutItem | [LayoutItem](#LayoutItem) | An individual [LayoutItem](#LayoutItem) in the Mobile Cards section. |

## RelatedListItem

RelatedListItem represents a related list in a page layout.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e3472">Field Name</th>

              <th class="featureTableHeader  " id="d606498e3475">Field Type</th>

              <th class="featureTableHeader  " id="d606498e3478">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">customButtons</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of custom buttons that are used on the related
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">excludeButtons</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of buttons that are excluded from the related
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">fields</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of fields that are displayed in the related
                list.<p class="p">Retrieval of standard fields on related lists uses
                  aliases instead of field or API names. For example, the
                  <span class="keyword parmname">Fax</span>, <span class="keyword parmname">Mobile</span>, and
                  <span class="keyword parmname">Home Phone</span> fields are retrieved as
                  Phone2, Phone3, and Phone4, respectively.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">quickActions</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string[]</td>

              <td class="entry" headers="d606498e3478" data-title="Description">A list of quick actions that are used on the related
                list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">relatedList</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3478" data-title="Description">Required. The name of the related list.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">sortField</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3478" data-title="Description">The name of the field that is used for sorting.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3472" data-title="Field Name"><span class="keyword parmname">sortOrder</span></td>

              <td class="entry" headers="d606498e3475" data-title="Field Type">SortOrder (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e3478" data-title="Description">If the <span class="keyword parmname">sortField</span> is set, the
                <span class="keyword parmname">sortOrder</span> field determines the sort order.<ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">Asc</samp> - Sort in ascending
                    order
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Desc</samp> - Sort in
                    descending order
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## SummaryLayout

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. Available in API version 25.0 and later.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d606498e3639">Field Name</th>

              <th class="featureTableHeader  " id="d606498e3642">Field Type</th>

              <th class="featureTableHeader  " id="d606498e3645">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">string</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Required. The name of the layout label.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">sizeX</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Required. Number of columns in the highlights pane, from 1
                through 4 (inclusive).</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">sizeY</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Required. Number of rows in each column, either 1 or
                2.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">sizeZ</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">int</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Reserved for future use. If provided, the setting is
                visible to users.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">summaryLayoutItems</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">
                <a class="xref" href="#summaryLayoutItem">SummaryLayoutItem</a>[]
              </td>

              <td class="entry" headers="d606498e3645" data-title="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.</td>

            </tr>

            <tr>
              <td class="entry" headers="d606498e3639" data-title="Field Name"><span class="keyword parmname">summaryLayoutStyle</span></td>

              <td class="entry" headers="d606498e3642" data-title="Field Type">SummaryLayoutStyle (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type
                string)</td>

              <td class="entry" headers="d606498e3645" data-title="Description">Highlights panel style. Valid string values are:<ul class="ul bulletList">
                  <li class="li">Default</li>

                  <li class="li">QuoteTemplate</li>

                  <li class="li">DefaultQuoteTemplate</li>

                  <li class="li">CaseInteraction</li>

                  <li class="li">QuickActionLayoutLeftRight (Available in API version
                    28.0 and later.)</li>

                  <li class="li">QuickActionLayoutTopDown (Available in API version 28.0
                    and later.)</li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## SummaryLayoutItem

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. Available in API version 25.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| customLink | string | The customLink reference, if the item is a custom link. |
| field | string | The field name reference, relative to the page layout. Must be a standard or custom field that also exists on the detail page. |
| posX | int | Required. The item’s column position in the highlights panel grid. Must be within the range of [sizeX](#sizeXDef). |
| posY | int | Required. The item’s row position in the highlights panel grid. Must be within the range of [sizeY](#sizeYDef). |
| posZ | int | Reserved for future use. If provided, the setting is visible to users. |

## Declarative Metadata Sample Definition

This sample defines a page layout.

<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
   <customConsoleComponents\>
    <primaryTabComponents\>
       <container\>
           <region\>left</region\>
          <style\>Stack</style\>
          <unit\>Pixel</unit\>
          <width\>101</width\>
          <sidebarComponent\>
                <width\>60</width\>
                <page\>simplepage1</page\>
                <unit\>Percentage</unit\>
          </sidebarComponent\>
          <sidebarComponent\>
                <width\>40</width\>
                <page\>Hello\_World</page\>
                <unit\>Percentage</unit\>
          </sidebarComponent\>
       </container\>
    </primaryTabComponents\>
    <subtabComponents\>
       <component\>
          <location\>top</location\>
          <visualforcePage\>ConsoleComponentPage2</visualforcePage\>
          <height\>200</height\>
       </component\>
    </subtabComponents\>
   </customConsoleComponents\>
    <customButtons\>ButtonLink</customButtons\>
    <layoutSections\>
        <editHeading\>true</editHeading\>
        <label\>Information</label\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Required</behavior\>
                <field\>Name</field\>
            </layoutItems\>
            <layoutItems\>
                <height\>180</height\>
                <scontrol\>LayoutSControl</scontrol\>
                <showLabel\>true</showLabel\>
                <showScrollbars\>true</showScrollbars\>
                <width\>50%</width\>
            </layoutItems\>
            <layoutItems\>
                <reportChartComponent\>
                   <contextFilterableField\>CUST\_ID</contextFilterableField\>
                   <includeContext\>true</includeContext\>
                   <reportName\>Open\_Accounts\_by\_Cases</reportName\>
                   <showTitle\>false</showTitle\>
                   <size\>LARGE</size\>
                <reportChartComponent\>
            </layoutItems\>
        </layoutColumns\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Edit</behavior\>
                <field\>OwnerId</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Edit</behavior\>
                <field\>CurrencyIsoCode</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>TwoColumnsTopToBottom</style\>
    </layoutSections\>
    <layoutSections\>
        <editHeading\>true</editHeading\>
        <label\>System Information</label\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>CreatedById</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>Alpha1\_\_c</field\>
            </layoutItems\>
            <layoutItems\>
                <height\>200</height\>
                <page\>mcanvasPage</page\>
                <showLabel\>true</showLabel\>
                <showScrollbars\>false</showScrollbars\>
                <width\>100%</width\>
            </layoutItems\>
        </layoutColumns\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>LastModifiedById</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Edit</behavior\>
                <field\>TextArea\_\_c</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>TwoColumnsTopToBottom</style\>
    </layoutSections\>
    <layoutSections\>
        <customLabel\>true</customLabel\>
        <detailHeading\>true</detailHeading\>
        <label\>Custom Links</label\>
        <layoutColumns\>
            <layoutItems\>
                <customLink\>CustomWebLink</customLink\>
            </layoutItems\>
        </layoutColumns\>
        <style\>CustomLinks</style\>
    </layoutSections\>
     <quickActionList\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.TextPost</quickActionName\>
        </quickActionListItems\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.ContentPost</quickActionName\>
        </quickActionListItems\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.LinkPost</quickActionName\>
        </quickActionListItems\>
        <quickActionListItems\>
            <quickActionName\>FeedItem.PollPost</quickActionName\>
        </quickActionListItems\>
    </quickActionList\>
    <relatedContent\>
        <relatedContentItems\>
            <layoutItem\>
                <component\>sfa:socialPanel</component\>
            </layoutItem\>
        <relatedContentItems\>
    </relatedContent\>
    <miniLayoutFields\>Name</miniLayoutFields\>
    <miniLayoutFields\>OwnerId</miniLayoutFields\>
    <miniLayoutFields\>CurrencyIsoCode</miniLayoutFields\>
    <miniLayoutFields\>Alpha1\_\_c</miniLayoutFields\>
    <miniLayoutFields\>TextArea\_\_c</miniLayoutFields\>
    <miniRelatedLists\>
        <relatedList\>RelatedNoteList</relatedList\>
    </miniRelatedLists\>
    <relatedLists\>
        <fields\>StepStatus</fields\>
        <fields\>CreatedDate</fields\>
        <fields\>OriginalActor</fields\>
        <fields\>Actor</fields\>
        <fields\>Comments</fields\>
        <fields\>Actor.Alias</fields\>
        <fields\>OriginalActor.Alias</fields\>
        <relatedList\>RelatedProcessHistoryList</relatedList\>
    </relatedLists\>
    <relatedLists\>
        <relatedList\>RelatedNoteList</relatedList\>
    </relatedLists\>
</Layout\>

This example shows a layout using <summaryLayout\>.

<?xml version="1.0" encoding="UTF-8"?>
<Layout xmlns="http://soap.sforce.com/2006/04/metadata">
    <layoutSections\>
        <editHeading\>true</editHeading\>
        <label\>System Information</label\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>CreatedById</field\>
            </layoutItems\>
            <layoutItems\>
                <behavior\>Required</behavior\>
                <field\>Name</field\>
            </layoutItems\>
        </layoutColumns\>
        <layoutColumns\>
            <layoutItems\>
                <behavior\>Readonly</behavior\>
                <field\>LastModifiedById</field\>
            </layoutItems\>
        </layoutColumns\>
        <style\>TwoColumnsTopToBottom</style\>
    </layoutSections\>
    <summaryLayout\>
        <masterLabel\>Great Name</masterLabel\>
        <sizeX\>4</sizeX\>
        <sizeY\>2</sizeY\>
        <summaryLayoutItems\>
            <posX\>0</posX\>
            <posY\>0</posY\>
            <field\>Name</field\>
        </summaryLayoutItems\>
    </summaryLayout\>
</Layout\>

This example shows a feed-based layout.

<Layout\>
...
    <feedLayout\>
        <leftComponents\>
            <componentType\>customLinks</componentType\>
        </leftComponents\>
        <rightComponents\>
            <componentType\>follow</componentType\>
        </rightComponents\>
        <rightComponents\>
            <componentType\>followers</componentType\>
        </rightComponents\>
        <rightComponents\>
            <componentType\>visualforce</componentType\>
            <page\>accountCustomWidget</page\>
            <height\>200</height\>
        </rightComponents\>
        <hideSidebar\>true</hideSidebar\>
        <feedFilterPosition\>centerDropDown</feedFilterPosition\>
        <feedFilters\>
    <feedFilerType\>allUpdates</feedFilerType\>
        </feedFilters\>
        <feedFilters\>
    <feedFilerType\>feedItemType</feedFilerType\>
    <feedItemType\>CallLogPost</feedItemType\>
        </feedFilters\>
        <feedFilters\>
    <feedFilerType\>feedItemType</feedFilerType\>
    <feedItemType\>TextPost</feedItemType\>
        </feedFilters\>
    </feedLayout\>
...
</Layout\>

## Wildcard Support in the Manifest File

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](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").