Articles in this section

Alert Manager: Home

In Compas, this feature can be found through: Admin | System | Alert Manager.

The Alerts screen will display the full list of alerts (enabled and disabled) that have been made available to the client for him to use in the daily operations. The screen is divided in 2 main components:

Filter

The Alert Manager uses a search function and tags to group the different alerts:a6f74040-5f3d-44e1-95ff-94620a58bee6.png

The Search function allows to type any word and the system will return the alerts which name or body contains the word as requested.8ee846d7-1b2c-4852-a077-a22feefc7740.png5c2415b6-4ee9-4a24-ad15-5e20e79bd781.png

The tags can be created on an alert level and once created they will appear in the available list of tags on top. To add a label, type the tag you would like.50b56d1e-ba0e-4ce8-86cd-337ebfe06f77.png

Press Enter, Click Ok and the tag is created:7353483e-fc0b-495b-9ce9-e3707f252c34.png

Then the tag is created on the filter panel441b5e92-bf89-4c1e-a609-fb33471999ff.png

The Alert List

The Alert List is a list with all the alerts. It includes some basic information as the alerts have been configured:

  • Recurrence (Hourly, Daily, Weekly, Monthly)
  • Name of the laert which is the name that will show in the header of the alert
  • Enabled: Yes (Green) and No (Red)
  • Last Run.- last time alert was run by the system
  • Next Run.- when the system is expected to run the alert next
  • First Run.- when alert was run for first time
  • Report mode.- in case alert is preparing a report attached to the email (excel or html)
  • Email.- if sending via email is enabled or not.

Besides each alert there are a ist of icons available:

  • Edit Alert allows user to do changes in the configuration of the alert
  • Copy Alert allows user to Copy the Alert, for example, in case of two alerts being very similar but they need to be sent to two different people with a different body or small changes in the query logic.
  • Add to Queue allows user to manually add the alert to the Queue Manager to be snet at any point
  • Delete Alert, will remove the alert from the Alert List
  • Alert Audit allows the user to see the changes that have been made in the system and who did them.

Editing an alert

When click on the edit icon the alert window opens and it shows some basic details as per below:

Details and Schedulec60de4f9-40e6-4646-97f2-ad8850bfa15e.png

  1. Alert ID.- this uniqueid is useful if alert needs to be re-used by any other alert on any other customer to provide the development team a uique reference
  2. Creation Date.- when alert was built in the system
  3. Name of the Alert.- this is editable by the suer and Customer alike
  4. Enabled.- to make the alert run or not
  5. Alert Options.- this should be edited only by the development team as based on the ind of information required, a specific set up is required
  6. When alert should start running, sending time and for how long should it run. Can be edited by user and customer alike
  7. Tags.- you can refer to the filter area for this part
  8. Recurrence or how often alert should be sent, which will appear in the alert list. Can be edited by user and customer alike

After doing any changes click OK to save.

DataSource1 & DataSource2

These two tabs are not available for the customer and they are only for internal users.

The alerts use queries that have been set in the system by the development team to extract the information required by the customer. Based on the requirements, some alerts are fairly straight and may require only one query, or if same is more complex, then a second query can also be used to produce the required outcome and then be combined.

For example I require the system to produce specific data and then based on crew source send the email to a list of specific emails.

The query is available in the window, and if the user requires to check what is the outcome, she/he can click on Execute and the system will run the query and display in the Preview window.0fad2c68-c91f-44b6-bb0b-6a4df9dca0e8.png

Email

This screen shows the alert as how it will be sent by the system.

The sender will be based on the settings added in the configuration settings, the email addresses in TO, CC and BCC will be based on the customer preferences or in the query as we mentioned earlier. The customers can come here and add emails as they prefer using the “,” as separator

Subject will be the name of the alert as added in the Details & Schedule Tab.e10456d6-dba3-4b7c-9aba-5bad9b9c510f.png

Based on the requirements of the alert, the Report Mode, URL and attachment name will be configured by the development team.

The body of the email is editable and can be changed as required, as far as the resuts of the query (normally included between the { } symbols are not changed.

If the user or the customer would like to see how the alert would look like they can click on Preview.5be2cafd-e7b4-481e-9882-10aeb15493c2.png

Timeline

Timeline window allows user to check what alerts will be run in a specific period of time into the future.8b5bbd56-ffbd-41d0-ae0c-b12b9a348d54.png

To view this, the only action is to set the number of days in the field and if there is any specific alert the user is interested in, then add the keyword:b0cb19f1-bef0-4f10-876e-f4b683daa951.png

Queue Manager

The Queue Manager is the list of alerts sent by the system within a specific period of time. The user can select the date range and the status of the message making use of the date range filters and message status:27101341-2b4b-45b0-864d-2f8c0e4a7a6d.png

Audit Trail

This screen allows user to see, based on the alert, how many messages have been sent, when was the alert processes and when was it sent. As with the previous screens, it works on a combination of date range and filetring, allowing the system to extract the specific alert meeting those criteria and allowing the user to click on the specific message she/he is interested in check status:dce2eeb4-20f4-4648-bc54-09f858e13cfb.png

Was this article helpful?
0 out of 1 found this helpful

Comments

0 comments

Article is closed for comments.