The first tab in the Views displays available Views and related information panels. Arrow adornments on the panels, drill down for more options or information panels.
Navigation - The gray band at the top provides Back/Forward controls as well as bread crumbs for quick navigation.
Views - The Views panel in the upper left displays current status information since the Views web service was last started.
Current Connections: - number of connections currently being held by clients.
Total Connections: - total number of connections made and released by clients.
Request Count: - total requests for information from client connections.
Requests/Sec: - number of requests to the Views web service each second. A request for data is usually for a group of tags over a specified time period.
TVQ Count: - total number of TVQs (Timestamp, Value, Quality) returned to clients.
TVQ/Sec: - number of TVQs being returned to clients each second.
Arrow down - Changes to "Views Options" with a button to "Create Asset Model"
View - When a View is selected the View panel will display properties and settings in the lower left.
Name: - Name of the selected View. Usually a Historian or View plugin
Started At: - Time when the View (Historian) last started.
Up Time: - If View is a Historian this is the length of time the Canary Enterprise Historian has been running since the last start.
Total Run Time: - If View is a Historian this is the cumulative amount of the time the Canary Enterprise Historian has run.
Historian Version: - If View is a Historian this is the version.
License: - If View is a Historian this will show the number of tags it is licensed to manage.
DataSet Count: - If View is a Historian this is the number of Datasets defined.
Views - A tile is displayed for each View the View web service is connected to.
Local Historian - View of the local Historian.
Remote Historian - View of a remote Historian.
Custom Plugin - A plugin View extends the capability of the Views web service for custom tag layouts or connections to other sources such as OPC-UA and OPC-HDA.
The OPC-UA and OPC-HDA require a separate license and an edit to the "C:\ProgramData\Canary Labs\Historian Web Service\PlugIns\HDAPlugin.dll.admin" file. The example file below shows the HDA configured to access the Canary Labs HDA server on the local system.
After applying a license and editing the .admin file the Views web service must be restarted to read in the new settings.
<?xml version="1.0" encoding="utf-8"?>
<view name="HDA" host="localhost" prog_id="CanaryLabs.OPCHDAServer.1" type="Hda" />
<!--<view name="Your Display Name 2" host="host_computer" prog_id="ua:opc.tcp://host_computer/YourEndpointAddress" type="Ua" />-->
Asset Model - A customized view of like tags from multiple like machines or processes.
Arrow right/Double-click - As the cursor passes over a View tile a right arrow is available in the upper right corner. Click the arrow or double-click the tile to open the DataSet display.
The panels on the left are blank until a DataSet or View is selected. Selecting a Historian View will display the Properties panel in the lower left as shown below.
Archive Files - Legacy DataSet Setting; When a files creation time is older than 1 - 999 Days when a Roll-Over occurs, the file is moved to the location indicated by the Archive path under DataSet Directories.
Case Sensitivity - Legacy DataSet Setting; The default setting is for treating tag names with different case as different tags.
Delete Files - Files with a creation time older than 1 - 365 Days, Months or Years will be deleted at the time when a Roll-Over occurs.
Note: Do not make this setting less than the time of a Roll-Up or the Roll-Up file will be deleted with all the data up to the current file.
HDB File Count - Number of .hdb2 files in this DataSet.
Indexing - Legacy DataSet Setting; When enabled the Historian creates an index file in the primary path. Indexing helps the Historian search for tags removed from the current file.
Local Archive Path - Legacy DataSet Setting; A secondary directory to hold .hdb2 files. Files older than "x" days are moved from the Primary into the Archive directory.
Local Primary Path - Directory where .hdb2 data files will be stored. Must be defined when the DataSet is created.
Next Roll Over - If logging continues this will show the date/time the DataSet is configured to Rollover (create a new file). If logging is stopped and resumed after the time passes then Rollover will occur when logging starts.
Offline File Count - The number of files in this DataSet with an offline extension because background validation found errors in the file.
Open Readers - Number of tags being read from this DataSet (each tag will be a Reader).
Open Writers - Number of tags being written to this DataSet (each logging tag is a Writer).
Roll-Over - Current setting when the DataSet is scheduled to create a new file.
Roll-Up - Current setting for combining Roll-Over files for this DataSet, Never, Daily, Weekly, Monthly or Quarterly.
Status - Shows the following possible states for a DataSet.
- Open: A client is currently reading or writing historical data.
- Idle: No client is currently accessing, but the DataSet is still open. For optimization purposes a DataSet will remain in the idle state for 1 minutebefore it is "Closed"
- Closed: No activity.
- Rolling Up:Displayed during the time a Roll-Up is taking place on the DataSet.
Tag Count - Total number of tags being logged in this DataSet based on the most current file.
Updates/Sec - Logging rate indicating number of updates/second throughput rate.
Validation - Enabled/Disabled. When enabled a background thread will validate any files for this DataSet not already validated except the current file.
Arrow right/Double-click - As the cursor passes over a DataSet tile a right arrow is available in the upper right corner. Click the arrow or double-click the tile to open the Branch/Tag display.
Tags are displayed from the root of a DataSet or Branch in the Tags panel. If there are Branches, they will be displayed on the right. Clicking the right arrow or double-clicking the Branch tile will open it and display the tags from this level in the Tags panel. If there are more Branches they will display on the right.
Tags - This panel provides an alphabetical list of the tags in the selected DataSet/Branch.
Search... - Type any part of a tagname in the field to filter the list of tags below.
Properties - When a tag is selected the Properties panel displays tag information.
|Bits||.NET||Min value||Max value|
|128||Decimal||-7.92E+28 *||7.92E+28 *|
|64||Double||-1.80E+308 **||1.80E+308 **|
Default High Scale - The default value for the high scale of a trend.
Default Low Scale - The default value for the low scale of a trend.
Description - A string value describing the tag.
Eng Units - A string value of the type of units.
First Timestamp - Timestamp of the first value in the DataSet.
High Limit - The default high value used by trending clients supporting limits.
ItemID - DataSet and tagname as defined in the Historian.
Last Quality - Quality of the last value written into the DataSet.
Last Timestamp - Timestamp of the last value written into the DataSet.
Last Value - Last value written into the DataSet.
Low Limit- The default low value used by trending clients supporting limits.
Sample Interval - The minimum number of milliseconds between changing values.
Tag Records - Lists the updates stored by the Historian. The Historian is an update by exception type of database. If the value or quality of an update change from the previously stored value a new update will be stored. No compression is done on the data.
When a tag is selected the default view is to show the newest values at the bottom with a row for each previous value above. Dragging the scroll bar up will show previous data until it nears the top at which time it will load more data from the historian into the grid. This will continue until the data in the grid reaches the beginning of the data specified in the Filter.
Nodes - The Nodes button only appears when viewing Tag Records for a tag at the root of the DataSet and the hierarchy has nodes at the root level. Clicking the button will return to the root of the DataSet.
Filter - Allows the user to specify the range of data, data type and newest or oldest data.
Start: - Timestamp for start of data to load into grid. A calendar control allows selection of the month, day and year. Hours, minutes and seconds can also be typed after the date as shown.
Stop: - Timestamp of end of data to load into grid. A calendar control allows selection of the month, day and year. Hours, minutes and seconds can also be typed after the date as shown.
Data Type: - Raw (when value changes) or Processed (value for each aggregate interval).
Show Newest Data: - When checked will scroll the grid to the end of data specified by the Stop timestamp.
Unchecked will scroll the grid to the start of the data specified by the Start timestamp.
When Processed, Data Type is selected the fields will change to show a dropdown of available aggregates supported by the Views Web Service and the Interval.
Aggregate: - Computation of the raw data for display or analysis over an interval.
TimeAverage2 - Retrieve the time weighted average data over the interval using Simple Bounding Values.
Interpolative - At the beginning of each interval, retrieve the calculated value from the data points on either side of the requested timestamp.
Average - Retrieve the average value of the data over the interval.
TimeAverage - Retrieve the time weighted average data over the interval using Interpolated Bounding Values.
Total - Retrieve the total (time integral) of the data over the interval using Interpolated Bounding Values.
Total2 - Retrieve the total (time integral) of the data over the interval using Simple Bounding Values.
Minimum - Retrieve the minimum raw value in the interval with the timestamp of the start of the interval.
Maximum - Retrieve the maximum raw value in the interval with the timestamp of the start of the interval.
MinimumActualTime - Retrieve the minimum value in the interval and the timestamp of the minimum value.
MaximumActualTime - Retrieve the maximum value in the interval and the timestamp of the maximum value.
Range - Retrieve the difference between the minimum and maximum value over the interval.
Minimum2 - Retrieve the minimum value in the interval including the Simple Bounding Values.
Maximum2 - Retrieve the maximum value in the interval including the Simple Bounding Values.
MinimumActualTime2 - (formerly MinimumTime2) Retrieve the minimum value with the actual timestamp including the Simple Bounding Values.
MaximumActualTime2 - (formerly MaximumTime2) Retrieve the maximum value with the actual timestamp including the Simple Bounding Values.
Range2 - Retrieve the difference between the Minimum2 and Maximum2 value over the interval.
Count - (formerly Count2) Retrieve the number of raw values over the interval.
DurationInStateZero - Retrieve the time a Boolean or numeric was in a zero state using Simple Bounding Values.
DurationInStateNonZero - Retrieve the time a Boolean or numeric was in a non-zero state using Simple Bounding Values.
NumberOfTransitions - Retrieve the number of changes between zero and non-zero that a Boolean or numeric value experienced in the interval.
Start - Retrieve the value at the beginning of the interval using Interpolated Bounding Values.
End - Retrieve the value at the end of the interval using Interpolated Bounding Values.
Delta - Retrieve the difference between the Start and End value in the interval.
StartBound - (formerly Start2) Retrieve the value at the beginning of the interval using Simple Bounding Values.
EndBound - Retrieve the value at the end of the interval using Simple Bounding Values.
DeltaBounds - Retrieve the difference between the StartBound and EndBound value in the interval.
StartBoundActualTime - (formerly Instant) Retrieve the value and bounding timestamp at the beginning of the interval using Simple Bounding Values.
DurationGood - Retrieve the total duration of time in the interval during which the data is Good.
DurationBad - Retrieve the total duration of time in the interval during which the data is Bad.
PercentGood - Retrieve the percentage of data (0 to 100) in the interval which has Good StatusCode
PercentBad - Retrieve the percentage of data (0 to 100) in the interval which has Bad StatusCode.
WorstQuality - Retrieve the worst StatusCode of data in the interval.
WorstQuality2 - Retrieve the worst StatusCode of data in the interval including the Simple Bounding Values.
StandardDeviationSample - Retrieve the standard deviation for the interval for a sample of the population (n-1).
VarianceSample - Retrieve the variance for the interval as calculated by the StandardDeviationSample.
StandardDeviationPopulation - Retrieve the standard deviation for the interval for a complete population (n) which includes Simple Bounding Values.
VariancePopulation - Retrieve the variance for the interval as calculated by the StandardDeviationPopulation which includes Simple Bounding Values.
Interval: - The time the aggregate is to be computed over. 0 is not a legal interval for this filter. Relative entries such as 1h, 1m or 1s will be converted to the correct syntax for 1 hour, 1 minute or 1 second.
Trend - Displays a basic trend of the data currently loaded into the grid.
Refresh - If data in the Historian is updating, the Refresh button will load the latest data.
Tag Records - Display of data according to the Filter applied.
Timestamp - Date\time converted to the time zone and locale of the system.
Value - Raw value or computed value if Data Type is "Processed".
Quality - OPC quality.