メタデータ API 開発者ガイド
jArticleType
Salesforce ナレッジのすべての記事は 1 つの記事タイプに割り当てられます。記事のタイプは、記事が含むコンテンツのタイプ、外観、および記事にアクセスできるユーザを特定します。たとえば、単純な FAQ の記事タイプに [Question (質問)] と [Answer (回答)] の 2 つのカスタム項目を設定し、記事マ���ージャが FAQ の記事の作成または更新時にそこにデータを入力することが考えられます。より複雑な記事タイプでは、複数のセクションに分かれた多数の項目が設定されるものと思われます。レイアウトおよびテンプレートを使用することで、管理者は特定のコンテンツに対して最も効果的な方法で記事タイプを構築できます。記事タイプへのユーザのアクセスは権限によって制御されます。各記事タイプについて、管理者は「作成」、「参照」、「編集」、または「削除」権限をユーザに与えることができます。たとえば、記事マネージャが内部ユーザには FAQ 記事タイプの参照、作成、編集を許可し、パートナーユーザには FAQ の参照のみを許可することが考えられます。 Salesforceオンラインヘルプの「ナレッジ記事タイプ」および『SOAP API 開発者ガイド』の「記事」を参照してください。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
ArticleType はカスタムオブジェクトとして定義され、objects フォルダに保存されます。ArticleType のサフィックスには __kav を使用します (カスタムオブジェクトの場合の __c の代わりに)。ArticleType 項目名にはその他のカスタムオブジェクトと同様に __c サフィックスを使用し、属する記事タイプの名前を使ってドット修飾する必要があります。次のサンプル package.xml ファイルでこれを示します。
1<?xml version="1.0" encoding="UTF-8"?>
2 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <fullName>articlefilemetadata</fullName>
4 <apiAccessLevel>Unrestricted</apiAccessLevel>
5
6 <types>
7 <members>newarticle__kav.description__c</members>
8 <name>CustomField</name>
9 </types>
10 <types>
11 <members>newarticle__kav</members>
12 <name>CustomObject</name>
13 </types>
14
15 </Package>バージョン
ArticleType は、API バージョン 19.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| articleTypeChannelDisplay | articleTypeChannelDisplay | さまざまなチャネルで記事を表示するために使用する記事タイプテンプレートを表します。Salesforceオンラインヘルプの「記事タイプテンプレート」を参照してください。 |
| deploymentStatus | DeploymentStatus (string 型の列挙) |
カスタムオブジェクトまたはカスタム項目のリリース状況を表す文字列。有効な値は、次のとおりです。
|
| description | string | 記事���イプの説明。最大 1000 文字です。 |
| fields | CustomField[] | 記事タイプの 1 つ以上の項目を表します。 |
| gender | Gender | オブジェクトを表す名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。 |
| label | string | Salesforce ユーザインターフェース全体でオブジェクトを表す表示ラベル。 |
| pluralLabel | string | label 値の複数形です。 |
| startsWith | StartsWith (string 型の列挙) | 名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。有効な値は、「StartsWith」 にリストされています。 |
articleTypeChannelDisplay
チャネルで記事を表示するために使用される記事タイプテンプレートを決定します。別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| articleTypeTemplates | articleTypeTemplates | 特定のチャネルに適用する記事タイプテンプレートを示します。 |
articleTypeTemplates
特定のチャネルで使用する記事タイプテンプレートを設定します。指定されていない場合、デフォルトの記事タイプテンプレートが適用されます。
宣言的なメタデータの定義のサンプル
1<?xml version="1.0" encoding="UTF-8"?>
2 <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3 <articleTypeChannelDisplay>
4 <articleTypeTemplates>
5 <channel>App</channel>
6 <template>Tab</template>
7 </articleTypeTemplates>
8 <articleTypeTemplates>
9 <channel>Prm</channel>
10 <template>Tab</template>
11 </articleTypeTemplates>
12 <articleTypeTemplates>
13 <channel>Csp</channel>
14 <template>Tab</template>
15 </articleTypeTemplates>
16 <articleTypeTemplates>
17 <channel>Pkb</channel>
18 <template>Toc</template>
19 </articleTypeTemplates>
20 </articleTypeChannelDisplay>
21 <deploymentStatus>Deployed</deploymentStatus>
22 <description>Article type with custom fields</description>
23 <fields>
24 <fullName>description__c</fullName>
25 <label>Description</label>
26 <length>48</length>
27 <type>Text</type>
28 </fields>
29 <label>newarticle</label>
30 <pluralLabel>newarticles</pluralLabel>
31 </CustomObject>