Home > Alerts > Installation > Alerts Engine Installation

Alerts Engine Installation

The Alerts Engine can be installed as part of the MICROS BE installation utility or as a separate utility, delivered as a WAR (web application archive) file and a SQL script.

To install the Alerts Engine copy the AlertEngine.war file into <java server>\webapps directory (for example: c:\RetailJ\WebServer\webapps, C:\apache-tomcat-5.5.32\webapps). The application should be deployed automatically – this can take up to a minute for the new application to be detected.  

Once the application has been deployed you need to edit the database access options in the alertEngine.properties file to match your set-up.

To test the set-up, open a web browser to http://localhost:8080/AlertEngine. If this does not work, restart Tomcat and try again.  

Alerts Engine Version

The Alerts Engine WAR file includes a version number. This value can be determined from the Manifest file – <java server>webapps\AlertEngine\META-INF – which is a plain-text file that can be read with a text editor.

Database Creation

If you installed the Alerts Engine as part of MICROS BE installation, the Alerts database will have been created as part of that installation. If you installed the Alerts Engine as a separate utility you need to create the Alerts database before it will work. The installation from MICROS will include a database creation SQL script to run.

Sample Alerts

MICROS can provide a SQL script which will insert 10 sample alerts as the first 10 entries in your alerts database. The alerts are installed as inactive entries and would need to be enabled.

1. Sales By Till - Bar chart

2. Average Transaction - Currency meter

3. Top Ten Products - HTML (desc / total sold, total qty sold)

4. Sales vs Last Week - This week’s sales vs same week last year – bar chart

5. Operator Performance - HTML (user name / total sales / total qty)

6. Till Declaration Exceeds 5.00

7. Cash Drawer Pops Exceeds 5 per Employee

8. Missing Time Clock Entries

9. Employee Clocked More Than 8 Hours Today

10. Anomalous Transaction Totals - SQL to report a text message when transaction < 0.75 or > 50.00 within the last hour

Alerts 6-10 are used to send a text SMS or similar alert if something happens. If the alert condition did not happen the SQL returns an empty string otherwise it returns the error message to be texted to the user.