Scorecard Notifications
Configure scorecard notification settings so that the Analyst tool sends emails when specific metric scores, metric group scores, or metric costs move across thresholds. Metric scores or metric group scores might move across thresholds or remain in specific score ranges, such as Unacceptable, Acceptable, and Good. Metric cost values can move beyond the upper and lower cost thresholds that you set.
You can configure email notifications for individual metric scores, metric groups, and metric costs. If you use the global settings for scores, the Analyst tool sends notification emails when specific metric scores cross the threshold from the score ranges Good to Acceptable and Acceptable to Bad. You also get notification emails for each scorecard run if the score remains in the Unacceptable score range across consecutive scorecard runs. If you use the global settings for metric costs, the Analyst tool sends notification emails when the cost of invalid data in selected metrics crosses the upper and lower thresholds.
You can customize the notification settings so that scorecard users get email notifications when the scores move from the Unacceptable to Acceptable and Acceptable to Good score ranges. You can choose to send email notifications if a metric score or metric cost remains within specific ranges for every scorecard run. You can view the current cost of invalid data for each metric in the notification settings based on which you can set the cost thresholds.
Before you configure scorecards to send email notifications, an administrator must configure the Email Service in the Administrator tool.
Notification Email Message Template
You can set up the message text and structure of email messages that the Analyst tool sends to recipients as part of scorecard notifications. The email template has an optional introductory text section, read-only message body section, and optional closing text section.
The following table describes the tags in the email template:
Tag | Description |
|---|
ScorecardName | Name of the scorecard. |
ObjectURL | A hyperlink to the scorecard. You need to provide the username and password. |
MetricGroupName | Name of the metric group that the metric belongs to. |
CurrentWeightedAverage | Weighted average value for the metric group in the current scorecard run. |
CurrentRange | The score range, such as Unacceptable, Acceptable, and Good, for the metric group in the current scorecard run. |
PreviousWeightedAverage | Weighted average value for the metric group in the previous scorecard run. |
PreviousRange | The score range, such as Unacceptable, Acceptable, and Good, for the metric group in the previous scorecard run. |
MetricName | Name of the metric. |
MetricGroupName | Name of the metric group. |
CurrentScore | Score based on the latest scorecard run. |
CurrentRange | Score range in which the current score remains based on the latest scorecard run. |
PreviousScore | Score based on the previous scorecard run. |
PreviousRange | Score range based on the previous scorecard run. |
CurrentCost | Cost of invalid data in the metric based on the latest scorecard run. |
PreviousCost | Cost of invalid data in the metric based on the previous scorecard run. |
ColumnName | Name of the source column that the metric is assigned to. |
ColumnType | Type of the source column. |
RuleName | Name of the rule. |
RuleType | Type of the rule. |
DataObjectName | Name of the source data object. |
Setting Up Scorecard Notifications
You can set up scorecard notifications at both metric and metric group levels. Global notification settings apply to those metrics and metric groups that do not have individual notification settings.
1. Run a scorecard in the Analyst tool.
2. Click Actions > Edit.
3. Click the Notifications tab.
4. Select Enable notifications to start configuring scorecard notifications.
5. Select a metric or metric group.
6. Click the Notifications check box to enable the global settings for the metric or metric group.
7. Select Use custom settings to change the settings for the metric or metric group.
You can choose to send a notification email when the score is in Unacceptable, Acceptable, and Good ranges and moves across thresholds. You can also send a notification email when the metric cost crosses the upper or lower thresholds.
8. To edit the global settings for scorecard notifications, click the Edit Global Settings icon.
The Edit Global Settings dialog box appears where you can edit the settings including the email template.
Configuring Global Settings for Scorecard Notifications
If you choose the global scorecard notification settings, the Analyst tool sends emails to target users when the score is in the Unacceptable range. You can also configure the notification settings to send emails when the metric scores or metric costs move across thresholds. You can configure the email template including the email addresses and message text for a scorecard.
1. Run a scorecard in the Analyst tool.
2. Click Actions > Edit > Notifications to open the Edit Scorecard dialog box.
3. Select Enable notifications to start configuring scorecard notifications.
4. Click the Edit Global Settings icon.
The Edit Global Settings dialog box appears where you can edit the settings, including the email template.
5. Choose when you want to send email notifications for metric scores using the Score in and Score moves check boxes.
6. Choose when you want to send email notifications for metric costs using the Cost goes check boxes.
7. In the Email to field, enter the email ID of the recipient. Use a semicolon to separate multiple email IDs.
The default sender email ID is the Sender Email Address that is configured in the domain SMTP properties.
8. Enter the text for the email subject.
9. In the Body field, add the introductory and closing text of the email message.
10. To apply the global settings, select Apply settings to all metrics and metric groups.
11. Click OK.