Metadata API Developer Guide
jNewer Version Available
KnowledgeSettings
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for more details.
File Suffix and Directory Location
KnowledgeSettings values are stored in a single file named Knowledge.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
KnowledgeSettings is available in API version 27.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| answers | KnowledgeAnswerSettings | Represents the metadata used to manage settings for Salesforce Knowledge and Answers. |
| cases | KnowledgeCaseSettings | Represents the metadata used to manage settings for Salesforce Knowledge and Cases. |
| defaultLanguage | string | Required. The default language for Salesforce Knowledge. Use the abbreviation for the language, for example, en_US for United States English. |
| enableChatterQuestionKBDeflection | boolean | Indicates whether tracking for case deflection via Chatter is enabled (true) or not (false). |
| enableCreateEditOnArticlesTab | boolean | Indicates whether users can create and edit articles on the articles tab (true) or not (false). |
| enableExternalMediaContent | boolean | Indicates whether connecting to external media is enabled (true) or not (false). |
| enableKbStandardSharing | boolean | Indicates whether standard Salesforce sharing is enabled (true) or not (false). |
| enableKnowledge | boolean | Indicates whether Salesforce Knowledge is enabled (true) or not (false). This field is false by default. |
| enableKnowledgeAgentContribution | boolean | Indicates whether a user can create an article from a case (true) or not (false). (Classic only) |
| enableKnowledgeArticleTextHighlights | boolean | Indicates whether text snippet highlights in Salesforce Knowledge search results are enabled (true) or not (false). This field is true by default. Available in API version 47.0 and later. |
| enableKnowledgeAnswersPromotion | boolean | Indicates whether a user can create an article from a reply (true) or not (false). (Classic Only) |
| enableKnowledgeCaseRL | boolean | Indicates whether creating a list of cases linked to an article is enabled (true) or not (false). (Classic Only) |
| enableKnowledgeKeywordAutoComplete | boolean | Indicates whether auto-complete for keywords is enabled (true) or not (false) when searching Salesforce Knowledge. This field is true by default. Available in API version 47.0 and later. |
| enableKnowledgeTitleAutoComplete | boolean | Indicates whether auto-complete for article titles is enabled (true) or not (false) when searching Salesforce Knowledge. This field is true by default. Available in API version 47.0 and later. |
| enableLightningKbAutoLoadRichTextField | boolean | Indicates whether rich text fields are enabled for editing when an article loads in Lightning Knowledge (true) or not (false). This field is false by default. Available in API version 47.0 and later. |
| enableLightningKnowledge | boolean | Indicates whether Lightning Knowledge is enabled (true) or not (false). |
| languages | KnowledgeLanguageSettings | A list of languages enabled for Salesforce Knowledge. |
| showArticleSummariesCustomerPortal | boolean | Indicates whether article summaries appear in the Customer Portal (true) or not (false). |
| showArticleSummariesInternalApp | boolean | Indicates whether article summaries appear in the internal knowledge base (true) or not (false). |
| showArticleSummariesPartnerPortal | boolean | Indicates whether article summaries appear in the partner portal (true) or not (false). |
| showValidationStatusField | boolean | Indicates whether validation status appears on articles (true) or not (false). |
| suggestedArticles | KnowledgeSuggestedArticlesSettings | Represents the metadata used to manage settings for the case fields used to suggest articles for cases. Available in API version 37.0 and later. |
| votingEnabled | boolean | When true, enables users to vote for a product or feature that uses Vote, such as Articles in Knowledge. Available in API version 50.0 and later. |
KnowledgeAnswerSettings
Represents the metadata used to manage settings for Salesforce Knowledge and Answers.
| Field Name | Field Type | Description |
|---|---|---|
| assignTo | string | Specifies the username an article is assigned to from Answers. |
| defaultArticleType | string | The default article type for articles created from Answers. Uses the API name of the article type. |
| enableArticleCreation | boolean | Indicates whether users can create articles from Answers (true) or not (false). |
KnowledgeCaseSettings
Represents the metadata used to manage settings for Salesforce Knowledge and Cases.
| Field Name | Field Type | Description |
|---|---|---|
| articlePDFCreationProfile | string | The profile used to create a PDF of an article from Cases. |
| articlePublicSharingSites | KnowledgeSitesSettings | Represents the metadata used to manage settings for Salesforce Knowledge and Sites. |
| articlePublicSharingCommunities | KnowledgeSitesSettings | Represents the metadata used to manage settings for Salesforce Knowledge and Experience Cloud sites. |
| articlePublicSharingSitesChatterAnswers | KnowledgeSitesSettings | Represents the metadata used to manage settings for Salesforce Knowledge and Sites with Chatter Answers. |
| assignTo | string | Specifies the username an article is assigned to from Cases. |
| customizationClass | string | Specifies the Apex class used for customization. |
| defaultContributionArticleType | string | The default article type for articles created from Cases. |
| editor | KnowledgeCaseEditor (enumeration of type string) | Indicates the rich text editor type. Valid values are:
|
| enableArticleCreation | boolean | Indicates whether users can create articles from Cases (true) or not (false). Controls whether other fields on KnowledgeCaseSettings can be set. |
| enableArticlePublicSharingSites | boolean | Indicates whether articles can be shared via a public site (URL) from Cases (true) or not (false). |
| enableCaseDataCategoryMapping | boolean | Indicates whether Case Data Category mapping is enabled (true) or not (false). |
| useProfileForPDFCreation | boolean | Indicates whether a profile is used to create a PDF of an article from Cases (true) or not (false). |
KnowledgeSitesSettings
Represents the metadata used to manage settings for Salesforce Knowledge and Sites.
| Field Name | Field Type | Description |
|---|---|---|
| site | string[] | Specifies the site used for Salesforce Knowledge and Sites. |
KnowledgeLanguageSettings
A list of languages enabled for Salesforce Knowledge. KnowledgeLanguageSettings is available in API version 28.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| language | KnowledgeLanguage | Represents the metadata used to manage settings for the languages enabled for Salesforce Knowledge. |
KnowledgeLanguage
Represents the metadata used to manage settings for the languages enabled for Salesforce Knowledge. KnowledgeLanguage is available in API version 28.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| active | boolean | Indicates whether the language is enabled (true) or not (false). |
| defaultAssignee | string | The default assignee for articles in the language. |
| defaultAssigneeType | KnowledgeLanguageLookupValueType (enumeration of type string) | Indicates the default assignee type. Valid values are:
|
| defaultReviewer | string | The default reviewer for articles in the language. |
| defaultReviewerType | KnowledgeLanguageLookupValueType (enumeration of type string) | Indicates the default reviewer type. Valid values are:
|
| name | string | The code for the language name, for example: English is en. See “What languages does Salesforce support?” in the Salesforce Help for a list of supported languages and their codes. |
KnowledgeSuggestedArticlesSettings
Represents the metadata used to manage settings for the articles suggested for cases, work orders, and work order line items. The Work Order and Work Order Line Item objects must be enabled in the org to use the associated fields.
| Field Name | Field Type | Description |
|---|---|---|
| caseFields | KnowledgeCaseFieldsSettings | Represents a list of the case fields used to suggest articles for the case. |
| useSuggestedArticlesForCase | boolean | Indicates whether case content is used to suggest articles for cases (true) or not (false). |
| workOrderFields | KnowledgeWorkOrderFieldsSettings | Represents a list of the work order fields used to suggest articles for the work order. |
| workOrderLineItemFields | KnowledgeWorkOrderLineItemFieldsSettings | Represents a list of the work order line item fields used to suggest articles for the work order line item. |
KnowledgeCaseFieldsSettings
Represents a list of the case fields used to suggest articles for the case. Available in API version 37.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| field | KnowledgeCaseField[] | Specifies the names of the case fields used to suggest articles for the case. |
KnowledgeCaseField
Represents the name of the case field used to suggest articles for the case. Available in API version 37.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Specifies the name of the case field used to suggest articles for the case. |
KnowledgeWorkOrderFieldsSettings
Represents a list of the work order fields used to suggest articles for the work order. Available in API version 39.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| field | KnowledgeWorkOrderField[] | Specifies the names of the work order fields used to suggest articles for the work order. |
KnowledgeWorkOrderField
Represents the name of the work order field used to suggest articles for the work order. Available in API version 39.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Specifies the name of the work order field used to suggest articles for the work order. |
KnowledgeWorkOrderLineItemFieldsSettings
Represents a list of the work order line item fields used to suggest articles for the work order line item. Available in API version 39.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| field | KnowledgeWorkOrderLineItemField[] | Specifies the names of the work order line item fields used to suggest articles for the work order line item. |
KnowledgeWorkOrderLineItemField
Represents the name of the work order line item field used to suggest articles for the work order line item. Available in API version 39.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Specifies the name of the work order line item field used to suggest articles for the work order line item. |
Declarative Metadata Sample Definition
This is a sample Knowledge settings file.
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 <suggestedArticles>
32 <caseFields>
33 <field>
34 <name>Subject</name>
35 </field>
36 <field>
37 <name>SuppliedEmail</name>
38 </field>
39 </caseFields>
40 <useSuggestedArticlesForCase>true</useSuggestedArticlesForCase>
41 </suggestedArticles>
42</KnowledgeSettings>Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.