The Zone History add-on is intended to present historical information about the zone. Currently this amounts to displaying the percentage of time that the zone is in different "equipment colors" using a pie chart. A concept of "satisfaction" is also displayed. A zone is considered satisfied if it is either unoccupied or it's occupied and operational (the color green).
Zones that contain 'unknown' describe periods of time that cannot be calculated due to events such as the Trend Historian being disabled or a time shift like Daylight Savings time.
On the left of the page is the system tree. This tree is a "thin" tree that only shows zone equipment and their parents (up to the system root). Selecting any item in the tree causes the page to immediately collect and display the results. If an area is selected, the main pie chart shows an aggregate view of all zone equipment below that area. Also, a table is shown below the pie chart that lists each zone equipment that is aggregated together, and shows their individual satisfaction and pie charts. If an equipment is selected, the individual pie chart for that equipment is shown as the main pie chart and no zone equipment table is displayed.
At the top of the page is a drop down menu that allows for the selection of the time range that is analyzed. The time range always ends at the present time (which means that field communications will almost always need to be performed to display the result). The drop down allows you to decide how far back in time to analyze. Either today, yesterday, last week or last month (always starting at midnight on that day) up until the current time.
Once an item in the tree has been selected (and the data collected and processed) a large pie chart is displayed to the right of the tree. This pie chart contains the results for the tree item that was selected. If the item is a single zone equipment, then the pie chart shows the percentage of time over the requested time range that the equipment was in each color and a "satisfaction" total below the pie chart. If the selected tree item is an area, then the pie chart shows the average for all the zone equipment beneath it. Moving the mouse over a section of the pie expands it and highlights the associated entry in the color legend (which is to the right of the tree).
Note: The legend to the side of the pie chart may combine the smallest percentages into a group called "Others."
If an area is selected in the system tree, a table that shows the individual details for each zone equipment beneath that area is show below the main pie chart. Each row of the table contains the display path to the equipment, the "satisfaction" total and a small pie chart for the zone. Clicking anywhere in a row will select that zone equipment in the system tree and therefore display the zone using the large pie chart.
This add-on also offers the ability to include the pie chart in a ViewBuilder view. To do this, place a "WebApp Content" control on a view. Once this is done, select the control and fill out the properties.
The "WebApp Name" property should be the name from the "Application" column of the "Web Applications" page (which is the name of the WAR file without the .war extension). Leave "Content Path" empty (no other content paths are currently supported). Pick the location to use for the pie chart. Remember, if the location is above a zone equipment, all zone equipment below that location will be analyzed and their results aggregated together in the displayed pie chart. This can be an expensive operation, so use carefully.
Lastly, set up any parameters that you need in order to control the behavior of the included content. The available parameters are:
Name | Default Value | Meaning |
---|---|---|
prevdays | 0 | Equipment color data is analyzed from midnight of this number of days ago until the current time. Values are capped at 31. |
showlegend | false | Specify "true" to show the legend of what each color in the pie chart means. |
showtotal | false | Specify "true" to show the total "satisfaction" below the pie chart. |