Process Server Alert Sources
Process server alert sources raise alerts when process servers change status. All conditions must be met for the alert to fire!
Tabs & Fields
The following table illustrates the fields of each tab of process server alert sources editor dialogs.
Tab | Field | Description |
---|---|---|
Process Server Alert Source | Partition | The Partition where you wish to store the process server alert source |
Process Server Alert Source | Name | The name of the process server alert source can contain any combination of US ASCII letters, digits, and underscores; limited to 80 characters. |
Process Server Alert Source | Application | The Application of the process server alert source |
Process Server Alert Source | Description | The description of the process server alert source can contain any combination of printable UTF-8 characters, limited to 255 characters. |
Process Server Alert Source | Raise an alert for process servers that match | Specify a process server Name Pattern that will be used to match process servers, you may also specify a Partition Pattern to only search for process servers whose partition matches the pattern provided. |
Process Server Alert Source | Raise alerts only at certain times | Time Window and Time Zone allow you specify that alerts should only be fired when the time window is open or closed, depending on the Time Window Status. |
Process Server Alert Source | Raise a custom operator message | Specify a custom Operator Message Expression and Operator Message Reply Expression. The reply expression can use regular expressions to force the user to select a reply. |
Process Server Alert Source | Sent to | Specify an Address and a Default Alert Escalation; the alert will be sent to the specified address and escalated, if necessary, using the specified escalation. You may use substitution parameters in the address. If you do not provide a Default Alert Escalation you must specify a dynamic one - see below. |
Process Server Alert Source | Use a dynamic escalation path | Specify an alert escalation using substitution parameters, if no escalation can be found, the default specified above will be used. |
Documentation | Documentation | A comment about the object, can be used for documentation purposes. |
Statuses | Status | The status to react on. |
Statuses | Operator Message Expression | Status-specific operator message expression, overrides default. |
Statuses | Delay Amount | The amount of Delay Units to wait until the alert is sent. |
Statuses | Delay Units | The units of time used in the Delay Amount. |
Alert Source Email | Body | The body of the email to send, see Customizing email messages for information on how you can customize it. |
Alert Source Actions | Type | The type of action, limited to Post Alert on alert sources, they fire after an alert is sent. You must reply to the operator message and delete it if you want to suppress it. |
Alert Source Actions | Enabled | This checkbox allows you to enable or disable the action; when unchecked, the action will never fire. |
Alert Source Actions | Library | You can specify a library here containing methods you would like to use. It is recommended to save your code in libraries so you can use it elsewhere. |
Alert Source Actions | Action Subject | The user under which the code in the action is performed. You must set an action subject if you want to use jcsSession |
Alert Source Actions | Source | The source of your code. |
Alert Source Actions | Stub Source | This code shows you where the action will be performed. |
Security | * | This is where you can specify who can access/change/remove the process server alert source. |
Criteria
Process server alert sources raise alerts or notifications when process servers change status.
They match on two criteria:
- A pattern matching the partition and name of the process server.
- The new status of the process server.
You can use the following match rules for partition/name:
- Exact Insensitive - The value must match, case-insensitive. No wildcards allowed.
- Exact Sensitive - The value must match, case-sensitive. No wildcards allowed.
- GLOB Insensitive - The value must match, case-insensitive. GLOB wildcards allowed (
?
and*
). - GLOB Sensitive - The value must match, case-sensitive. GLOB wildcards allowed (
?
and*
). - RegEx Insensitive - The value must match, case-insensitive. Regular Expression pattern.
- RegEx Sensitive - The value must match, case-sensitive. Regular Expression pattern.
When matching process server statuses, you ignore transient errors by specifying a delay by which the process server must have recovered. For example, a temporary network congestion causes network packets to get lost, a process server loses the connection to the remote system for a period of 5 seconds after which the network recovers. Note that the only affect this has on Redwood Server is that during those 5 seconds, no new processes can be sent over to the remote system and processes that both reach a final state and get deleted in the remote system during this time frame potentially reach status Unknown, running processes are not affected as Redwood Server catches up with them once the connection is restored.
Operator Message and Reply Expressions
The operator message to use is specified as an expression that allows substitution parameters. 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 process definition. 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.
Escalation
Escalations send operator messages and emails (via Email Alert Gateways). When a specific condition does not have an escalation, no operator message is sent and the condition is ignored.
When nobody has resolved the alert in a timely fashion, you can escalate the alert to another operator. This is done with escalations.
Process server 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 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.
For example, different escalation paths can be defined depending on the new status of a process server:
- Match Name: PS_PRD*
- Expression: PS_PRD_
${newStatus}
- Default: PS_PRD_Alert
- Statuses: Connecting, PartiallyRunning, Shutdown, Unknown
- The following alert escalations are defined: PS_PRD_Connecting, PS_PRD_Shutdown, PS_PRD_Alert
If the new status of a process server named PS_PRD_EMEA_DB2, for example, is:
- Connecting - PS_PRD_Connecting will be tried, found and used.
- Unknown - PS_PRD_Unknown will be tried, but not found, so PS_PRD_Alert will be used.
- Shutdown - PS_PRD_Shutdown will be tried, found and used.
- Running - no alert will be raised.
Security
Privilege | Description |
---|---|
ProcessServerAlertSource.Create | Create process server alert sources |
ProcessServerAlertSource.Delete | Delete process server alert sources |
ProcessServerAlertSource.Edit | Edit process server alert sources |
ProcessServerAlertSource.View | Access process server 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 per partition or system-wide.
The Security tab allows you to specify which users can access, edit, and delete the process server alert source.
See Also
- Triggering Alerts
- Process Alert Sources
- Raising Alerts and Notifications from Processes
- Raising Alerts and Notifications from Process Servers
- Ad Hoc Alert Sources
- Sending Ad Hoc Alert Sources
- Monitor Alert Sources
- Documenting Objects using the Documentation Tab
ProcessServerAlertSource