Working with Process Server Alert Sources
Process Server alert sources raise alerts when Process Servers change status.
Creating a Process Server Alert Source
To create a Process Server alert source:
- Navigate to Alerting > Process Server Alert Sources.
- Click .
- Choose a Partition and enter a Name.
- In the Name Pattern field, enter a name pattern that will match the process server(s) you want to monitor.
- On the Statuses tab, click Add and select a status from the Status dropdown list.
- Repeat the previous step for all required statuses.
- Click Save & Close.
Tabs and Fields
Note: For tabs and fields that are common to all objects, see Object Tabs.
Tab | Field | Description |
---|---|---|
Process Server Alert Source | Raise an alert for Process Servers that match |
Specify a Name Pattern to match Process Server names. You can also specify a Partition Pattern to only search for Process Definitions with a matching Partition. For pattern-matching options, see Pattern Matching. |
Process Server Alert Source | Raise alerts only at certain times | Time Window and Time Zone let you specify that alerts should only be fired when a specific Time Window is open or closed (depending on the Time Window Status). |
Process Server Alert Source | Raise a custom Operator Message |
Lets you specify the following:
|
Process Server Alert Source | Sent to |
Specify an Address and a Default Alert Escalation. The Address can use substitution parameters and is resolved by an Email Alert Gateway. The alert will be sent to the specified address and escalated, if necessary, using the specified escalation. If you do not provide a Default Alert Escalation, you must specify an Escalation Expression under Use a dynamic escalation path. Note: The Escalation Expression field is evaluated before the Default Alert Escalation field. If the Escalation Expression field results in a match, the Default Alert Escalation is ignored. |
Process Server Alert Source | Use a dynamic escalation path | Lets you specify an a Escalation Expression using substitution parameters. If no matching escalation can be found, the Default Alert Escalation is used. |
Statuses | Status | The status to alert on. |
Statuses | Operator Message Expression | A status-specific Operator Message expression. If you specify this, it overrides the default Operator Message expression for this process alert source. |
Statuses | Delay Amount | The number of Delay Units to wait until the alert is sent. The system will only raise the alert if the process is still in the status mentioned after the specified delay. This is important for transient process statuses such as Waiting, EventWait or Queued. It is not necessary for final statuses such as Error, Killed, or Completed. For more information, see Delay Amount. |
Statuses | Delay Units | The units of time used in the Delay Amount. |
Alert Source Email | Body | The body of the email to send. For information on customizing this field, see Customizing Alert Emails. |
Actions | Type | The type of action to take when an alert needs to be fired. The only valid option for alert sources is Post Alert. Any action you define here will be executed after the alert is sent. You must reply to the Operator Message and delete it if you want to suppress it. |
Actions | Enabled | Lets you enable or disable the action. |
Actions | Action Subject | The user under which the code in the action is performed. You must set this if you want to use jcsSession . |
Actions | Library | Lets you specify a library containing methods you want to use in the Source field. |
Actions | Source | The source code of the script. |
Delay Amount
Process Server alert sources raise alerts or notifications when Process Servers change status. You can ignore transient errors by specifying a delay (Delay Amount and Delay Units), which may allow the Process Server to recover.
For example, assume a Process Server loses the connection to the remote system for a period of five seconds due to network congestion, after which the network recovers. The only effect this has on RunMyJobs is that during those five seconds, no new processes can be sent to the platform agent, 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, because Redwood Server catches up with them once the connection is restored. So, by setting a delay of five seconds or more, you can sometimes avoid unnecessary alerts.
Security
The privileges available in the Security tab are as follows.
For more information, see Security Tab.
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 |