Use Operational Summary
- Kyle McEwan
- Andy Brook [Plugin People]
since 4.2.11
Recipient emails should NOT match any Profile catch email addresses.
Operational Summary Notifications are there to help you ensure that your instance is healthy, and receive notifications if this is not the case.
There are currently 2 types of Operational Summary emails. There is Periodic, which are periodically sent emails summarising the status of your JEMH instance. There is also Alert, which sends emails when potential issues are occurring within your instance.
Periodic Notification
What is it?
Periodic notifications are sent to nominated email addresses, who periodically will receive a notification containing information about your JEMH and Jira instance.
What will the notification contain?
Currently, you will be informed on the last time JEMH processed an email received and sent, as well as any advisories for Profiles within JEMH. However, more information will be provided in the future.
This however is just the default template and you can create and design a template to be used when the Periodic notification is sent within JEMH Template Sets.
Configuration values
Email Template - The template that will be used to and content sent to nominated email addresses when a Periodic notification is sent.
Email Recipients - What emails will receive the Periodic notification.
Notification Interval - How often the Periodic notification will be sent, can be set from 1 hour to 6 months.
Example configuration
Below is a screenshot of an example Periodic Notification Configuration:
There is a Send now button present on the screen which when the config is valid and clicked, will add a Periodic notification to the mail queue to be sent to the configured email recipients immediately.
Alert Notification
What is it?
Alert notifications are sent to nominated email addresses, who will receive a notification containing information about your JEMH and Jira instance if an issue has been identified.
What will the notification contain?
Currently, you will be informed on the last time JEMH processed an email received and sent. If JEMH has not processed an email received or sent within the last hour, then the Alert notification will be sent with the word stale being under a status column in relation to either both or one of the received and sent table rows.
This however is just the default template and you can create and design a template to be used when the Alert notification is sent within JEMH Template Sets.
Configuration values
Email Template - The template that will be used to and content sent to nominated email addresses when a Alert notification is sent.
Email Recipients - What emails will receive the Alert notification.
Monitoring Period - These are the configured days and times that JEMH will monitor your instance to check whether any errors are currently present. This will prevent JEMH sending you an alert notification in times where it may not be an issue.
Example configuration
Below is a screenshot of an example Alert Notification Configuration:
There are two buttons present on this screen.
There is a Restart Scanning button that will be enabled when an alert notification has already been sent on the current day. When clicked, this will start scanning again within the specified Monitoring Period, and if another error is found later on, another Alert notification will be sent.
There is also a Scan Now button, when clicked, this will immediately scan the last sent and received times and if there is an error, will display on the user interface that this is the case, however, will not send an Alert notification in this case.
Alert Banner
While within JEMH, a banner will also appear at the top of the screen within Jira if errors have been identified in your JEMH and/or Jira instance. This will remain until the issue is resolved.