メタデータ API 開発者ガイド
jCustomHelpMenuSection
システム管理者が組織固有のカスタムヘルプリソースを表示するために追加した Lightning Experience のヘルプメニューのセクションを表します。カスタムセクションには、システム管理者が追加したヘルプリソースが含まれます。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
CustomHelpMenuSection コンポーネントのサフィックスは .customHelpMenuSection で、customHelpMenuSections フォルダーに保存されます。
バージョン
CustomHelpMenuSection コンポーネントは、API バージョン 45.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customHelpMenuItems | CustomHelpMenuItems[] | |
| masterLabel | string | 必須。カスタムセクションの名前。Lightning Experience ヘルプメニューに追加できるカスタムセクションは 1 つのみです。最大 80 文字を指定します。 |
CustomHelpMenuItems
カスタムセクションに含まれる項目。最大 15 項目を指定します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| linkURL | string | 必須。リソースの URL。 |
| masterLabel | string | 必須。リソースの名前。最大 100 文字を指定します。 |
| sortOrder | int | 必須。カスタムセクション内の項目の順序。有効な値は 1 ～ 15 です。 |
宣言的なメタデータの定義のサンプル
CustomHelpMenuSection コンポーネントの例を次に示します。
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>前の定義を参照する package.xml の例を次に示します。
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>