Show TOC

Background documentationAd Hoc Alert Sources Locate this document in the navigation structure

 

Ad hoc alerts are raised by the System_Alert_Send job definition or by custom script using RedwoodScript. The job definition or code can be placed into job chains in order to implement customized alerting.

The job takes two parameters:

  • The name of the ad hoc alert source

  • An optional data parameter that can be used to determine the escalation to use. This is available as a variable in the alert source expressions.

Variables

Ad hoc alert sources support the following variables:

  • ${jobId} - the job id of the alerting job.

  • ${data} - the value of the data parameter to the alerting job.

  • jobId - the job id of the job that raised the ad hoc alert

  • topLevelJobId - the job id of the main parent of the chain (outer-most job chain)

  • chainJobId - the job id of the parent of the chain (inner-most job chain)

Operator message and reply expressions

The operator message to use is specified as an expression that allows substitution parameters. The message can be specified only at the alert source level. If no message is specified, the default message is Acknowledge.

The reply expression works the same way as the reply expression for the System_OperatorMessage job, it can be written as a regular expression. This can be specified at the alert source level. If no reply expression is specified, the default reply expression is Acknowledge.

Escalation

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

Ad hoc 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 REL 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 escalation used to be dynamic.

Alert Source Actions

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

Actions

Ad hoc alert sources support the following actions:

Action

Description

Export

Export the ad hoc alert source into a CAR file

Edit

Edit the ad hoc alert source

Edit Security

Edit the security of the ad hoc alert source

Delete

Delete the ad hoc alert source

Duplicate

Make a copy of the ad hoc alert source to create a similar one

Expand All

Expand all ad hoc alert sources in the current filter

New

Create a new ad hoc alert source

Filter > New Filter

Create a new ad hoc alert source filter

Filter > Edit Filter

Edit current ad hoc alert source filter

Filter > Delete

Delete current ad hoc alert source filter
Finding Ad Hoc Alert Sources

You can search for ad hoc alert sources using filters and the Search Ad Hoc Alert Sources box on the Ad Hoc 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 ad hoc 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 ad hoc 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

AdHocAlertSource.Create

Create ad hoc alert sources

AdHocAlertSource.Delete

Delete ad hoc alert sources

AdHocAlertSource.Edit

Edit ad hoc alert sources

AdHocAlertSource.View

Access ad hoc 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 ad hoc alert source. It allows you to specify which users can access, edit, and delete the ad hoc alert source.