HomePageLayout

Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.

For more information, see Salesforce Classic Home Tab Page Layouts in Salesforce Help.

File Suffix and Directory Location

Home page layouts are stored in the homePageLayouts directory of the corresponding package directory. The extension is .homePageLayout.

Version

Home page components are available in API version 12.0 and later. This type extends the Metadata metadata type and inherits its fullName field.

Fields

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

Field Name	Field Type	Description
fullName	string	The name can only contain characters, letters, and the underscore (_) character. The name must start with a letter, and can’t end with an underscore or contain two consecutive underscore characters. Inherited from the Metadata component, this field isn’t defined in the WSDL for this component. It must be specified when creating, updating, or deleting. See create() to see an example of this field specified for a call.
narrowComponents	string[]	The list of elements in the narrow column on the left side of the home page.
wideComponents	string[]	The list of elements in the wide column on the right side of the home page.

Declarative Metadata Sample Definition

The following is the definition of a home page layout. See Declarative Metadata Sample Definition and Declarative Metadata Sample Definition for related samples.

1<?xml version="1.0" encoding="UTF-8"?>
2<HomePageLayout xmlns="http://soap.sforce.com/2006/04/metadata">
3    <narrowComponents>google</narrowComponents>
4</HomePageLayout>

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.

Metadata API Developer Guide