CommunityTemplateDefinition | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ファイルのサフィックスおよびディレクトリの場所

CommunityTemplateDefinition コンポーネントのサフィックスは .communityTemplateDefinition で、communityTemplateDefinitions フォルダに保存されます。

バージョン

CommunityTemplateDefinition コンポーネントは、API バージョン 38.0 以降で使用できます。

特別なアクセスルール

この型は、組織で Salesforce デジタルエクスペリエンスが有効になっている場合にのみ使用できます。

項目

項目名	項目の型	説明
baseTemplate	CommunityBaseTemplate (string 型の列挙)	この CommunityTemplateDefinition が API バージョン 41.0 以降で作成されたことを示します。有効な唯一の値は `c` です。この項目は API 41.0 以降で使用できます。
bundlesInfo	CommunityTemplateBundleInfo []	この CommunityTemplateDefinition のプレビュー画像および機能の強調表示のリスト。
category	CommunityTemplateCategory (string 型の列挙)	必須。この CommunityTemplateDefinition の最適化された使用事例。有効な値は、次のとおりです。 `Commerce` `IT` `Marketing` `Sales` `Service`
defaultBrandingSet	string	エクスペリエンスビルダーの [テーマ] パネルで定義される、この CommunityTemplateDefinition に関連付けられた一連のブランドプロパティ。API バージョン 40.0 以降で利用できます。 API バージョン 44.0 以降では、この項目は参照のみで、CommunityThemeDefinition で実装できます。
defaultThemeDefinition	string	必須。この CommunityTemplateDefinition の割り当てられたテーマ定義。
description	string	この CommunityTemplateDefinition の説明テキスト (省略可能)。
enableExtendedCleanUpOnDelete	boolean	デフォルトは false です。この CommunityTemplateDefinition を削除すると、直接的または間接的に参照される他のオブジェクト (CommunityThemeDefinition、Flexipage、または StaticResource など) が自動的に削除されます。値は true または false です。
masterLabel	string	必須。[設定] に表示されるこの CommunityTemplateDefinition の表示ラベル。
navigationLinkSet	NavigationLinkSet	この CommunityTemplateDefinition に関連付けられたナビゲーションメニュー。ナビゲーションメニューは、ユーザがクリックするとサイトの他の部分に移動できる項目で構成されます。API バージョン 37.0 ～ 46.0 で使用可能です。API バージョン 47.0 以降では、NavigationMenu を使用します。
pageSetting	CommunityTemplatePageSetting []	この CommunityTemplateDefinition の FlexiPage のリスト。
publisher	string	[テーマを変更] ウィザードで表示されるパブリッシャーの名前を定義します。名前が指定されていない場合、パッケージのエクスポート元組織の名前が使用されます。この項目は、API バージョン 45.0 以降で使用できます。

CommunityTemplateBundleInfo

項目名	項目の型	説明
description	string	その CommunityTemplateBundleInfo の説明テキスト (省略可能)。
image	string	type が `PreviewImage` の場合にのみ必須��す。それ以外の場合、この項目は省略可能です。この CommunityTemplateDefinition のプレビュー画像。
order	int	必須。その CommunityTemplateDefinition 内の同じ型の他の要素に対するこの CommunityTemplateBundleInfo の位置を指定する整数。`1` は最初の位置、`3` は `PreviewImage` 型の最大位置、`4` は `Highlight` 型の最大位置です。
title	string	必須。コードで使用されるこの CommunityTemplateBundleInfo のタイトル。
type	CommunityTemplateBundleInfoType (string 型の列挙)	必須。エクスポートに含まれるテンプレートに関する説明情報を格納します。エクスペリエンス作成ウィザードのインターフェースは、テンプレートによって強化されます。有効な値は、次のとおりです。 `Highlight` — この CommunityTemplateBundleInfo は、強調表示機能として使用されます。最大 4 件がサポートされます。 `PreviewImage` — この CommunityTemplateBundleInfo は、プレビュー画像として使用されます。最大 3 件がサポートされます。

CommunityTemplatePageSetting

項目名	項目の型	説明
page	string	必須。この CommunityTemplateDefinition の FlexiPage のリスト。
themeLayout	string	必須。テーマレイアウトの FlexiPage の名前。この項目は、API バージョン 39.0 以降で使用できます。

宣言的なメタデータの定義のサンプル

CommunityTemplateDefinition コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<CommunityTemplateDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <baseTemplate>c</baseTemplate>
4    <bundlesInfo>
5        <description>Feature Description</description>
6        <order>1</order>
7        <title>Feature Heading</title>
8        <type>Highlight</type>
9    </bundlesInfo>
10    <bundlesInfo>
11        <image>siteAsset_2dbe594eb6794173af78da264cd6a4a7</image>
12        <order>1</order>
13        <title>Preview Image</title>
14        <type>PreviewImage</type>
15    </bundlesInfo>
16    <category>Sales</category>
17    <defaultThemeDefinition>communityTemplate</defaultThemeDefinition>
18    <description>This is an Experience Builder template</description>
19    <enableExtendedCleanUpOnDelete>true</enableExtendedCleanUpOnDelete>
20    <masterLabel>communityTemplate</masterLabel>
21    <navigationLinkSet>
22        <navigationMenuItem>
23            <label>Topics</label>
24            <position>0</position>
25            <publiclyAvailable>true</publiclyAvailable>
26            <target>ShowMoreTopics</target>
27            <type>NavigationalTopic</type>
28        </navigationMenuItem>
29    </navigationLinkSet>
30    <pageSetting>
31        <page>communityTemplate_Report_List</page>
32        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
33    </pageSetting>
34    <pageSetting>
35        <page>communityTemplate_Topic_Catalog</page>
36        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
37    </pageSetting>
38    <pageSetting>
39        <page>communityTemplate_Check_Password</page>
40        <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
41    </pageSetting>
42    <pageSetting>
43        <page>communityTemplate_Error</page>
44        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
45    </pageSetting>
46    <pageSetting>
47        <page>communityTemplate_User_Settings</page>
48        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
49    </pageSetting>
50    <pageSetting>
51        <page>communityTemplate_Login</page>
52        <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
53    </pageSetting>
54    <pageSetting>
55        <page>communityTemplate_Stream_List</page>
56        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
57    </pageSetting>
58    <pageSetting>
59        <page>communityTemplate_Sfdc_Page</page>
60        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
61    </pageSetting>
62    <pageSetting>
63        <page>communityTemplate_Group_Detail</page>
64        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
65    </pageSetting>
66    <pageSetting>
67        <page>communityTemplate_Report_Related_List</page>
68        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
69    </pageSetting>
70    <pageSetting>
71        <page>communityTemplate_Register</page>
72        <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
73    </pageSetting>
74    <pageSetting>
75        <page>communityTemplate_User_Profile</page>
76        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
77    </pageSetting>
78    <pageSetting>
79        <page>communityTemplate_Case_Detail</page>
80        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
81    </pageSetting>
82    <pageSetting>
83        <page>communityTemplate_Stream_Related_List</page>
84        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
85    </pageSetting>
86    <pageSetting>
87        <page>communityTemplate_Dashboard_Detail</page>
88        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
89    </pageSetting>
90    <pageSetting>
91        <page>communityTemplate_Group_List</page>
92        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
93    </pageSetting>
94    <pageSetting>
95        <page>communityTemplate_Canvasapp_Page</page>
96        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
97    </pageSetting>
98    <pageSetting>
99        <page>communityTemplate_Login_Error</page>
100        <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
101    </pageSetting>
102    <pageSetting>
103        <page>communityTemplate_Create_Record</page>
104        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
105    </pageSetting>
106    <pageSetting>
107        <page>communityTemplate_Group_Related_List</page>
108        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
109    </pageSetting>
110    <pageSetting>
111        <page>communityTemplate_Search</page>
112        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
113    </pageSetting>
114    <pageSetting>
115        <page>communityTemplate_File_Detail</page>
116        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
117    </pageSetting>
118    <pageSetting>
119        <page>communityTemplate_Case_List</page>
120        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
121    </pageSetting>
122    <pageSetting>
123        <page>communityTemplate_User_List</page>
124        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
125    </pageSetting>
126    <pageSetting>
127        <page>communityTemplate_File_List</page>
128        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
129    </pageSetting>
130    <pageSetting>
131        <page>communityTemplate_Question_Detail</page>
132        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
133    </pageSetting>
134    <pageSetting>
135        <page>communityTemplate_Dashboard_List</page>
136        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
137    </pageSetting>
138    <pageSetting>
139        <page>communityTemplate_Related_Record_List</page>
140        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
141    </pageSetting>
142    <pageSetting>
143        <page>communityTemplate_File_Related_List</page>
144        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
145    </pageSetting>
146    <pageSetting>
147        <page>communityTemplate_Record_List</page>
148        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
149    </pageSetting>
150    <pageSetting>
151        <page>communityTemplate_Forgot_Password</page>
152        <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
153    </pageSetting>
154    <pageSetting>
155        <page>communityTemplate_Home</page>
156        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
157    </pageSetting>
158    <pageSetting>
159        <page>communityTemplate_Dashboard_Related_List</page>
160        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
161    </pageSetting>
162    <pageSetting>
163        <page>communityTemplate_Account_Management</page>
164        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
165    </pageSetting>
166    <pageSetting>
167        <page>communityTemplate_Case_Related_List</page>
168        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
169    </pageSetting>
170    <pageSetting>
171        <page>communityTemplate_User_Related_List</page>
172        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
173    </pageSetting>
174    <pageSetting>
175        <page>communityTemplate_Stream_Detail</page>
176        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
177    </pageSetting>
178    <pageSetting>
179        <page>communityTemplate_Topic_Detail</page>
180        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
181    </pageSetting>
182    <pageSetting>
183        <page>communityTemplate_Messages</page>
184        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
185    </pageSetting>
186    <pageSetting>
187        <page>communityTemplate_Report_Detail</page>
188        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
189    </pageSetting>
190    <pageSetting>
191        <page>communityTemplate_Record_Detail</page>
192        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
193    </pageSetting>
194    <pageSetting>
195        <page>communityTemplate_Feed_Detail</page>
196        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
197    </pageSetting>
198    <pageSetting>
199        <page>communityTemplate_Contact_Support</page>
200        <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
201    </pageSetting>
202</CommunityTemplateDefinition>

前の定義を参照する package.xml の例を次に示します。

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

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。