How to Configure Estate Monitor
Introduction
The purpose of this guide is to provide a foundational understanding of the options and capabilities available when using the Estate Monitor. The Estate Monitor enables the user to view various information within the Estate at Region, Location and Device levels. The User can utilise the tree structure to access the specific regions, locations and devices and also use the Filter Options that are available allowing the user to view exactly what needs to be monitored in the Estate.
Components of Estate Monitor
This section will basically walk through to get a better understanding on what each of the components in the Estate Monitor depict, so that you will be able to get the broader picture on the usage of Estate Monitor.
Estate Monitor consists of the following Components:
-
Rows
-
Columns
-
Button Options
-
Filter Options
To navigate to Estate Monitor, use the Search or the following path
Following is the Estate Monitor:
Rows
This section describes the rows of the Estate Monitor and the aggregation rules for region, location and device levels.
As you can see below, there is a tree-structure on how the rows are arranged as follows:
The hierarchy of the tree is arranged is as follows:
All Regions
Regions
Locations
Devices
From the above example you can see that the column values of the devices rows (mpos1@0001.enactor and mpos2@0001.enactor) aggregates to the column values of the location row (UK Hertford Store) and the same happens from the column values of the location row (UK Hertford Store) to the column values of the region row (United Kingdom).
Columns
This section describes the available columns in the Estate Monitor and the aggregation rules for region, location and device levels. There are 10 columns in the Estate Monitor namely; Name, Options, Versions, Device(s) In Use, Transaction Status, Last Comms, Day Start, Day End, Tender Totals (POS) and Tender Totals (EM). Each of these columns are described in detail below:
Name
This is the column which allows to uniquely identify each row of the Estate Monitor according to the Region, Location or Device.
Options
This column consists of button options with specific functionalities that can be applied for each row.
Each of these button options and their functionalities are explained further in the “Button Options” section.
Versions
This column represents the latest version of either the device or the location. When the POS device is started and logged in, you can see deviceStatusEvent for your POS device in the Inbound Document Viewer and here you can view the versions that are associated with this POS device. This column essentially displays these versions.
- If it is a row that represents a location, then the version that is shown in this column for this location row is the version which is the highest from all of the devices in that location.
-
If a row represents a device, and the version of that device is behind other devices of the same device type in the same location, then the background of the Name column of that device row is shown in YELLOW.
-
If a location has one or more devices with version conflicts, then that will aggregate to the location level and the Name column of that Location row will be highlighted in YELLOW.
The Version column also gives the installed version details where you
can also click on the 
icon. This will list the
installed. jars for a particular device. This will also give the
information of the version conflicts if there are any with the Estate
Manager or the associated device in the location/group. Please find an
example below,
Device(s) In Use
This column represents the devices in each row that is either in use or not in use. It is depicted as follows:
| Icon | Description |
|---|---|
 | Device in Use |
 | Device not in Use |
The Device status and the changes done using the Estate Manager will be reflected in the “Device Status” Maintenance against each device.
Transactions Status
This represents the transaction state of each device for a selected date.
- If a row represents a device with the column marked by a tick
(
), it means all transactions of this device
in this date are successfully processed.
-
If a row represents a location with the column marked by a tick (
), that indicates all the devices have
successfully processed the transactions under this location. -
If a row represents a location and the cell has a cross (
) mark, that indicates there is one or more
devices that have a missing transactions or failed transactions under
this location.
In the case of missing transactions and/or failed transactions, the device name column will be highlighted in RED, and the corresponding location name column and the region name column will be highlighted in YELLOW. Plese find an example below,
The functionalities of the missing transaction button and the failed transaction button are explained further in the “Button Options” section.
Last Comms
This represents the date and time of when the device was last seen. If the row represents a region or location level, it shows the latest date and time from all the devices under that region or location.
Day Start
This column represents if the device has completed it day start function or not.
-
If a row represents a device and the day start column has a tick mark (
) that means the device has completed its day
start, and the (
) sign on the cell indicates
that the device did not complete the day start. -
If a row represents a location or region and the day start column has a tick mark (
), that means all the devices
under that location or region have completed day start, and if there
is a () sign, that means there may be one or
more devices that have not completed day start under that location or
region.
Day End
This column represents if the device has completed it day end function or not.
-
If a row represents a device and the day end column has a tick mark (
) that means the device has completed its day
end, and the () sign on the cell indicates
that the device did not complete the day end. -
If a row represents a location or region and the day end column has a tick mark (
), that means all the devices under
that location or region have completed day end, and if there is a
sign, that means there may be one or more
devices that have not completed day end under that location or region.
Tender Totals (POS) and Tender Totals (EM)
These two columns represent the Tender Totals of the POS and EM of the respective Devices, Locations and Regions
-
If the totals for a given node of the tree are in a single currency, the totals will be summed together and displayed as a single figure with the appropriate currency symbol.
-
If the node has multiple currencies, the node will display using base currency for that node, using the exchange rate for 'now'. If no appropriate base currency is available, the base currency of the EM itself will be used. The node will then also display a ($) icon that lists the sum of the original currencies and exchange rates used to convert to the base currency.
-
Any row with a discrepancy between the POS totals and the EM totals, gives a RED background to the Tender Totals (EM) column and shows an information icon next to it for the affected row in the Tender Totals (EM) column. Clicking on this icon will take the user to a Tender Totals Discrepancy Report (TBD).
-
The totals are aggregated up to the Location and Region levels, summing the totals of their child Devices/Locations/Regions, and using the rules above to condense to a single currency.
Button Options
The following table represents the icons/ buttons in the Estate monitor and the functionality of each button.
| Button/Icon | Functionality |
|---|---|
 | This will open up the Retail Transaction Archive Search Results of that respective device while being filtered for the current date.
|
 | The Device note button with + sign: This + sign indicates that this device does not have Device notes for the selected date. Clicking this button click will open up the Device Note Maintenance where a new device note can be added for that respective device.
|
 | This device already has device notes added to it. Clicking this button will open up the Device Note Maintenance and will display all the device notes for the selected date.
This Device Note Maintenance is only accessible through Device Maintenance and the Estate Monitor. |
 | Toggle Device In-use button will change the in-use state of the device and the change can be seen in the Device(s) In Use column of that respective row.
|
 | Missing transaction icon will open up Sequence Number Status Viewer of that respective device while the Topic is filtered as Transactions.
|
 | Failed transaction icon will open up Inbound Document Viewer of that respective device while the status is filtered to failed. You should change the filter of the Queue Name to Inventory Transaction Processing in order to view the failed transactions for this device.
|
Filter Options
In order to get a better view of exactly what needs to be monitored in the Estate Monitor, Filter Options can be used. Following are the available Filter Options that can be used:
| Filter Option | Description |
|---|---|
| Region | Dropdown list selection of defined Regions. |
| Location | Dropdown list selection of defined Locations. |
| Show Devices with No Comms Since | This will filter out the devices where the 'Last Comms' column is before the given date. |
| Tender Totals Discrepancy Exceeds | This will filter Devices which have discrepancies between the Tender Totals (EM and POS) that are larger than or equal to the amount on the selected date. |
| Calendar Date | Allows selection of the date to display in the monitor. The dropdown list supports the following two values:
'Next' and 'Previous' buttons will appear below the date selector which will correspondingly update the date forward or backwards from the selection |
| Only Show In-Use Devices | This will filter out the Devices which are/were ‘In Use’ on the selected date. |
| Only Show Devices without Day Start | This will filter out the devices which do not have a completed 'Day Start' on the selected date. |
| Only Show Devices without Day End | This will filter out the devices which do not have a completed 'Day End' on the selected date. |
| Only Show Devices with Transaction Issues | This will filter out the devices that has issues with the transactions. |
| Only Show Devices with Missing Transactions | This will filter out the devices that has Missing Transactions. |