Working with SLA Rules

To take advantage of the SLA capabilities, you must create SLA rules. Each SLA rule monitors a single Process Definition or Chain Definition. When you create an SLA rule, you specify when you expect the Process to start or end, and what should happen if the run starts or ends late. RunMyJobs can notify operators of problems via email, Alert Alerts, and custom Alerts.

Choosing Processes to Monitor

First, you must decide which Processes to monitor. Note that each SLA rule is can monitor a single Process run per day. You can use SLA with Process or Chain Definitions that run continuously with restart behaviors, or that run multiple times per day, but be aware of the following limitations:

• Each SLA rule tracks a single Process Definition or Chain Definition.

• If you want to monitor a Process that runs multiple times a day, you must create a separate SLA rule for each run. So, for example, if a Process runs at midnight and at noon, you need two SLA rules to monitor both runs.

Note: You can use SLA with a Process Definition that is used within a Chain Definition.

Edit Rule Definition Window

To create an SLA rule, click at the top.

The Edit Rule Definition window provides the following controls for configuring SLA rules.

Definition Area

Parameters Area

If the Process Definition has Parameters that are flagged as being Part of Key, you can specify name/value pairs for those Parameters in order to restrict this rule to monitoring Processes that have those Parameters and values.

To add a Parameter name/value pair, click . If this button is not displayed, the selected Process Definition does not have any Parameters that are designated as Part of Key.

Alerts Area

The Alerts area includes tabs for Email Alerts, Alert Alerts, and Custom Alerts.

Each of these tabs includes some common settings. These are described in the following table.

Alert Types

Each Alert has a type that indicates what specifically triggered the Alert. You can include this type in message bodies using the alertType replacement variable.

• PredictedAlert: Triggered when the Process's predicted start time (for SLA for starttime) or end time (for SLA for endtime) is after the SLA Deadline.
• DeadlineAlert: Triggered if the Process is not predicted to start (for SLA for starttime) or end (for SLA for endtime) when the SLA Deadline passes.
• Finished: Triggered if the Process starts (for SLA for starttime) or ends (for SLA for endtime) after the SLA Deadline, but within the Late Offset.
• HalfMissedAlert: Triggered if the predicted start time (for SLA for starttime) or end time (for SLA for endtime) is halfway to the end of the Late Offset.
• Missed: Triggered if the Process has not started (for SLA for starttime) or ended (for SLA for endtime) when the SLA Deadline passes.

Email Alerts Area

You can use the controls in this tab to configure an email to be sent if the SLA rule detects a failure. To add an email Alert, click .

Tip: For information about providing execution-specific information in the email body, see Replacement Variables.

Note: For a description of the fields not described in this table, see Alerts Area.

Alert Alerts Area

You can use the controls in this tab to arrange for an Ad Hoc Alert to be sent if the SLA Component detects a problem. Note that you will need to create Alert Source first.

To add an Ad Hoc Alert to the active SLA rule, click in the Alert Alerts area.

Note: For a description of the fields not described in this table, see Alerts Area.

Custom Alerts Area

You can use the controls in this tab to submit your own custom Process Definition or Chain Definition if the SLA Component detects a problem. You must create this Process Definition or Chain Definition yourself, and name it SLA_Custom_Alert. It must be in the same Partition as the SLA Component.

If this Process Definition or Chain Definition has Parameters, you can pass Parameter name/value pairs using the Parameters column. To do so, add a row and then click in the Parameters column. A Parameters dialog box displays, letting you specify the values to be sent to your custom Process Definition or Chain Definition.

To add a custom Alert, click .

Note: For a description of the fields not described in this table, see Alerts Area.

Replacement Variables

You can use replacement variables in the Subject and Body fields for an email to provide specific information about the problem detected by the SLA Component. For example, you could set the email Subject field to Rule breach for ${jobId} from ${jobDefinition}.

Email Alert Body Options

You have three options for the email Alert Body field.

• Manually enter text, optionally using replacement variables.

• Enter the path to a document (for example: doc:REDWOOD/SLA_EmailAlert_Template). The document can also use replacement variables.

• Leave the field blank. If you do not enter any text in the Body field, RunMyJobs inserts default body text based on the state of the SLA rule associated with the monitored Process.

The following example shows a sample email Body that uses replacement variables.

For example: 
<html>
<head><title>Email</title></head>
 <body>
  <p>SLA ${alertType} Breach </p>
  <p>Jobid=${jobId} </p>
  <p>Jobname=${jobDefinition}</p>
  <p>SLA deadline: ${requiredJobTime}</p>
  <p>Details:</p>
  <ul>
   <li>Alert priority: ${alertPriority}</li>
   <li>SLA Rule: ${ruleName}</li>
   <li>Job description: ${description}</li>
  </ul>
 </body>
</html>

Event and Lock Dependencies

The SLA Component's predicted end times are calculated based on Process and Chain dependencies. If Processes on the critical path for the deadline have events and/or locks, they will be taken into consideration only if the Processes they are depending on are also being monitored by the SLA Component.