The following Fields are contained within the Details of any Alert Definition.
- Notify Names: This can contain a comma separated list of email addresses that this notification will be sent to. This will also include any Notification Email Addresses set at the Folder or Job level in the Notify Names field.
- Summary Text: This contains the subject line of the email that will be sent. Notice that there are JAMS parameters parsed here.
- These Parameters are Native JAMS Variables that are automatically parsed by JAMS
- Detail Text: This contains the body of the notification, and is formatted using HTML. The Details also contain the Native JAMS Variables
- More information on the various properties that can be parsed can be found in the Developer's Guide here: JAMS Developer's Guide.
- Handler List: This field is used for specifying a custom list of handlers for the Alert. SMTP, Paladin, Etc. This field should be left alone.
- Alert Events: This contains the listing of Events that can be selected in order to trigger the Alert. Multiple events can be selected, but note that there are some combinations that conflict, causing the Alert to not work.
- An explanation of the Events List can be found here: Alert Event ID Enumeration
The most common Alert events are listed below:
|ActivityTimeLimit||A workflow activity exceeded the assigned time limit.|
|EntrySucceeded||An entry (setup or job) has successfully completed its execution|
|EntryFailed||An entry has failed to execute properly.|
|EntryShort||An entry has completed successfully too quickly. This time is set by the user in the "Notify Options" of a JAMS job and is based on a set time or percentage which is an average of previous runs.|
|EntryStalled||Alert based on a job or setup that has been pending in the schedule for too long.|
|EntryRunaway||An entry has been executing for too long. This time is set by the user in the "Notify Options" of a JAMS job and is based on a set time or percentage which is an average of previous runs.|
|EntryMissedWindow||A job or setup that has missed the window for it's scheduled run time.|
In JAMS users are also able to customize the notification sent for any of these Alerts to include additional information about the Job, or to remove some information that JAMS has defined by default.
Once a custom Alert has been defined, it can be assigned at the Folder or Job level in the Alerts section of a Job or Folder's Properties.
Alerts are first set at the root folder, and then will be inherited by subsequent folders and jobs. If the alert is not set at the root folder, it will be selectable within the job or folders properties, and inherited by the objects within that folder.
JAMS has additional alerting capabilities built into it which can be referenced when making calls to the JAMS API. These additional alerts tend to be utilized more for in-house development purposes, rather than what is most often required for end-users.