Working with Job Server Alert Sources
Job Server Alert Sources raise alerts when Job Servers change status.
Creating a Job Server Alert Source
To create a Job Server Alert Source:
- Navigate to Configure > Control > Alerting > Job Server Alert Sources.
- Click New.
- 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 |
|---|---|---|
| Job Server Alert Source | Enabled | Lets you enable or disable the Job Server Alert Source. |
| Job Server Alert Source | Name Pattern |
A name pattern to match Job Definition names. |
| Job Server Alert Source | Name Match Type | A type of syntax for matching. Options include Exact Case Insensitive, Exact Case Sensitive, Glob Case Insensitive, Glob Case Sensitive, RegEx Case Insensitive, and RegEx Case Insensitive. |
| Job Server Alert Source | Partition Pattern |
A name pattern to match Partition names. |
| Job Server Alert Source | Partition Match Type | A type of syntax for matching. Options include Exact Case Insensitive, Exact Case Sensitive, Glob Case Insensitive, Glob Case Sensitive, RegEx Case Insensitive, and RegEx Case Insensitive. |
| Job Server Alert Source | Alert on Restart |
Lets you avoid creating a separate Alert every time a Job is forced to restart. Choose an option other than [None], or All restarts to limit Alerts to being sent after a specific number of restarts. |
| Job Server Alert Source | Time Window Status | Lets you specify whether to fire Alerts when the Time Window selected in the Time Window field is open or closed. |
| Job Server Alert Source | Time Window | Lets you specify that Alerts should only be fired when a particular Time Window is open or closed (depending on the value in the Time Window Status field). |
| Job Server Alert Source | Time Zone | The time zone for the selected Time Window. |
| Job Server Alert Source | Operator Message Expression | A custom Operator Message expression. This field allows substitution parameters. |
| Job Server Alert Source | Operator Message Reply Expression | A custom Operator Message reply expression. You can use regular expressions in the reply expression to force the user to select a reply option. If no reply expression is specified, the default reply expression is Acknowledge. This field allows substitution parameters. |
| Job Server Alert Source | Address | The email address to which the Alert should be sent. This field allows 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 escalation specified in the Default Alert Escalation field. |
| Job Server Alert Source | Default Alert Escalation | The default escalation to use. |
| Job Server Alert Source | Escalation Expression |
If you do not provide a Default Alert Escalation, you must specify an Escalation Expression. 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. |
| 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 Job Server 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 Job Server is still in the status mentioned after the specified delay. This is important for transient 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 | 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
Job Server Alert Sources raise alerts or notifications when Job Servers change status. You can ignore transient errors by specifying a delay (Delay Amount and Delay Units), which may allow the Job Server to recover.
For example, assume a Job 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 Jobs can be sent to the Platform Agent, and Jobs that both reach a final state and get deleted in the remote system during this time frame potentially reach status Unknown. Running Jobs 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 Job Server Alert Sources |
| ProcessServerAlertSource.Delete | Delete Job Server Alert Sources |
| ProcessServerAlertSource.Edit | Edit Job Server Alert Sources |
| ProcessServerAlertSource.View | Access Job Server Alert Sources |