Sending JAMS Notifications to Slack

Follow

JAMS v7.1 introduces the new Slack Integration.

 

In this Article

 


 

Installing Slack Integration

  1. On the JAMS Server, navigate to "C:\Program Files\MVPSI\JAMS\Scheduler" by default and right click JAMSDBA.exe and select "Run an administrator".

Note: The above path may be different if JAMS was installed on a different drive.



JAMSDBA.png

2. Type LOAD/Assembly=SlackIntegration, then select Enter. The Slack Integration will be installed.
JAMSDBACommand.png


Note: When upgrading JAMS versions, the Load/Assembly step must be repeated to update Slack property definitions.


 

Back to Top

 


 

Configuring Slack Integration

  1. Launch the JAMS Client, then navigate to the Integrations tab using the Configuration Shortcut.  Configuration.png
  2. Select the integrations Tab
    Integrations.png
  3. From the Integration tab, enter the SLACK API Token, also known as the Slack API Key and the Slack URL if different from the default. Select "Save"Save.png

    NOTE: The Slack Legacy Token API Key is required.

 

Back to Top

 


 

Slack Events in JAMS

 

After configuring the Slack Integration, Slack Events can be created within any JAMS Folder or Job.

 

Slack Event Properties

Property Description
Status
Enabled Used to enable or disable the Event Handler.
Slack
Slack Channel The name of the Slack Channel that should receive the event.
Severity The severity of the configured event.
Message A summary of the event that may contain object references in {} curly braces, such as {JAMS.JobName}.
Include Link to Entry Determines whether the Slack message should include a link to the Entry's details. Opens in the JAMS Web Client.
Events
Entry Success Defines whether the event should be triggered when the entry completes with a successful completion severity.
Entry Informational Defines whether the event should be triggered when the entry completes with an informational completion severity.
Entry Warning Defines whether the event should be triggered when the entry completes with a warning completion severity.
Entry Error Defines whether the event should be triggered when the entry completes with an error completion severity.
Entry Fatal Defines whether the event should be triggered when the entry completes with a fatal completion severity.
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.

 

Back to Top

 


 

Creating a Slack Event

  1. From the Job's properties, select the Schedule tab.
    Scheduletab.png
  2. Select the Add icon to view the available menu options. Select "When an event occurs..." then choose "send a Slack Alert..." Option.png
  3. From the When an event occurs window, scroll to the Slack fields. The Slack Channel, Severity, Message, and Include link to Entry fields must be completed:

Slack Channel - Enter the name of the slack Channel that is to receive the alert.

Severity - Choose the Severity Level from a scale of 1 to 5

Message - Enter the Message to be included within the Slack alert. (In order to send an alert to the Slack Channel, a message must be entered)

Include link to Entry - Select the check box to include a link to the JAMS Entry within the Slack Alert

Finish - Select "Finish" after completing the fields outlined above.

send_a_Slack_alert....png

 


Note: The JAMS Scheduler Service must be restarted to ensure the Slack configuration is completed:

ServiceRestartedJAMSScheduler.png


 

 

Back to Top

 


 

Viewing the Slack Event

With the Slack Event configured, JAMS will send a message to the defined Slack channel when the configured Event occurs. JAMS will also send updates to the Event's thread in Slack when there are changes to the event, such as a restart.

An example of this can be seen in the screenshot below.

Slack_Thread_Updates.png

 


NOTE: If end-users have a local instance of JAMS, clicking the Link to the Entry may open a JAMS Entry on the local machine instead of the intended entry caused by the Slack Event.


 

Back to Top

 


 

Additional Information

Have more questions? Submit a request

Comments