メタデータ API 開発者ガイド
jChannelLayout
コミュニケーションチャネルレイアウトに関連付けられたメタデータを表します。コミュニケーションチャネルレイアウトを使用すると、システム管理者は記事コンテンツをインラインでコミュニケーションチャネル (メールパブリッシャー、エクスペリエンスビルダーサイト、ソーシャルメディアパブリッシャーなど) と共有できます。システム管理者は、各コミュニティチャネルで共有する記事タイプまたはレコードタイプの項目のリストを作成できます。項目の順序は、カスタマイズできます。
ファイルのサフィックスおよびディレクトリの場所
チャネルレイアウトコンポーネントのサフィックスは .channelLayout で、このコンポーネントは対応するパッケージディレクトリの channelLayouts フォルダに保存されます。プレフィックスは、記事タイプの API 名に一致する必要があります。Lightning Knowledge では、プレフィックスがナレッジオブジェクトの API 参照名に一致する必要があります。
バージョン
チャネルレイアウトコンポーネントは、API バージョン 32.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| doesExcludeFieldLabels | boolean | このレイアウトが適用されるコミュニケーションチャネルの項目の内容から項目ラベルが除外されるか (true)、否か (false) を示します。デフォルトは false であり、項目ラベルが挿入されます。API バージョン 48.0 以降で Lightning Knowledge が有効になっている場合に使用できます。 |
| doesExcludeFiles | boolean | 関連ファイルが除外されるか (true)、メールに添付されるか (false) を示します。デフォルトは false であり、関連ファイルが添付されます。API バージョン 48.0 以降で Lightning Knowledge が有効になっている場合に使用できます。 |
| enabledChannels | string | このレイアウトが適用されるコミュニケーションチャネル。API バージョン 32.0 から 46.0 の場合、有効な値は Email のみです。API バージョン 47.0 以降の場合、Lightning Knowledge が有効であれば、Chat、Messaging、および Social も有効な値です。 |
| label | string | 必須。この設定の表示ラベル。 |
| layoutItems | ChannelLayoutItem | レイアウトに含まれる記事項目。ここでの順序は項目の順序を決定します。 |
| recordType | string | チャネルレイアウトが適用されるレコードタイプの名前。デフォルトは、プライマリレコードタイプです。API バージョン 41.0 以降で利用できます。 |
ChannelLayoutItem
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| field | string | 必須。項目の名前。形式は、ArticleTypeName.FieldName です。Lightning Knowledge の場合は、KnowledgeBaseName.FieldName です。 |
宣言的なメタデータの定義のサンプル
ChannelLayout コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<ChannelLayout xmlns="http://soap.sforce.com/2006/04/metadata">
3 <label>Layout for Email</label>
4 <layoutItems>
5 <field>Knowledge.Question</field>
6 </layoutItems>
7 <layoutItems>
8 <field>Knowledge.Answer</field>
9 </layoutItems>
10 <enabledChannels>Email</enabledChannels>
11 <enabledChannels>Social</enabledChannels>
12 <enabledChannels>Chat</enabledChannels>
13 <doesExcludeFiles>false</doesExcludeFiles>
14 <doesExcludeFieldLabels>true</doesExcludeFieldLabels>
15</ChannelLayout>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>ChannelLayout</name>
6 </types>
7 <version>41.0</version>
8</Package>