Configuring Rule Violation Alerts and Actions

The following example is the dynamic Velocity template for the default template used by Optimize to generate e-mail alerts. The [SUBJECT] and [BODY] tags denote the two currently supported sections of this template. Each section defines a separate Velocity template that uses the same action context.

[SUBJECT] $rule.instanceName                         
[BODY]                         
------------------------------------------------------------------ 
Rule Details:                         
Name:          ${rule.name}                         
Instance name: ${rule.instanceName}                         
Description:   ${rule.description}                         
Status:        ${rule.status}                         
Severity:      ${rule.severity}                         
Definition:    ${rule.definition}                         
Evaluation:    ${rule.evaluation}                         
URL:           ${rule.URL}                         
Rule type:     ${rule.ruleTypeString}                         
SLA:           ${rule.sla}                         
Customer:      ${rule.customer}                         
------------------------------------------------------------------ 
Diagnosis Details:                         
Start date:      ${diagnosis.startDate}                         
End date:        ${diagnosis.endDate}                         
Violation count: ${diagnosis.violationCount}                         
Violation id:    ${diagnosis.violationId}                         
------------------------------------------------------------------ 
#foreach ($mapName in $context.getEvents().keySet())                         
#if ($rule.ruleTypeId == 1)                         
Event Details for Event Map: $mapName                         
#else                         
Event Details for KPI: $mapName                         
#end                         
#foreach ($event in $context.getEvents().get($mapName)) 
#if ($event.getDimensions().size() == 0)                         
Monitor dimensions: N/A                         
#else                         
Monitor dimensions:                         
#foreach ($dim in $event.dimensions)                         
$dim.dimensionName: $dim.dimensionValue                         
#end                         
#end                         
Attributes:                         
#foreach ($attrKey in $event.getAttributes().keySet())                         
#foreach ($attrValue in $event.getAttributes().get($attrKey)) 
$attrKey: $attrValue                         
#end                         
#end                         
#if ($event.getProcessInfo().size() > 0)                         
Number of Processes: $event.getProcessInfo().size()                         
#foreach ($procInfo in $event.processInfo)                         
#if ($procInfo.name)                         
Process info:                         
Name:      $procInfo.name                         
Id:        $procInfo.instanceExternalId                         
#if ($procInfo.stepName)                         
Step name: $procInfo.stepName                         
#end                         
URL:       $procInfo.getURL()                         
#else                         
Process info: N/A                         
#end                         
#end                         
#end                         
#end                         
#end                         
------------------------------------------------------------------

For an example e-mail alert generated from this template, see IBM webMethods Optimize User’s Guide.

The following is an example e-mail alert template. Note that the template is for a monitor alert. The substitution variables are explained in Specifying Substitution Variables.

Business Rule Violation - Template                         
---------------------------------------------------                         
[SUBJECT]                         
Rule: ${Rule.Name} ${Diagnosis.Attributes}                         
[BODY]                         
Rule Details:                         
Rule Name:               ${Rule.Name}                         
Description:             ${Rule.Description}                         
Date / Time:             ${DateTime}                         
Rule Definition:         ${Rule.Definition}                         
Rule Evaluation:         ${Rule.Evaluation}                         
Rule SLA:                $[Rule.sla]                         
Rule Customer:           $[Rule.customer]                         
Rule Severity            $[Rule.severity}                         
Rule Status              ${Rule.status}                         
Out of Compliance:       ${Violation.Count}                         
View Rule:               ${Rule.URL}                         
Diagnosis Attributes:                         
${Diagnosis.Attributes}                         
Associated Text:                         
${Data}