Salesforce Knowledge Metadata API KnowledgeSettings
KnowledgeSettings
Represents the metadata used to manage settings for Salesforce Knowledge.
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 is only one settings file for each settings component.
Version
KnowledgeSettings is available in API version 27.0 and later.
Fields
Field Name answers
Field Type
KnowledgeAnswerSettings
cases defaultLanguage languages
KnowledgeCaseSettings
string
KnowledgeLanguageSettings
enableChatterQuestionKBDeflection boolean enableCreateEditOnArticlesTab boolean enableExternalMediaContent boolean enableKnowledge boolean showArticleSummariesCustomerPortal boolean
Description
Represents the metadata used to manage settings for Salesforce Knowledge and Answers.
Represents the metadata used to manage settings for Salesforce Knowledge and Cases.
Required. The default language for Salesforce
Knowledge. Use the abbreviation for the language, for example, en_US for United States
English.
A list of languages enabled for Salesforce
Knowledge.
Indicates whether tracking for case deflection via
Chatter is enabled ( true
) or not ( false
).
Indicates whether users can create and edit articles on the articles tab ( true
) or not
( false
).
Indicates whether connecting to external media is enabled ( true
) or not ( false
).
Indicates whetherSalesforce Knowledge is enabled ( true ) or not ( false ).
Indicates whether article summaries appear in the Customer Portal ( true ) or not ( false ).
146
Salesforce Knowledge Metadata API KnowledgeSettings
Field Name showArticleSummariesInternalApp showArticleSummariesPartnerPortal showValidationStatusField suggestedArticles
Field Type boolean boolean
Description
Indicates whether article summaries appear in the internal knowledge base ( true ) or not
( false ).
Indicates whether article summaries appear in the partner portal ( true ) or not ( false ).
boolean Indicates whether validation status appears on articles ( true
) or not ( false
).
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.
KnowledgeAnswerSettings
Represents the metadata used to manage settings for Salesforce Knowledge and Answers.
Field Name assignTo defaultArticleType enableArticleCreation
Field Type string string boolean
Description
Specifies the username an article is assigned to from Answers.
The default article type for articles created from Answers. Uses the API name of the article type.
Indicates whether users can create articles from Answers ( true ) or not
( false
).
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 name
Field Type string
Description
Specifies the name of the case field used to suggest articles for the case.
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
Field Type
KnowledgeCaseField
[]
Description
Specifies the names of the case fields used to suggest articles for the case.
147
Salesforce Knowledge Metadata API KnowledgeSettings
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 name
Field Type string
Description
Specifies the name of the work order field used to suggest articles for the work order.
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
Field Type
KnowledgeWorkOrderField []
Description
Specifies the names of the work order fields used to suggest articles for the work order.
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 name
Field Type string
Description
Specifies the name of the work order line item field used to suggest articles for the work order line item.
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
Field Type
KnowledgeWorkOrderLineItemField []
Description
Specifies the names of the work order line item fields used to suggest articles for the work order line item.
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 caseFields
Field Type
KnowledgeCaseFieldsSettings
Description
Represents a list of the case fields used to suggest articles for the case.
148
Salesforce Knowledge Metadata API KnowledgeSettings
Field Name useSuggestedArticlesForCase
Field Type boolean
Description
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.
KnowledgeCaseSettings
Represents the metadata used to manage settings for Salesforce Knowledge and Cases.
Field Name articlePDFCreationProfile articlePublicSharingSites articlePublicSharingCommunities articlePublicSharingSitesChatterAnswers assignTo customizationClass defaultContributionArticleType editor
Field Type string
KnowledgeSitesSettings
KnowledgeSitesSettings
KnowledgeSitesSettings
string string string
KnowledgeCaseEditor
(enumeration of type string)
Description
The profile used to create a PDF of an article from
Cases.
Represents the metadata used to manage settings for Salesforce Knowledge and Sites.
Represents the metadata used to manage settings for Salesforce Knowledge and Communities.
Represents the metadata used to manage settings for Salesforce Knowledge and Sites with Chatter
Answers.
Specifies the username an article is assigned to from
Cases.
Specifies the Apex class used for customization.
The default article type for articles created from
Cases.
Indicates the rich text editor type. Valid values are:
• simple
• standard enableArticleCreation enableArticlePublicSharingSites useProfileForPDFCreation boolean boolean boolean
Indicates whether users can create articles from
Cases ( true ) or not ( false ). Controls whether other fields on KnowledgeCaseSettings can be set.
Indicates whether articles can be shared via a public site (URL) from Cases ( true ) or not ( false ).
Indicates whether a profile is used to create a PDF of an article from Cases ( true ) or not ( false ).
149
Salesforce Knowledge Metadata API
KnowledgeSitesSettings
Represents the metadata used to manage settings for Salesforce Knowledge and Sites.
Field Name site
Field Type string[]
Description
Specifies the site used for Salesforce Knowledge and Sites.
KnowledgeSettings
KnowledgeLanguageSettings
A list of languages enabled for Salesforce Knowledge. KnowledgeLanguageSettings is available in API version 28.0 and later.
Field Name language
Field Type
KnowledgeLanguage
Description
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 active defaultAssignee defaultAssigneeType defaultReviewer defaultReviewerType name
Field Type boolean string
KnowledgeLanguageLookupValueType
(enumeration of type string)
Description
Indicates whether the language is enabled ( true
) or not ( false ).
The default assignee for articles in the language.
Indicates the default assignee type. Valid values are:
• user
• queue string
KnowledgeLanguageLookupValueType
(enumeration of type string)
The default reviewer for articles in the language.
Indicates the default reviewer type. Valid values are:
• user
• queue 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.
150
