Setting up suggestions
Before you configure suggestions, click through to read how suggestions and rules work together.
Suggestions
Suggestions work through rules. To set up suggestions, you first create rules at the global level, and then use that rule in a suggestion set at the module level. The following entity-relationship diagram shows how suggestions work.
Suggestions contain the following options:
- The time when the suggestion is to be shown
- The roles that should see the suggestion
- The text of the suggestion
- The call-to-action (CTA)
Rules
Rules are defined at the global level, and then they're used at the module level. Rules are instances of a standard set of rule types (What are rule types?).
A rule can contain other rules too. For example, if there is a rule called Rule A
, and another called Rule B
, you can also have a rule called Rule C
that's a combination of Rule A
and Rule B
. Every suggestion uses one or more rules.
Rule bindings
To associate a rule to a suggestion, you use rule bindings. There are two kinds of rule bindings.
Suggestion rule binding | Filter rule binding |
---|---|
Use it for suggestions that use activities, for example, for a nudge when someone hasn't participated in 3 consecutive meetings. | Use it for suggestions that use lists, for example, showing a list of leads that are in a state that can be closed soon. An attribute of a record, a module, a state, dates such as created date, last update date, or meeting date can be used as filters |
The kind of rule binding to use when creating a suggestion is listed in the table at Rule types. A suggestion can use only one type of rule binding, either suggestion rule binding or filter rule binding, but not both.
Before you begin
Review the structure of the various JSON objects that you must change (an example configuration is at Example configuration). The following table shows you which JSON objects to use for a particular outcome.
What you want to specify | Where is it specified |
---|---|
The time that the suggestion is to be shown. | In the maxSuggestionDisplayAtAMoment and maxSuggestionDisplayInDay parameters. |
The time that's to be reckoned as beginning-of-day and end-of-day. | In the suggestionSchedule parameter. |
The text of the suggestion. | In the suggestionSets object. However, the variables can only be those fields and attributes that can be used in that module |
The people or roles that the suggestion is sent to. | In the suggestionSets > userSelectionCriteria > userRole object. |
The partners tiers that are considered. | In the the suggestionSets object. |
The weights for prioritization. | In the prioritizationConfig object. |
The call to action (CTA) options | In the ctaMappings object. |
What to do next
Now that the suggestion rules are in place, you can do these things:
- Specify the order in which suggestions are displayed. See Specifying the display order.
- Upload the actual suggestions that must be displayed on people's devices. See Uploading suggestions in bulk.
Specifying the display order
You can specify the order in which the suggestions are displayed on the Suggestions card. For example, the following image shows a suggestion card with three suggestions (shown by the three grey circles on the card); these three suggestions can be seen by swiping to the left or right. You can specify the order of this sequence.
See also
- Suggestions reference
- The
clientSuggestionConfig
object - The
rules
object - The
moduleSuggestionConfig
object