Optimize 10.5 | webMethods Optimize Documentation | Administering webMethods Optimize | For System Administrators | Configuring Optimize | Configuring Rule Violation Alerts and Actions | Creating a Static Custom Alert Template | Specifying Substitution Variables
 
Specifying Substitution Variables
You can use substitution variables to access the rule definition and diagnosis information. Variables also provide access to process information when an alert on a process event is triggered. These variables are case sensitive and must be specified exactly as defined below. If a variable cannot be found, the Analytic Engine will substitute a value of VARIABLE_NOT_FOUND in its place in the resulting e-mail alert.
The following table provides information about the substitution variables.
Variable
Description
${Data}
An iteration of associated business or process data.
${Data.<Field>}
The value of the associated data named<Field>. See the DISPLAY NAME column of the Add/EditEvent Map page (Applications > Administration> Analytics > KPIs > Business Data, and click the name of the event map) for possible attributes to include. Results may vary depending on rule expression settings and evaluation conditions. Contact Software AG Professional Services for assistance.
${DateTime}
The date and time of the rule violation.
${Diagnosis.Attributes}
An iteration of rule diagnosis attributes.
${Process.Event}*
The process event that triggered this alert.
${Process.InstanceId}*
The process instance identifier.
${Process.Name}*
The name of the process.
${Process.StepName}*
The current step in the process.
${Process.URL}*
The URL of the process instance in the user interface.
${Rule.Definition}
The rule definition.
${Rule.Description}
The description of the rule.
${Rule.Evaluation}
The rule evaluation result.
${Rule.Name}
The name of the rule.
${Rule.URL}
The URL of the rule definition in the user interface.
$[Rule.sla]
Whether the rule is associated with a Service Level Agreement (SLA), Yes or No.
$[Rule.customer]
A customer name associated with the rule.
$[Rule.severity}
The severity label assigned to the rule.
${Rule.status}
The status of the rule.
Rule Violated = rule is in violation.
In Compliance = rule has gone back into compliance.
${Violation.Count}
The number of times the rule is out of compliance.
* Availability of the ${Process.*} substitution variables depends on the context of the rule you are accessing.
Examples:
*${Process.Event}: To access this variable within a template, the rule must include the Error Type in the KPI or event rule definition. For example, a rule specified for the Intrinsic Process Metrics KPIs could be "Error Count by Process and Error Type" or "Error Count by Step and Error Type".
*${Process.Step}: For this variable to be available, the KPIs or event rules must include the process step dimension.
If the variable cannot be substituted, a message indicating the problem is displayed in place of these variables.