Suggestions reference
Suggestions are built on top of rules. Each rule is of a pre-defined activity type, and contains several parameters that are described on this page.
Rule types
Rule types are the framework to use when creating rules suggestions. The following table lists the standard rule types. Example code for these rule types are further down the page.
Rule type | When to use | Rule category |
---|---|---|
lastActivity |
For suggesting the next best course of action | Suggestion rule binding |
managerParticipant |
For activities where managers are participants | Suggestion rule binding |
activityScheduled |
For sending reminders | Suggestion rule binding |
activityFrequency |
For counting the number of times an activity is done | Suggestion rule binding |
voAttribute |
For suggestions based on any of the module or user attributes | Filter rule binding |
voModule |
For suggestions that must refer to a specific module | Filter rule binding |
voState |
For suggesting the next best course of action when the state of record changes | Filter rule binding |
voCreatedDate |
For suggestions based on record age | Filter rule binding |
voLastUpdateDate |
For suggestions based on record age | Filter rule binding |
voMeetingDate |
For reminders | Filter rule binding |
userTeamFilter |
Filter rule binding | |
composite |
For using more than one rule in a single rule | A composite rule can contain rules of only one category, either Suggestion Rule Binding or Filter Rule Binding . |
Each rule type its own JSON structure (see Example configuration for rule types).
List operators
IN
, for suggestions that work on the presence of a value in a list; for example, if a record is generated during a specific campaignNOT_IN
, for suggestions that work if a value is absent in a list; for example, if a record isn't in a specific state.IS_EMPTY
, for suggestions that work when a null list is returned by a rule; for example, if no meetings are scheduled for a specific day.IS_NOT_EMPTY
, for suggestions that work when a list isn't empty; for example, if the created date for a record is equal to today.
Frequency operators
AT_LEAST
, which evaluates to greater than or equal toMORE_THAN
, which evaluates to greater thanAT_MOST
, which evaluates to less than or equal toLESS_THAN
, which evaluates to less than or equal toEXACTLY
, which evaluates to equal to
Time comparators
Time value | Description |
---|---|
WITHIN |
Time in the past, relative to today, including today, without any time gap |
IN_LAST |
Time in the past, relative to today, excluding today, without any time gap |
BEFORE |
Time in the past, relative to today, including the specified time gap |
AFTER |
Time in the future, relative to today, without any time gap |
BETWEEN |
Time between a start date and an end date |
ON |
Exactly on the specified date |
See also
- Setting up suggestions
- The
clientSuggestionConfig
object - The
rules
object - The
intelliCtaTypes
object