iphist:index
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
iphist:index [2021/06/25 15:51] – su | iphist:index [2021/08/16 12:15] – [System Requirements] su | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== Introduction ===== | ===== Introduction ===== | ||
- | Intelligent Plant' | + | Intelligent Plant' |
+ | |||
+ | For many data sources (such as Modbus, MQTT, and more), it is possible | ||
+ | |||
+ | Additionally, | ||
- | eg. Modbus, OPC, MQTT, etc.. The majority of data can all be automatically recorded and mostly filtered with default exception and compression rules. | ||
=====How Historians Work - Exception and Compression===== | =====How Historians Work - Exception and Compression===== | ||
Line 17: | Line 21: | ||
+ | ===== Data Query Types ===== | ||
+ | IP Historian supports a number of different types of data queries. | ||
- | =====Historical Vs. Snapshot===== | + | ==== Snapshot ==== |
+ | Snapshot queries return the current values of the tags polled. | ||
- | =====Functions and Aggregations===== | ||
- | ==== SNAPSHOT | + | ==== Raw ==== |
- | Snapshot queries are used to request | + | A raw query returns |
- | ==== AVG ==== | + | Raw queries are generally not advised as they are likely to return a bulky result-set that may well be cropped by size constraints. In the majority of cases, a plot or aggregated data query can return a data set that is acceptable for the task at hand. |
- | Returns the average value at interavals defined by the query interval ie adds up all values and returns the average | ||
- | ==== MIN ==== | ||
- | Returns the minimum value for each interval (the lowest value observed in that time) | + | ==== Plot ==== |
- | note, with the two filters applied - there is no loss in resolution of the minimum value, that minimum is still recorded and delivered. | + | |
- | ==== MAX ==== | + | |
- | Returns | + | Plot queries return a best-fit data set for a given query time range and level of granularity, |
- | ==== STDDEV ==== | ||
- | Returns the standard deviation of the values in each interval | + | ==== Values-at-Times ==== |
- | ==== INTERP ==== | + | A values-at-times query is used to retrieve the value of a tag at specified points in time. IP Historian will return the closest raw value at or before each specified sample time. |
- | returns an interpolated value for the exact time of the interval (taking the value recorded before and after the interval) - if interp is used at a simliar rate to the original data samples then it tends to return the same values that were recorded (within a reasonable tolerance as defined by exception and compression) if this is called at a resolution that is lower than that, it may miss maximums, and minimums | ||
- | ==== PLOT ==== | ||
- | Plot is used to draw applicable graphs of data with minimal data exchange and loss of data. for any interval the maximum and minimum value will be retained, along with the shape of the values that were recorded as far as can be done with the interval passed. | + | ==== Aggregated ==== |
+ | Aggregated queries can be used to perform ad hoc processing and filtering of raw historical data based on a query time range and sample interval. IP Historian supports a number of aggregation functions, as described below: | ||
+ | == ANNOTATIONCOUNT == | ||
+ | Groups the raw data for a tag into buckets using the specified sample interval and returns the number of annotations defined on a tag in each bucket. | ||
- | ==== RAW ==== | + | == AVG == |
- | A raw query returns the unprocessed | + | Groups the raw data for a tag into buckets using the specified sample interval and computes |
- | Raw queries are generally not advised as they are likely to return a bulky result-set that may well be cropped by size constraints. If connecting to a Process Data Historian, it is far more efficient to request “Get Processed Data” with an “INTERP” function instead. | + | == COUNT == |
+ | Groups the raw data for a tag into buckets using the specified sample interval and returns the number of raw samples in each bucket. | ||
- | =====Specifying Date-Ranges===== | + | == DELTA == |
- | Historical | + | Groups the raw data for a tag into buckets using the specified sample interval and returns the signed difference between the first and last raw samples in each bucket. |
- | For '' | + | == INTERP == |
- | Relative values can be specified | + | Groups the raw data for a tag into buckets |
- | =====Archiving Model===== | + | |
- | IPHist supports | + | == MIN == |
- | A Single index for all data (recommended | + | Groups the raw data for a tag into buckets using the specified sample interval and returns the minimum value from each bucket. Note that the original raw samples are returned, so the values are the " |
- | An index per year, month, etc.. | + | |
- | we normally recommend index per month as the indexing period for process data. | + | |
- | =====Backing Up===== | + | |
- | Indexes can be backed up and restored on another IPHist instance, | + | == MAX == |
- | =====System Requirements===== | + | |
+ | Groups the raw data for a tag into buckets using the specified sample interval and returns the maximum value from each bucket. Note that the original raw samples are returned, so the values are the " | ||
- | =====Licensing===== | + | == PERCENTBAD |
+ | Groups the raw data for a tag into buckets using the specified sample interval and computes the percentage of raw samples in each bucket that have a quality flag set to " | ||
- | IPHist instances that are connected to the Industrial App Store are free. | + | == PERCENTGOOD == |
- | The free 1000 tag license is applied automatically, | + | |
- | Instances | + | Groups the raw data for a tag into buckets using the specified sample interval and computes the percentage of raw samples in each bucket that have a quality flag set to " |
+ | |||
+ | == RANGE == | ||
+ | |||
+ | Groups the raw data for a tag into buckets using the specified sample interval and returns the absolute difference between the first and last raw samples in each bucket. | ||
+ | |||
+ | == STDDEV == | ||
+ | |||
+ | Groups the raw data for a tag into buckets using the specified sample interval and returns the standard deviation for each bucket. | ||
+ | |||
+ | == TAVG == | ||
+ | |||
+ | Calculates a time-based rolling average for a tag. | ||
+ | |||
+ | == VARIANCE == | ||
+ | |||
+ | Groups the raw data for a tag into buckets using the specified sample interval and returns the variance for each bucket. | ||
+ | |||
+ | |||
+ | ==== Annotations ==== | ||
+ | |||
+ | IP Historian allows annotations to be recorded against tags at specific points in time. Annotations can be used to track or highlight events a tag value exceeding an operating limit, an action taken as part of a workflow, and so on. | ||
+ | |||
+ | |||
+ | ==== Specifying Query Time Ranges ==== | ||
+ | |||
+ | As part of the Data Core data connectivity layer, IP Historian can accept query time ranges specified as both absolute timestamps (using standard ISO 8601 formatting), | ||
+ | |||
+ | |||
+ | ===== Archiving Model ===== | ||
+ | |||
+ | IP Historian supports multiple indexing models depending on the requirements of the data being recorded: | ||
+ | |||
+ | * "One Big Index" - optimised for constant or infrequently-changing values. | ||
+ | * "Index per Day/ | ||
+ | |||
+ | When recording process data, we normally recommend "Index per Month" as the optimal indexing period. | ||
+ | |||
+ | |||
+ | ===== Backing Up ===== | ||
+ | |||
+ | Indexes can be backed up and restored on another IP Historian instance. | ||
+ | |||
+ | |||
+ | ===== System Requirements ===== | ||
+ | |||
+ | See [[app_store_connect: | ||
+ | |||
+ | However, note the system requirements should be adjusted for the particular use-case of the historian. If you intend to support historization of large data volumes and intensive data queries, a more powerful spec is required. Please consult with the Intelligent Plant support team for detailed guidance. | ||
+ | |||
+ | ===== Configuration Best Practice ===== | ||
+ | |||
+ | Details to follow. | ||
+ | |||
+ | |||
+ | |||
+ | ===== Licensing ===== | ||
+ | |||
+ | When connecting IP Historian to the Industrial App Store, there is no licensing cost. An initial 1000 tag licence is supplied, but can be increased free of charge by client request. | ||
+ | |||
+ | IP Historian deployments | ||
=====IPHist - IPHist replication===== | =====IPHist - IPHist replication===== | ||
+ | Connections can be setup in datacore to provide reslient transfer of historical data between IPHist instances. this means that a loss in connectivity will not result in a permanent loss of data on the remote IPHist to the datasource. that data will be back filled, and consistent. | ||
+ | |||
+ | this can be configured by ..? | ||
+ | |||
+ | |||
+ | =====Other historian - IPHist replication, |
iphist/index.txt · Last modified: 2022/08/29 12:05 by su