Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

KnowledgeSettings

Represents the metadata used to manage settings for Salesforce Knowledge. It 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 is 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.
languages KnowledgeLanguageSettings A list of languages enabled for Salesforce Knowledge.
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).
enableKnowledge boolean Indicates whetherSalesforce Knowledge is enabled (true) or not (false).
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).

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.
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:
  • simple
  • standard
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).
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:
  • user
  • queue
defaultReviewer string The default reviewer for articles in the language.
defaultReviewerType KnowledgeLanguageLookupValueType (enumeration of type string) Indicates the default reviewer type. Valid values are:
  • user
  • queue
name string The code for the language name, for example: English is en. See “What languages does Salesforce support?” in the Salesforce online help for a list of supported languages and their codes.

Declarative Metadata Sample Definition

This is a sample Knowledge settings file.