メタデータ API 開発者ガイド
jKnowledgeSettings
Salesforce ナレッジの設定管理に使用するメタデータを表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
パッケージマニフェストでは、「Settings」の名前を使用してすべての組織設定メタデータ型にアクセスします。詳細は「設定」を参照してください。
ファイルのサフィックスおよびディレクトリの場所
KnowledgeSettings の値は、settings ディレクトリの Knowledge.settings という 1 つのファイルに保存されます。.settings ファイルは、各設定コンポーネントに設定ファイルが 1 つしかないため、他の名前つきのコンポーネントとは異なります。
バージョン
KnowledgeSettings は、API バージョン 27.0 以降で使用できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| answers | KnowledgeAnswerSettings | Salesforce ナレッジ��よびアンサーの設定管理に使用するメタデータを表します。 |
| cases | KnowledgeCaseSettings | Salesforce ナレッジおよびケースの設定管理に使用するメタデータを表します。 |
| defaultLanguage | string | 必須。Salesforce ナレッジのデフォルトの言語。米国英語では en_US など、言語の略語を使用します。 |
| languages | KnowledgeLanguageSettings | Salesforce ナレッジで有効化された言語のリスト。 |
| enableChatterQuestionKBDeflection | boolean | Chatter を介したケースのデフレクションの追跡が有効か (true)、否か (false) を示します。 |
| enableCreateEditOnArticlesTab | boolean | ユーザが記事タブで記事の作成と編集ができるか (true)、否か (false) を示します。 |
| enableExternalMediaContent | boolean | 外部メディアへの接続が有効化されているか (true)、否か (false) を示します。 |
| enableKnowledge | boolean | Salesforce ナレッジが有効化されているか (true)、否か (false) を示します。 |
| showArticleSummariesCustomerPortal | boolean | 記事の概要がカスタマーポータルに表示されるか (true)、否か (false) を示します。 |
| showArticleSummariesInternalApp | boolean | 記事の概要が社内の知識ベースに表示されるか (true)、否か (false) を示します。 |
| showArticleSummariesPartnerPortal | boolean | 記事の概要がパートナーポータルに表示されるか (true)、否か (false) を示します。 |
| showValidationStatusField | boolean | 検証状況が記事に表示されるか (true)、否か (false) を示します。 |
KnowledgeAnswerSettings
Salesforce ナレッジおよびアンサーの設定管理に使用するメタデータを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| assignTo | string | アンサーから記事が割り当てられるユーザ名を指定します。 |
| defaultArticleType | string | アンサーから作成される記事のデフォルトの記事タイプ。記事タイプの API 名を使用します。 |
| enableArticleCreation | boolean | ユーザがアンサーから記事を作成できるか (true)、否か (false) を示します。 |
KnowledgeCaseSettings
Salesforce ナレッジおよびケースの設定管理に使用するメタデータを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| articlePDFCreationProfile | string | ケースから記事の PDF を作成するために使用するプロファイル。 |
| articlePublicSharingSites | KnowledgeSitesSettings | Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。 |
| articlePublicSharingSitesChatterAnswers | KnowledgeSitesSettings | Chatter アンサーで Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。 |
| assignTo | string | ケースから記事が割り当てられるユーザ名を指定します。 |
| customizationClass | string | カスタマイズに使用する Apex クラスを指定します。 |
| defaultContributionArticleType | string | ケースから作成される記事のデフォルトの記事タイプ。 |
| editor | KnowledgeCaseEditor (string 型の列挙) | リッチテキストエディタの種類を示します。有効な値は、次のとおりです。
|
| enableArticleCreation | boolean | ユーザがケースから記事を作成できるか (true)、否か (false) を示します。KnowledgeCaseSettings の他の項目を設定できるかどうかを制御します。 |
| enableArticlePublicSharingSites | boolean | ケースから公開サイト (URL) 経由で記事を共有できるか (true)、否か (false) を示します。 |
| useProfileForPDFCreation | boolean | ケースから記事の PDF を作成するためにプロファイルが使用されるか (true)、否か (false) を示します。 |
KnowledgeSitesSettings
Salesforce ナレッジおよびサイトの設定管理に使用するメタデータを表します。
| 項目名 | データ型 | 説明 |
|---|---|---|
| site | string[] | Salesforce ナレッジおよびサイトに使用するサイトを指定します。 |
KnowledgeLanguageSettings
Salesforce ナレッジで有効化された言語のリスト。KnowledgeLanguageSettings は、API バージョン 28.0 以降で使用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| language | KnowledgeLanguage | Salesforce ナレッジで有効化された言語の設定管理に使用するメタデータを表します。 |
KnowledgeLanguage
Salesforce ナレッジで有効化された言語の設定管理に使用するメタデータを表します。KnowledgeLanguage は、API バージョン 28.0 以降で使用できます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| active | boolean | 言語が有効化されているか (true)、否か (false) を示します。 |
| defaultAssignee | string | その言語の記事のデフォルトの任命先。 |
| defaultAssigneeType | KnowledgeLanguageLookupValueType (string 型の列挙) | デフォルトの任命先の種別を示します。有効な値は、次のとおりです。
|
| defaultReviewer | string | その言語の記事のデフォルトの校閲者。 |
| defaultReviewerType | KnowledgeLanguageLookupValueType (string 型の列挙) | デフォルトの校閲者の種別を示します。有効な値は、次のとおりです。
|
| name | string | 言語名のコード (英語の場合は en)。サポートされる言語およびそのコードの一覧は、Salesforce オンラインヘルプの「Salesforce がサポートする言語は?」を参照してください。 |
宣言的なメタデータの定義のサンプル
これは、ナレッジ設定ファイルのサンプルです。
1<?xml version="1.0" encoding="UTF-8"?>
2<KnowledgeSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <answers>
4 <enableArticleCreation>false</enableArticleCreation>
5 </answers>
6 <cases>
7 <articlePDFCreationProfile>partner portal knowledge profile</articlePDFCreationProfile>
8 <articlePublicSharingSites>
9 <site>KnowledgeSite</site>
10 <site>PKB2Site</site>
11 <site>ChatterAnswersSite</site>
12 </articlePublicSharingSites>
13 <articlePublicSharingSitesChatterAnswers>
14 <site>ChatterAnswersSite</site>
15 </articlePublicSharingSitesChatterAnswers>
16 <assignTo>testall@kb.org</assignTo>
17 <defaultContributionArticleType>Support</defaultContributionArticleType>
18 <editor>simple</editor>
19 <enableArticleCreation>true</enableArticleCreation>
20 <enableArticlePublicSharingSites>true</enableArticlePublicSharingSites>
21 <useProfileForPDFCreation>true</useProfileForPDFCreation>
22 </cases>
23 <defaultLanguage>ja</defaultLanguage>
24 <enableCreateEditOnArticlesTab>true</enableCreateEditOnArticlesTab>
25 <enableExternalMediaContent>true</enableExternalMediaContent>
26 <enableKnowledge>true</enableKnowledge>
27 <showArticleSummariesCustomerPortal>true</showArticleSummariesCustomerPortal>
28 <showArticleSummariesInternalApp>true</showArticleSummariesInternalApp>
29 <showArticleSummariesPartnerPortal>true</showArticleSummariesPartnerPortal>
30 <showValidationStatusField>true</showValidationStatusField>
31</KnowledgeSettings>