メタデータ API 開発者ガイド
jArticleType レイアウト
記事タイプのページレイアウトに関連付けられたメタデータを表します。記事タイプレイアウトで、ユーザが記事のデータを入力するときに表示および編集できる項目を決定します。また、ユーザが記事を参照するときに表示されるセクションも決定します。
記事の形式 (たとえばレイアウトセクションをサブタブ、またはリンクのある 1 つのページとして表示するかどうか、など) は、記事タイプテンプレートで定義します。記事タイプごとに 1 つのレイアウトのみを設定できますが、記事タイプの 4 つの各チャネルで異なるテンプレートを選択できます。詳細は、Salesforce オンラインヘルプの「ナレッジ記事タイプ」および 『SOAP API 開発者ガイド』の「ナレッジ」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
ArticleType レイアウトは、対応するパッケージディレクトリの layouts ディレクトリに保存されます。プレフィックスは、記事タイプの API 名に一致する必要があります。拡張子は .layout です。
バージョン
ArticleType レイアウトは、API バージョン 19.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| layoutSections | LayoutSection[] | 記事項目を含むレイアウトのメインセクション。ここでの順序はレイアウトの順序を決定します。 |
LayoutSection
LayoutSection は、ArticleType レイアウトのセクションを表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| customLabel | boolean | このセクションの表示ラベルがカスタムであるか標準 (組み込み) であるかを示します。カスタム表示ラベルは任意のテキストですが、翻訳する必要があります。標準表示ラベルには、「システム情報」など、自動的に翻訳される、定義済みの有効な値セットが含まれます。 |
| label | string | 表示ラベル。customLabel フラグに基づいて標準またはカスタムのいずれかとなります。 |
| layoutColumns | LayoutColumn[] | レイアウトの列です。スタイルによって異なります。Salesforce ナレッジでは、記事タイプレイアウトで 1 つの列のみがサポートされています。 |
| style | LayoutSectionStyle (string 型の列挙) | レイアウトのスタイル。Salesforce ナレッジでは、1 つの列ページを表示する OneColumn 値のみがサポートされています。 |
LayoutColumn
LayoutColumn は、レイアウトセクション内の列の項目を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| layoutItems | LayoutItem[] | 列内の個々の項目 (上から下の順序) |
宣言的なメタデータの定義のサンプル
ArticleType ページレイアウトの定義を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2 <Layout xmlns="http://soap.sforce.com/2006/04/metadata">
3 <layoutSections>
4 <customLabel>true</customLabel>
5 <label>Description</label>
6 <layoutColumns>
7 <layoutItems>
8 <field>description__c</field>
9 </layoutItems>
10 <layoutItems>
11 <field>dateTime__c</field>
12 </layoutItems>
13 </layoutColumns>
14 <style>OneColumn</style>
15 </layoutSections>
16 <layoutSections>
17 <label>Data Sheet</label>
18 <layoutColumns>
19 <layoutItems>
20 <field>file__c</field>
21 </layoutItems>
22 </layoutColumns>
23 <style>OneColumn</style>
24 </layoutSections>
25 </Layout>