The event-based Notification feature in QuerySurge allow users to leverage custom email notifications that are automatically generated when certain criteria are met. Global Notifications are managed by Global Administrators from the Global Administration portal.
Note: Email server settings must be configured before Notification emails can be successfully sent.
In this section
- Viewing Notifications
- Editing a Notification
- Editing the Email Template
- Adding Users, Roles, and CCs
Viewing Notifications
Global Notifications are available in the Global Administration portal, by navigating to the Email Notifications folder in the Administration Tree. There are three grids that display Notifications.
- All Global Notifications
- By User
- By Role
The All Notifications grid provides a list of all Notifications that have been created. By default, these are sorted by Notification Name; however, they can be filtered or sorted by any column. You can Edit a Global Notification using the action button on the bottom of the grid. Additionally, you can enable or disable a Global Notification using the toggle button in the Enabled column of each grid row.
Similarly, the Notifications by User and Notifications By Role grids provide a list of Notifications with the corresponding User or Role (i.e., groups of Users) that have been specified to receive them. These grids provide the same edit functionality, but enabling or disabling a Notification must be done from the All Notifications grid.
Editing a Notification
QuerySurge includes two default Global Notifications: Disk Space Alert and Disk Space Warning. These correspond to the Disk Space Critical and Disk Space Warning Thresholds, respectively, configured in your Server Properties. You can edit the existing Notifications, but can't create new ones.
To modify a Global Notification, select a record in the All Notifications grid and click the Edit button. This will launch the Notification Details modal, where you can modify some of the details of your Notification.
Note: The Name, Event, and Event Filter fields are read-only, but you're welcome to modify the Subject and Body of the email template, as well as the Users, Roles, and CCs who should receive the email.
Editing the Email Template
The Email section provides an editor that allows you to build a custom email template, with the ability to insert application-specific data determined at the time the email is generated and sent.
You'll need to enter a Subject, as well as craft the Body of your email. There are a number of built-in formatting options available, or you can modify the structure and content directly using the HTML button.
You can also add placeholder fields that will be populated with application data when the Notification is triggered. Select the green plus button to select from a menu of placeholders applicable to your Event.
Note: Placeholders can be used in the Subject, as well. Type the desired placeholder using the same format generated in the Body by the dropdown menu (i.e., ${Data Field Name}).
Adding Users, Roles, and CCs
Lastly, the Recipients section of the modal allows you to choose who should receive the Notification when it is sent. You can add specific users by name, groups of users by role, as well as external email addresses (to be added to the CC field in the email).
- All Users - all Users in your QuerySurge instance
- Global Admin Users - all Users with access to the Global Administration portal
- Project Admin Users - all Users assigned to one or more Projects with an Admin User role
To add a User or a Role (which will include all Users who have this Role) to the grid, select the green plus button. Likewise, use the red minus button to remove an entry.
To add an external email address to be copied on the email, type the email address into the box and press Enter. You can use this field to copy stakeholders who are not formal QuerySurge users.
It's important to verify that email addresses have been correctly entered for each added User (or group of Users by Role). With the exception of the added CCs, email addresses for Notifications are obtained from User details.