Inserting Dynamic Variables in Alert Notifications

When an alert is triggered and a notification sent, Performance Scorecard inserts the values represented by the variables in the body or subject line of the alert notification. All the variables described below are available, regardless of the type of alert you are creating. All dynamic variables that you insert must be enclosed between $ $, such as $$object_name$$. Dynamic variables should not be capitalized.

You can insert any variables in the body and subject line of the alert notification subscribers receive when an alert is triggered. However, if you insert an inappropriate variable, a warning is displayed in the alert notification E-mail, instead of the actual value the dynamic variable references. For example if “$$result$$” is placed in an initiative alert message, “<not a measure>” is displayed.

The following table describes the variables you can use in the subject line and body of alert notifications subscribers receive when an object is in alert.

Table 9. Alert Notification Message Dynamic Variables

Variable

Inserts

Applies to

collection_date

The expected collection date specified for the measure for which you are creating an alert.

This frequency of collection is specified during the measure’s setup.

Measure alerts

current_date

The current system date.

This is the date on which an alert is triggered and an alert notification sent.

All

current_time

The current system time.

This is the time at which an alert is triggered and an alert notification sent.

All

object_name

The name of the object (measure, initiative, or scorecard) to which the alert is assigned.

For example, if you are defining an alert for a measure called Increase Customer Satisfaction, selecting this variable inserts Increase Customer Satisfaction in the alert notification message’s body or subject line.

All

object_type

The kind of business object for which you are defining an alert.

For example if you are creating an alert for a scorecard, object_type is scorecard.

All

result

The current result value of the business object for which you are creating an alert, at the time the alert notification is sent.

For example, if you are creating an alert for a measure, this variable places the measure’s result value in the alert notification.

Measure alerts

score

The current score of the business object for which you are defining an alert.

For example, if you are creating an alert for a measure, this variable looks up the measure’s score at the time the alert notification is sent against the target you selected on the alert Setup page (if applicable).

Measure and scorecard alerts

status_symbol

The name of the status symbol

All

target

The target value you specified for the measure

Measure alerts

tripped_range_ calculated

The numeric value produced when formulas specified in the alert’s sub range setup are evaluated.

The numeric value in the tripped range is displayed regardless of whether it was derived from a formula or manually entered.

All

tripped_range _formula

The formula of the tripped range

All

user_name

The name of the employee who subscribes to the alert. Even though you have not yet subscribed to the alert you are creating, at the time the alert’s message is sent, the name of the Employees subscribed to the alert is looked up and inserted.

If multiple employees later subscribe to the alert, each employee receives an alert notification message with their name inserted using this dynamic variable.

All

user_id

The user account name of the employee to which the alert notification is being sent.

All

variance

The numeric difference between the target established, and the result achieved by the measure for which you are creating an alert.

Measure alerts

initiative_due_ date

The due date established for the initiative

Initiative alerts

initiative_ notified

The name of the employee who is associated with the initiative and is notified of the initiative’s progress.

Initiative alerts

initiative_owners

The name of the employee(s) who owns the initiative

Initiative alerts

initiative_percent _complete

The initiative’s current completion state as a percentage

Initiative alerts

initiative_text_ status

The current textual status (in progress, completed etc.) of the initiative

Initiative alerts