Job Definition Alert Sources

You can use jobs to generate notifications or alerts when they finish with job alert sources. A job alert source can be created to trigger alerts for multiple jobs with pattern matching. Every Job definition alert source needs at least a job name pattern and a status mapping, or no notifications or alerts will be sent. See Raising Alerts and Notifications from Job Definitions information on how to create a job definition alert source.

Actions

Job definition alert sources support the following actions:

Action	Description
Export	Export the job definition alert source into a CAR file
Edit	Edit the job definition alert source
Edit Security	Edit the security of the job definition alert source
Delete	Delete the job definition alert source
Duplicate	Make a copy of the job definition alert source to create a similar one
Expand All	Expand all job definition alert sources in the current filter
New	Create a new job definition alert source
Filter > New Filter	Create a new job definition alert source filter
Filter > Edit Filter	Edit current job definition alert source filter
Filter > Delete	Delete current job definition alert source filter

Criteria

Job definition alert sources raise alerts or notifications when jobs change status.

They match a status on three criteria:

A pattern matching the name of the job definition.
The new status of the job.
The parameters of the job.

The pattern and the new status must be specified. The parameters are optional. If parameters are specified, then they must match. If no parameters are specified then no additional matching is done. Parameter matches are used to raise alerts or notifcations on generic job definitions like SAP_AbapRun. Since all of these jobs have the same job definition name, additional criteria are needed to distinguish specific SAP Systems, programs or variants.

You can use the following match rules for parameters:

Exact Insensitive - The value of the parameter must match, case-insensitive. No wildcards allowed.
Exact Sensitive - The value of the parameter must match, case-sensitive. No wildcards allowed.
GLOB Insensitive - The value of the parameter must match, case-insensitive. GLOB wildcards allowed (? and *).
GLOB Sensitive - The value of the parameter must match, case-sensitive. GLOB wildcards allowed (? and *).
RegEx Insensitive - The value of the parameter must match, case-insensitive. Regular Expression pattern.
RegEx Sensitive - The value of the parameter must match, case-sensitive. Regular Expression pattern.

Note Note

You must use parameter names and not descriptions, when specifying parameters. You can look these up in Definitions → Job definitions or for built-in job definitions you can see System job definitions and SAP job definitions.

End of the note.

Operator Message and Reply Expressions

The operator message to use is specified as an expression that allows substitution parameters, see the parameters below. The message can be specified at the alert source level, and overridden per status. If no message is specified at any level, the default message is Acknowledge.

The reply expression works the same way as the reply expression for the System_OperatorMessage system job definitions. This can be specified at the alert source level, and overridden per status. If no reply expression is specified, the default reply expression is Acknowledge.

Substitution Parameters

Job definition alert sources support the following substitution parameters:

${jobDefinition} - the name of the job definition.
${jobDefinitionOwner} - the owner of the job definition.
${jobId} - the job id.
${topLevelJobId} - the job id of the highest parent.
${jobOwner} - the owner of the job.
${oldStatus} - the old status of the job.
${newStatus} - the new status of the job.
parameters.name - the value of input parameter 'name' of the job, available in REL only.
outParameters.name - the value of output parameter 'name' of the job, available in REL only.
${topLevelQueue} - the name of the queue of the highest parent job
${remoteStatus} - the status in the remote system
${returnCode} - the return code of the job
${queue} - the queue of the job

Escalation

When nobody has resolved the alert in a timely fashion, you can escalate the alert to another operator, this is done with escalations.

Job definition alert sources use two rules to determine the alert escalation to use:

An expression to determine a dynamic escalation name. This expression supports ${variable} substitutions and the Redwood Expression Language Syntax syntax for expressions.
A default alert escalation

The expression is always evaluated first. If the escalation returned by the expression exists, then it is used. If it does not exist, then the default is used. This allows the used escalation to be dynamic.

For example, different escalation paths can be defined depending on the name of the :

Expression: Error_${processServer}
Default: Error_ProcessServer
Statuses: PartiallyRunning, Shutdown, Connecting
The following alert escalations are defined: Error_Finance, Error_Logistics, Error_ProcessServer

This will raise the following alerts:

Logistics changes to PartiallyRunning - Error_Logistics
Finance changes to PartiallyRunning - Error_Finance
HumanResoources changes to Shutdown - Error_ProcessServer

Alert Source Actions

Alert source actions are used to customize the behavior using RedwoodScript.

Finding Job Definition Alert Sources

You can search for job definition alert sources using filters and the Search Job Definition Alert Sources box on the Job Definition Alert Sources tab. This box is known as the intelliSearch box and located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short and long syntaxes. For example, if you want to display all job definition alert sources with the term error in the comment, you would use the search criteria as follows:

c:error

You can search more than one property, as follows:

c:error n:all

Note Note

No spaces should be entered before or after the colon (:).

End of the note.

See the Advanced Object Search for more information.

The following table illustrates the available prefixes for job definition alert sources:

Prefixes	Description
n, name	searches the name property
c, com, comment	searches the comment property
d, desc, description	searches the description property
a, app, application	searches the application property

Security

Privilege	Description
JobDefinitionAlertSource.Create	Create job definition alert sources
JobDefinitionAlertSource.Delete	Delete job definition alert sources
JobDefinitionAlertSource.Edit	Edit job definition alert sources
JobDefinitionAlertSource.View	Access job definition alert sources

You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted system-wide, per partition or isolation group.

If you have the security module, which requires the Module.Security license key, you have an additional Security tab on the job definition alert source. It allows you to specify which users can access, edit, and delete the job definition alert source.