この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

ArticleType

記事タイプに関連付けられたメタデータを表します。

Salesforce ナレッジのすべての記事は 1 つの記事タイプに割り当てられます。記事のタイプは、記事が含むコンテンツのタイプ、外観、および記事にアクセスできるユーザを特定します。たとえば、単純な FAQ の記事タイプには、[質問] および [回答] の 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    <types>
6        <members>newarticle__kav.description__c</members>
7        <name>CustomField</name>
8    </types>
9    <types>
10        <members>newarticle__kav</members>
11        <name>CustomObject</name>
12    </types>
13</Package>

バージョン

ArticleType は、API バージョン 19.0 以降で使用できます。

項目

項目名 項目の型 説明
articleTypeChannel​Display articleTypeChannelDisplay さまざまなチャネルで記事を表示するために使用する記事タイプテンプレートを表します。Salesforce オンラインヘルプの「記事タイプテンプレート」を参照してください。
deploymentStatus DeploymentStatus (string 型の列挙)
カスタムオブジェクトまたはカスタム項目のリリース状況を表す文字列。有効な値は、次のとおりです。
  • InDevelopment
  • Deployed
description string 記事タイプの説明。最大 1000 文字です。
fields CustomField[] 記事タイプの 1 つ以上の項目を表します。
gender Gender オブジェクトを表す名詞の性別を示します。これは、語の性別に基づいて、異なる処理が必要となる言語に使用されます。
label string Salesforce ユーザインターフェース全体でオブジェクトを表す表示ラベル。
pluralLabel string label 値の複数形です。
startsWith StartsWith (string 型の列挙) 名詞が母音、子音、または特殊文字で開始されているかを示します。これは、語の最初の文字に基づいて、異なる処理が必要となる言語に使用されます。有効な値は、「StartsWith」にリストされています。

articleTypeChannelDisplay

チャネルで記事を表示するために使用される記事タイプテンプレートを決定します。別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。

項目名 項目の型 説明
articleTypeTemplates articleTypeTemplates 特定のチャネルに適用する記事タイプテンプレートを示します。

articleTypeTemplates

特定のチャネルで使用する記事タイプテンプレートを設定します。指定されていない場合、デフォルトの記事タイプテンプレートが適用されます。

項目名 項目の型 説明
channel string 記事タイプテンプレートが適用されるチャネルを指定します。
  • AllChannels: 使用できるすべてのチャネル。
  • App: Salesforce ナレッジの [記事] タブ。
  • Pkb: 公開知識ベース。
  • Csp: カスタマーポータル。
  • Prm: パートナーポータル。
page string カスタム記事タイプテンプレートとして使用されるカスタム Visualforce ページの名前を表します。template 項目で Page を選択する場合にこの項目を使用します。
template string 特定のチャネルに使用する記事タイプテンプレートを示します。
  • Page: カスタム Visualforce ページ。この値を指定する場合、page 項目を Visualforce ページ名で設定する必要があります。
  • Tab: タブとしてレイアウトに定義したセクションを表示します。
  • Toc: 目次としてレイアウトに定義したセクションを表示します。

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

記事タイプの定義のサンプルを以下に示します。
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>

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

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