メタデータ API 開発者ガイド
jCommunityTemplateDefinition
ファイルのサフィックスおよびディレクトリの場所
CommunityTemplateDefinition コンポーネントのサフィックスは .communityTemplateDefinition で、communityTemplateDefinitions フォルダに保存されます。
バージョン
CommunityTemplateDefinition コンポーネントは、API バージョン 38.0 以降で使用できます。
特別なアクセスルール
この型は、組織で Salesforce コミュニティが有効になっている場合にのみ使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| baseTemplate | CommunityBaseTemplate (string 型の列挙) | この CommunityTemplateDefinition が API バージョン 41.0 以降で作成されたことを示します。有効な値は CommunityApp です。この項目は API 41.0 以降で使用できます。 |
| bundlesInfo | CommunityTemplateBundleInfo [ ] | この CommunityTemplateDefinition のプレビュー画像および機能の説明のリスト。 |
| category | CommunityTemplateCategory (string 型の列挙) | 必須。この CommunityTemplateDefinition の最適化された使用事例。有効な値は、次のとおりです。
|
| defaultBrandingSet | string | エクスペリエンスビルダーの [ブランド] パネルで定義される、この CommunityTemplateDefinition に関連付けられた一連のブランドプロパティ。API バージョン 40.0 以降で利用できます。 API バージョン 44.0 以降では、この項目は参照のみで、CommunityThemeDefinition で実装できます。 |
| defaultThemeDefinition | string | 必須。この CommunityTemplateDefinition の割り当てられたテーマ定義。 |
| description | string | この CommunityTemplateDefinition の説明テキスト (省略可能)。 |
| enableExtendedCleanupUpOnDelete | boolean | デフォルトは false です。この CommunityTemplateDefinition を削除すると、直接的または間接的に参照される他のオブジェクト (CommunityThemeDefinition、Flexipage、または StaticResource など) が自動的に削除されます。値は true または false です。 |
| masterLabel | string | 必須。[設定] に表示されるこの CommunityTemplateDefinition の表示ラベル。 |
| navigationLinkSet | NavigationLinkSet | この CommunityTemplateDefinition に関連付けられたナビゲーションメニュー。ナビゲーションメニューは、ユーザがクリックするとコミュニティの他の部分に移動できる項目で構成されます。API バージョン 40.0 以降で利用できます。 |
| pageSetting | CommunityTemplatePageSetting [ ] | 必須。この CommunityTemplateDefinition の FlexiPage のリスト。 |
CommunityTemplateBundleInfo
| 項目名 | データ型 | 説明 |
|---|---|---|
| description | string | その CommunityTemplateBundleInfo の説明テキスト (省略可能)。 |
| image | string | type が PreviewImage の場合にのみ必須です。それ以外の場合、この項目は省略可能です。この CommunityTemplateDefinition のプレビュー画像。 |
| order | int | 必須。その CommunityTemplateDefinition 内の同じ型の他の要素に対するこの CommunityTemplateBundleInfo の位置を指定する整数。1 は最初の位置、3 は PreviewImage 型の最大位置、4 は Highlight 型の最大位置です。 |
| title | string | 必須。コードで使用されるこの CommunityTemplateBundleInfo のタイトル。 |
| type | CommunityTemplateBundleInfoType (string 型の列挙) | 必須。エクスポートに含まれるテンプレートに関する説明情報を格納します。コミュニティ作成ウィザードのインターフェースは、テンプレートによって強化されます。有効な値は、次のとおりです。
|
宣言的なメタデータの定義のサンプル
CommunityTemplateDefinition コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<CommunityTemplateDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3 <bundlesInfo>
4 <description>Feature Description</description>
5 <order>1</order>
6 <title>Feature Heading</title>
7 <type>Highlight</type>
8 </bundlesInfo>
9 <bundlesInfo>
10 <image>siteAsset_2dbe594eb6794173af78da264cd6a4a7</image>
11 <order>1</order>
12 <title>Preview Image</title>
13 <type>PreviewImage</type>
14 </bundlesInfo>
15 <category>Sales</category>
16 <defaultThemeDefinition>communityTemplate</defaultThemeDefinition>
17 <description>This is a lightning community template</description>
18 <enableExtendedCleanUpOnDelete>true</enableExtendedCleanUpOnDelete>
19 <masterLabel>communityTemplate</masterLabel>
20 <navigationLinkSet>
21 <navigationMenuItem>
22 <label>Topics</label>
23 <position>0</position>
24 <publiclyAvailable>true</publiclyAvailable>
25 <target>ShowMoreTopics</target>
26 <type>NavigationalTopic</type>
27 </navigationMenuItem>
28 </navigationLinkSet>
29 <pageSetting>
30 <page>communityTemplate_Report_List</page>
31 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
32 </pageSetting>
33 <pageSetting>
34 <page>communityTemplate_Topic_Catalog</page>
35 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
36 </pageSetting>
37 <pageSetting>
38 <page>communityTemplate_Check_Password</page>
39 <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
40 </pageSetting>
41 <pageSetting>
42 <page>communityTemplate_Error</page>
43 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
44 </pageSetting>
45 <pageSetting>
46 <page>communityTemplate_User_Settings</page>
47 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
48 </pageSetting>
49 <pageSetting>
50 <page>communityTemplate_Login</page>
51 <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
52 </pageSetting>
53 <pageSetting>
54 <page>communityTemplate_Stream_List</page>
55 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
56 </pageSetting>
57 <pageSetting>
58 <page>communityTemplate_Sfdc_Page</page>
59 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
60 </pageSetting>
61 <pageSetting>
62 <page>communityTemplate_Group_Detail</page>
63 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
64 </pageSetting>
65 <pageSetting>
66 <page>communityTemplate_Report_Related_List</page>
67 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
68 </pageSetting>
69 <pageSetting>
70 <page>communityTemplate_Register</page>
71 <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
72 </pageSetting>
73 <pageSetting>
74 <page>communityTemplate_User_Profile</page>
75 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
76 </pageSetting>
77 <pageSetting>
78 <page>communityTemplate_Case_Detail</page>
79 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
80 </pageSetting>
81 <pageSetting>
82 <page>communityTemplate_Stream_Related_List</page>
83 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
84 </pageSetting>
85 <pageSetting>
86 <page>communityTemplate_Dashboard_Detail</page>
87 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
88 </pageSetting>
89 <pageSetting>
90 <page>communityTemplate_Group_List</page>
91 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
92 </pageSetting>
93 <pageSetting>
94 <page>communityTemplate_Canvasapp_Page</page>
95 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
96 </pageSetting>
97 <pageSetting>
98 <page>communityTemplate_Login_Error</page>
99 <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
100 </pageSetting>
101 <pageSetting>
102 <page>communityTemplate_Create_Record</page>
103 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
104 </pageSetting>
105 <pageSetting>
106 <page>communityTemplate_Group_Related_List</page>
107 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
108 </pageSetting>
109 <pageSetting>
110 <page>communityTemplate_Search</page>
111 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
112 </pageSetting>
113 <pageSetting>
114 <page>communityTemplate_File_Detail</page>
115 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
116 </pageSetting>
117 <pageSetting>
118 <page>communityTemplate_Case_List</page>
119 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
120 </pageSetting>
121 <pageSetting>
122 <page>communityTemplate_User_List</page>
123 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
124 </pageSetting>
125 <pageSetting>
126 <page>communityTemplate_File_List</page>
127 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
128 </pageSetting>
129 <pageSetting>
130 <page>communityTemplate_Question_Detail</page>
131 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
132 </pageSetting>
133 <pageSetting>
134 <page>communityTemplate_Dashboard_List</page>
135 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
136 </pageSetting>
137 <pageSetting>
138 <page>communityTemplate_Related_Record_List</page>
139 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
140 </pageSetting>
141 <pageSetting>
142 <page>communityTemplate_File_Related_List</page>
143 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
144 </pageSetting>
145 <pageSetting>
146 <page>communityTemplate_Record_List</page>
147 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
148 </pageSetting>
149 <pageSetting>
150 <page>communityTemplate_Forgot_Password</page>
151 <themeLayout>communityTemplate_themeLayout_Login</themeLayout>
152 </pageSetting>
153 <pageSetting>
154 <page>communityTemplate_Home</page>
155 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
156 </pageSetting>
157 <pageSetting>
158 <page>communityTemplate_Dashboard_Related_List</page>
159 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
160 </pageSetting>
161 <pageSetting>
162 <page>communityTemplate_Account_Management</page>
163 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
164 </pageSetting>
165 <pageSetting>
166 <page>communityTemplate_Case_Related_List</page>
167 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
168 </pageSetting>
169 <pageSetting>
170 <page>communityTemplate_User_Related_List</page>
171 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
172 </pageSetting>
173 <pageSetting>
174 <page>communityTemplate_Stream_Detail</page>
175 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
176 </pageSetting>
177 <pageSetting>
178 <page>communityTemplate_Topic_Detail</page>
179 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
180 </pageSetting>
181 <pageSetting>
182 <page>communityTemplate_Messages</page>
183 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
184 </pageSetting>
185 <pageSetting>
186 <page>communityTemplate_Report_Detail</page>
187 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
188 </pageSetting>
189 <pageSetting>
190 <page>communityTemplate_Record_Detail</page>
191 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
192 </pageSetting>
193 <pageSetting>
194 <page>communityTemplate_Feed_Detail</page>
195 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
196 </pageSetting>
197 <pageSetting>
198 <page>communityTemplate_Contact_Support</page>
199 <themeLayout>communityTemplate_themeLayout_Default</themeLayout>
200 </pageSetting>
201</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>44.0</version>
8</Package>