Suggestions reference

Feedback

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 campaign
NOT_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 to
MORE_THAN, which evaluates to greater than
AT_MOST, which evaluates to less than or equal to
LESS_THAN, which evaluates to less than or equal to
EXACTLY, 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

For the BETWEEN comparator, the inputParams parameter of the rule object contains two values, one each for the start date and end date. For all of the other time comparators, only one date is needed.

BETWEENAll time comparators other than BETWEEN

"inputParams": [
    {
      "disabled": false,
      "param": "activityVarStart",
      "variableType": "task_name",
      "multi": false,
      "required": true
    },
    {
      "disabled": false,
      "param": "activityVarEnd",
      "variableType": "task_name",
      "multi": false,
      "required": true
    },
    {
      "disabled": false,
      "param": "durationVar",
      "variableType": "duration",
      "multi": false,
      "required": true
    }
  ],

"inputParams": [
    {
      "disabled": false,
      "param": "activityVar",
      "variableType": "task_name",
      "multi": false,
      "required": true
    },
    {
      "disabled": false,
      "param": "durationVar",
      "variableType": "duration",
      "multi": false,
      "required": true
    }
  ],

Distance comparators

LESS_THAN_EQUAL_TO
LESS_THAN
GREATER_THAN_EQUAL_TO
GREATER_THAN
EQUAL_TO

Call-to-action (CTA) options

For suggestions, the following three CTAs are the most used ones. To use other CTAs, see intelliCtaTypes.

CallNavigateSchedule an activity

Line 8: Specify the code for the phone number.

{
  "disabled": false,
  "order": null,
  "code": "vo-call",
  "inputBindings": [
     {
       "variable": "voCode",
       "param": "code",
      "dimension": null
    }
   ],
  "ctaType": null
}

Line 8: Specify the code for the address.

{
  "disabled": false,
  "order": null,
  "code": "vo-navigate",
  "inputBindings": [
    {
      "variable": "voCode",
      "param": "code",
      "dimension": null
    }
  ],
  "ctaType": null
}

Line 12: Specify the activity code.
Line 17: Specify the module code.

{
  "disabled": false,
  "order": null,
  "code": "vo-schedule-activity",
  "inputBindings": [
    {
      "variable": "voCode",
       "param": "code",
       "dimension": null
     },
     {
      "variable": "activityVarATaskHierarchy",
      "param": "task_type",
      "dimension": null
    },
    {
      "variable": "voFirstUpdateType",
      "param": "module_code",
      "dimension": null
    }
  ],
  "ctaType": null
}

User roles

ASSIGNEE, for only that person
ASSIGNEE_MANAGER, for the person and their manager
ASSIGNEE_MANAGER_HIERARCHY, for the person, their manager, and the entire reporting hierarchy of that person
GROUP_HIERARCHY

Example configuration for rule types

Each rule type its own JSON structure. The highlighted lines in Rule skeleton show the bits that you must change when you copy the code when creating a rule. The highlighted lines in Suggestion example shows how the rule gets applied in suggestionSets.