Working with Job Alert Sources

You can use Job Alert Sources to generate an alert when a Job or Workflow reaches a particular status. You can even configure a Job Alert Source to generate separate alerts for separate statuses.

Every Job Alert Source must specify at least a Name Pattern and one target status. All specified conditions must be met for an alert to fire.

Creating a Job Alert Source

To create a new Job Alert Source:

1. Navigate to Configure > Control > Alerting > Job Alert Sources.
2. Click New.
3. Enter a Name for the Job Alert Source.
4. In the Name Pattern field, enter a pattern matching the name of all Jobs you want to raise alerts for. You can use a variety of different syntaxes to define the pattern. Choose the one you want from the Name Match Type dropdown list.
5. Click the Statuses tab.
6. For each status you want to raise an alert on:
   • Click and select a status from the Status dropdown list.
   • If desired, enter a Delay Amount and choose an option from Delay Units.
   • Optionally enter a status-specific Operator Message to override the default message.
7. To verify that the Alert Source does what you want it to, click the Preview tab.
8. Click Save & Close.

Tabs and Fields

Note: For tabs and fields that are common to all objects, see Object Tabs.

Security

The privileges available in the Security tab are as follows.

For more information, see Security Tab.

Status Matching and Workflows

The following alerting options are available for Workflows:

• Workflow and Steps: The alert fires for Job Calls and Workflows that match the name pattern and have reached the target status.
• Workflow and Steps: The alert fires for Steps and Workflows that match the name pattern and have reached the target status.
• Workflow Only: The alert fires for Workflows that match the name pattern and have reached the target status.
• Workflow, Steps, And Processes: The alert fires for Job Calls, Steps, and Workflows that match the name pattern and have reached the target status.
• Processes Only: The alert fires for Job Calls that match the name pattern and have reached the target status.
• Standard: The alert fires for Workflows that match the name pattern and have reached the target status. The alert also fires for steps that have reached statuses Console or Console Restart.
• Steps And Processes: The alert fires for Job Calls and Steps that match the name pattern and have reached the target status.
• Steps Only: The alert fires for Steps that match the name pattern and have reached the target status.

Alerts can be generated for any combination of types (single Jobs, Workflows, Steps, and Job Calls). The status of a Job Call or Step is escalated up to the Workflow, so it's important to pay special attention when you want to raise an alert on a Workflow. Incorrectly configured Alert Sources can fire duplicate Alerts.

The Standard behavior is to match only Workflows (or, for Steps, statuses Console and Console Restart). This means that if you use On Error Status Handlers in Workflows in combination with the Standard behavior, you must make sure the Workflow reaches status Error when an error occurs (or that one of the steps reaches status Console or Console Restart). In this case, you should specify status rules for Console and Console Restart in combination with a Request Restart Status Handler. The Workflow Partition and name are used for matching; the Partitions and names of the Job Definitions called within the Workflow (Job Calls) are not taken into account.

Example Job Alert Sources

The following example shows how to generate an alert if any SAP_AbapRun Job enters status Error, Unknown, Killed, or Canceled.

1. Navigate to Configure > Control > Alerting > Job Alert Sources.
2. Click New.
3. In the Name Pattern field, enter SAP_AbapRun*.
4. In the Operator Message Expression field, enter Job ${jobOwner}.${jobDefinition} with ID ${jobId} reached status ${newStatus}. Has the Job been restarted?.
5. In the Operator Message Reply Expression field, enter ^Yes|No$. This will force users to reply with Yes or No.
6. On the Statuses tab, add a row and choose select Error from the Status dropdown list. Repeat this step for statuses Unknown, Killed, and Canceled.
7. Click Save & Close.

The following example generates an alert if any SAP_AbapRun Job where the parameter SAP_SYSTEMS has value ERP enters status Error, Unknown, Killed, or Canceled. Note that for the Operator Message to work, the Job Definition must have a parameter named Param1.

1. Navigate to Configure > Control > Alerting > Job Alert Sources.
2. Click New.
3. In the Name Pattern field, enter SAP_AbapRun*.
4. In the Operator Message Expression field, enter ='Job ${jobOwner}.${jobDefinition} with ID ${jobId} and Parameter '+parameters.Param1+'reached status ${newStatus}!'.
5. On the Statuses tab, add a row and choose select Error from the Status dropdown list. Repeat this step for statuses Unknown, Killed, and Canceled.
6. On the Parameter Matches tab, click Add, then enter SAP_SYSTEMS in the Name field and ERP in the Value field.
7. Click Save & Close.

The following sample Source could be used in a Post Alert action. Assume that a Job is configured to restart if it reaches status Error, and its maximum number of restarts is set to 4. Assume further that you do not want to have to answer an alert for the first restart. Note that getRestartCount returns the number of remaining restarts.

{
  // Get the alert information
  Alert alert = jcsAlertSourcePostAlertContext.getAlert();
  OperatorMessage omessage = alert.getOperatorMessage();
  SchedulerEntity sentity = omessage.getSenderObject();

  // Do not send emails for the first failure
  if (sentity instanceof Job)
  {
    Job Process = (Job) sentity;
    Long restartCount = new Long(3L);
    // If RestartJobId is null, then this is the first Process.
    if (Process.getStatus().getState() == JobStatusState.Final && restartCount.equals(Process.getRestartCount()))
    {
      // Reply to the Operator Message and restart the job
      omessage.setReply("Acknowledged");
    }
  }
}