SearchPromotionRule

Represents a promoted search term, which is one or more keywords that you associate with a Salesforce Knowledge article. When a user’s search query includes these keywords, the associated article is returned first in search results. This object is available in API version 31.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

A user must have the “Manage Promoted Search Terms” permission.

Fields

Field Name	Details
PromotedEntityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the KnowledgeArticleVersion that the promoted search term is associated with. The article must be in published status.
Query	Type string Properties Create, Filter, Group, Sort, Update Description The text of the promoted search term. Maximum length: 100 characters. You can associate the same promoted search term with multiple articles. If the user’s search matches the promoted term, all associated articles are promoted in search results, ordered by relevancy. For best results, create promoted search terms selectively and limit the number of articles that are promoted per term.

Field Name

Details

PromotedEntityId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the KnowledgeArticleVersion that the promoted search term is associated with. The article must be in published status.

Query

Type: string
Properties: Create, Filter, Group, Sort, Update
Description: The text of the promoted search term. Maximum length: 100 characters.
You can associate the same promoted search term with multiple articles. If the user’s search matches the promoted term, all associated articles are promoted in search results, ordered by relevancy. For best results, create promoted search terms selectively and limit the number of articles that are promoted per term.

Usage

Use this object to optimize article search results in Salesforce Knowledge.

For example, if an article addresses a common support issue such as login problems, you can associate the terms password and password change. Article search matches a promoted term whenever all keywords within the term occur within the user’s search terms, in any sequence. Each keyword must match exactly. For example:

The promoted term password matches a search for change password.
The promoted term password change matches a search for how do I change my password but doesn’t match forgot password.
The promoted term password doesn’t match a search for change passwords.

Consider these limitations and general limits when you use promoted search terms.

Your organization can create a maximum of 2,000 promoted terms. For best results, use them selectively, which means create a limited number of promoted terms and a limited number of promoted articles per term.
If your organization translates articles into multiple languages, each promoted term is associated with one article version and the article version’s language. If you need equivalent promoted terms to be associated with each translation, you must specify promoted terms for each translation. For example, associate change password with an English language article version and changer mot de passe with a French language article version.
The end user’s language setting determines the scope of the article search. Search results exclude article versions and any associated promoted terms that are not in the user’s language.

Object Reference for Salesforce and Force.com

SearchPromotionRule

Supported Calls

Special Access Rules

Fields

Usage