CustomHelpMenuSection

Represents the section of the Lightning Experience help menu that the admin added to display custom, org-specific help resources for the org. The custom section contains help resources added by the admin. This type extends the Metadata metadata type and inherits its fullName field.

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.

Important

File Suffix and Directory Location

CustomHelpMenuSection components have the suffix .customHelpMenuSection and are stored in the customHelpMenuSections folder.

Version

CustomHelpMenuSection components are available in API version 45.0 and later.

Fields

Field Name	Field Type	Description
customHelpMenuItems	CustomHelpMenuItems[]	Items included in the custom section. Specify up to 15 items.
masterLabel	string	Required. Name of the custom section. Only one custom section can be added to the Lightning Experience help menu. Specify up to 80 characters.

CustomHelpMenuItems

Items included in the custom section. Specify up to 15 items.

Field Name	Field Type	Description
linkURL	string	Required. The URL for the resource.
masterLabel	string	Required. The name of the resource. Specify up to 100 characters.
sortOrder	int	Required. The order of the item within the custom section. Valid values are `1` through `15`.

Declarative Metadata Sample Definition

The following is an example of a CustomHelpMenuSection component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomHelpMenuSection xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>MyOrgCustomHelp</masterLabel>
4    <customHelpMenuItems>
5        <linkUrl>https://www.yourcompanyhelp.com/gettingstarted</linkUrl>
6        <masterLabel>Getting Started</masterLabel>
7        <sortOrder>1</sortOrder>
8    </customHelpMenuItems>
9    <customHelpMenuItems>
10        <linkUrl>https://www.yourcompanyhelp.com/features</linkUrl>
11        <masterLabel>Feature to Start Using Right Away</masterLabel>
12        <sortOrder>2</sortOrder>
13    </customHelpMenuItems>
14    <customHelpMenuItems>
15        <linkUrl>https://www.yourcompanyhelp.com/salestips</linkUrl>
16        <masterLabel>Tips for Sales Team Members</masterLabel>
17        <sortOrder>3</sortOrder>
18    </customHelpMenuItems>
19</CustomHelpMenuSection>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>MyOrgCustomHelp</members>
5        <name>CustomHelpMenuSection</name>
6    </types>
7    <version>45.0</version>
8</Package>

Metadata API Developer Guide