EventHandler Elements

Event Handler Elements are used to respond to executing or completed JAMS Jobs. Event Handlers may be configured to respond to Jobs running too long, completing too quickly, or to send notifications when Jobs fail or complete with warning severity. Multiple event handlers may be used for a single Job. Event Handler Elements added to a Folder will be inherited by that Folder's child objects.

Adding an Event Handler Element to a Job or Folder

  1. Open the Definition dialog for the Job or Folder where the Event Handler Element will be defined.
    NOTE: Users may right-click either a Folder or Job and select Properties from the drop-down list to open the Definition dialog.
  2. Select the Elements tab, then click the Add... button. The Add Element dialog will appear.
  3. Expand the Event Handler category to reveal the Event Handler Elements.
  4. Select the relevant Element and click Next.
  5. Define the available properties for the given Event Handler Element, then click Finish.
  6. Save and Close the Definition dialog.

Modify an existing Event Handler Element

  1. Open the Definition dialog for the desired Job or Folder where the Event Handler Element resides.
    NOTE: Users may right-click either a Folder or Job and select Properties from the drop-down list to open the Definition dialog.
  2. Select the Elements tab, then double-click the desired Event Handler Element to open the Event Handler Properties dialog.
  3. Modify the properties as desired, then click Save and Close on the Event Handler Properties dialog.
  4. Save and Close the Definition dialog.

Event Handler Element Properties

Each Event Handler element has a list of associated properties used to define how the event will be handled. Reference the tables below for a description of the properties available on each event handler.

Notification Job

Status Description
Enabled This can be used to enable or disable a Job, Element, or Event Handler.
Job Description
Notification Job The JAMS Job that runs when notification is required.
Events Description
Entry Success Should the event be triggered on a successful completion?
Entry Informational Should the event be triggered on an informational completion?
Entry Warning Should the event be triggered on a warning completion?
Entry Error Should the event be triggered on an error completion?
Entry Fatal Should the event be triggered on a fatal completion?
Entry Started Defines whether the event should be triggered when the Job has started executing.
Normal Event Defines whether the event should be triggered when a normal event occurs.
Low Event Defines whether the event should be triggered when a low event occurs.
Moderate Event Defines whether the event should be triggered when a moderate event occurs.
High Event Defines whether the event should be triggered when a high event occurs.
Urgent Event Defines whether the event should be triggered when an urgent event occurs.
Critical Event Defines whether the event should be triggered when a critical event occurs.

Paladin Event

Paladin Description
Monitor ID A comma separated list of Paladin Monitor IDs that should receive the event.
Severity The severity of this event
Summary A summary of the event.
Detail A detailed description of the event
Ask for a response Should JAMS ask for a response from Paladin and take action based on the response?
Upload the log file Should the job's log file be uploaded to paladin?
Events Description
Entry Success Should the event be triggered on a successful completion?
Entry Informational Should the event be triggered on an informational completion?
Entry Warning Should the event be triggered on a warning completion?
Entry Error Should the event be triggered on an error completion?
Entery Fatal Should the event be triggered on a fatal completion?
Entry Started Defines whether the event should be triggered when the Job has started executing.
Normal Event Defines whether the event should be triggered when a normal event occurs.
Low Event Defines whether the event should be triggered when a low event occurs.
Moderate Event Defines whether the event should be triggered when a moderate event occurs.
High Event Defines whether the event should be triggered when a high event occurs.
Urgent Event Defines whether the event should be triggered when an urgent event occurs.
Critical Event Defines whether the event should be triggered when a critical event occurs.
Status Description
Enabled This can e used to enable or disable a Job, Trigger, or Event Handler

Recovery Job

General Description
Recovery Job The JAMS Job that should run when the current Job does not exceed the configured Recovery Severity.
Recovery Severity The maximum completion severity required to trigger the Recovery Job.

Repeat

Status Description
Enabled This can be used to enable or disable a Job or Element.
Started The date and time when this series starts repeating.
Will Stop Repeating The date and time this series will stop repeating.
Repeat Description
Delay What is the delay between repetitions?
End Time What time should the repetitions stop?
Base Time When this Job repeats, which time should be used to calculate the next repetition? Options include End Time, Scheduled Time, and Start Time.
Repeat on Error Should the Job continue to Repeat even after it fails?

Resubmit

Status Description
Enabled This can be used to enable or disable a Job or Element.
Started The date and time when this series starts resubmitting.
Will Stop Repeating The date and time this series will stop resubmitting.
Resubmit Description
Delay What is the delay between resubmissions?
End Time What time should the resubmissions stop?
Base Time When this Job resubmits, which time should be used to calculate the next resubmission? Options include End Time, Scheduled Time, and Start Time.
Repeat on Error Should the Job continue to Resubmit even after it fails?

Runaway

Runaway Description
Force to Abort Determines if the entry should be forced to abort with the severity specified in the Runaway Action field. When the checkbox is selected, the behavior is the same as when you cancel a Job from the Monitor view with the Force job to abort option. If you select No Action for the Runaway Action, this option has no effect.
Runaway Elapsed Determines, in Delta Time, how long the Job can run before it is considered a runaway Job.
Runaway Elapsed Percent Determines how long the Job can run before it is considered a runaway Job, set as a percentage of the Job's average elapsed time.
Runaway Action Determines the action taken on the Job if it becomes a runaway Job.
Notify Description
Notify Event Class Select the event class that this event will generate when it occurs.
Level This level can be used by event handlers to classify events.
Message A message that will be passed to event handlers when this event is generated.

Send E-Mail

Status Description
Enabled This can be used to enable or disable a Job, Element, or Event Handler.
Events Description
Entry Success Should the event be triggered on a successful completion?
Entry Informational Should the event be triggered on an informational completion?
Entry Warning Should the event be triggered on a warning completion?
Entry Error Should the event be triggered on an error completion?
Entry Fatal Should the event be triggered on a fatal completion?
Entry Started Defines whether the event should be triggered when the Job has started executing.
Normal Event Defines whether the event should be triggered when a normal event occurs.
Low Event Defines whether the event should be triggered when a low event occurs.
Moderate Event Defines whether the event should be triggered when a moderate event occurs.
High Event Defines whether the event should be triggered when a high event occurs.
Urgent Event Defines whether the event should be triggered when an urgent event occurs.
Critical Event Defines whether the event should be triggered when a critical event occurs.
E-Mail Description
CC Address A comma separated list of e-mail addresses that will be cc'd on the e-mail. You can remove inherited addresses by prefixing the address with a minus sign (-). You can remove all inherited addresses by entering -*.
From Address The from email address used when sending the e-mail from JAMS.
Message Body The body of the e-mail message. Users may enter Markdown language in the Message Body.
Send Plain Text When set to true, e-mail is sent using only plain text. When false, html formatting is used. Note that if Send Plain Text is true, Markdown Language in the Message Body will not format properly.
Subject The Subject of the e-mail.
To Address A comma separated list of e-mail addresses that the e-mail will be sent to. You can remove inherited addresses by prefixing the address with a minus sign (-). You can remove all inherited addresses by entering -*.

Short

Short Description
Short Elapsed The minimum elapsed time for successful completion of the Job. If the Job completes successfully without exceeding the short time, configured notifications and completion severity changes will execute.
Short Elapsed Percent The minimum elapsed time for a successful completion of the Job, set as a percentage of the Job's average elapsed time. If the Job completes successfully without exceeding the short elapsed percent, configured notifications and completion severity changes will execute.
Short Severity If the Job meets Short Job criteria, what should the Job's completion severity be changed to?
Notify Description
Notify Event Class Select the event class that this event will generate when it occurs.
Level This level can be used by event handlers to classify events.
Message A message that will be passed to event handlers when this event is generated.

Stalled

Stalled Description
Stalled Time The maximum elapsed time for a Job. A Job execution that exceeds the stalled time is considered stalled, and will cause andy configured notifications to be sent.
Stalled Description
Notify Event Class Select the event class that this event will generate when it occurs.
Level This level can be used by event handlers to classify events.
Message A message that will be passed to event handlers when this event is generated.