Include the rule summary with RULESET_SUMMARY
The RULESET_SUMMARY token inserts the combined messages from every rule a record matched. Use it in email, SMS and WhatsApp templates and API request templates.
Writing the token
{aoParam:RULESET_SUMMARY}works in email, message and API request templates.- In email and message templates you can also write
$$RULESET_SUMMARY$$.
The plain token gives the full summary: the Message (API / default) wording, from rules, condition sets and conditions, for every rule type. If no rules matched, it gives No matches to report.
Choosing what's included
Add options after a colon, separated by ;, such as {aoParam:RULESET_SUMMARY:message=email;level=Rules}.
| Option | What it does |
|---|---|
message=default, message=email or message=sms | Which message field to use. The default is default. Items whose chosen field is empty are left out. |
level=Rules,ConditionSets,Conditions | Which levels to include. List one or more. The default is all three. |
ruleTypes=Name1,Name2 | Only include matched rules with these Rule Type names. The default is all rule types. |
empty=Your text | Text to use when no rules are included, instead of No matches to report. Use empty= with nothing after it to show nothing. The text can contain commas but not ;. |
Examples
| Where | Token |
|---|---|
| Email body | {aoParam:RULESET_SUMMARY:message=email} |
| SMS, rule messages only | $$RULESET_SUMMARY:message=sms;level=Rules$$ |
| API request, one outcome only | {aoParam:RULESET_SUMMARY:ruleTypes=Ineligible} |
| Custom text when nothing matched | {aoParam:RULESET_SUMMARY:ruleTypes=Risk;empty=No risks identified} |
Check the result
Use the process's Test tab to see the rule results for real records and preview each action's content before anything is sent.