Differences

This shows you the differences between two versions of the page.

--- iphist:index [2021/06/28 07:26] – su
+++ iphist:index [2022/08/29 12:05] (current) – [Licensing] su
@@ Line 5: / Line 5: @@
 ===== Introduction =====
-Intelligent Plant's data historian is integrated as a part of Data Core, this is able to use data from any Data Core datasource, and to record data from that as subscribed to with a data stream.
+Intelligent Plant's data historian is integrated as a part of Data Core. As such, it can take advantage of Data Core's data streaming capabilities to observe and record incoming tag values from any other supported data source.
+For many data sources (such as Modbus, MQTT, and more), it is possible to automatically forward tag values from the source using a simple one-click configuration.
+Additionally, IP Historian tags can be configured up-front to define a source data source and tag name, allowing new source-to-destination tag mappings to be configured automatically as you create new historian tags.
-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=====
@@ Line 18: / Line 22: @@
 ===== Data Query Types =====
+IP Historian supports a number of different types of data queries.
 ==== Snapshot ====
@@ Line 38: / Line 44: @@
 ==== Values-at-Times ====
-A values-at-times query is used to retrieve the value of a tag at specified points in time. IPHist will return the closest raw value at or before each specified sample time.
+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.
 ==== 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. IPHist supports a number of aggregation functions, as described below:
+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 ==
@@ Line 98: / Line 104: @@
-=====Archiving Model=====
+==== Annotations ====
-IPHist supports
+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.
-A Single index for all data (recommended for constants, or values that change infrequently)
-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,
+==== Specifying Query Time Ranges ====
-=====System Requirements=====
+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), or as relative timestamps (e.g. 30 minutes before the current time).
-=====Licensing=====
+===== Archiving Model =====
-IPHist instances that are connected to the Industrial App Store are free.
+IP Historian supports multiple indexing models depending on the requirements of the data being recorded:
-The free 1000 tag license is applied automatically, but increasing this tag count will be done free of charge by client request.
-Instances that are not directly connected to the app store (on the PIN or PCN) are charged per 1000 tags.
+  * "One Big Index" - optimised for constant or infrequently-changing values.
+  * "Index per Day/Month/Year" - stores data in an index that will periodically roll over to provide the best balance between data storage and query performance.
+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:system_requirements|See App Store Connect System Requirements]].
+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 that are not directly connected to the Industrial App Store (e.g. deployments on a PIN or PCN) require a paid-for licence that is issued in 1000 tag increments.
+==== How to find your Machine ID ====
+It is necessary to know the Machine ID of your system for licensing to be completed. To find your Machine ID, you must first open App Store Connect and select "Configure Data Core".
+Go to your Data Sources and click "Details" on the historian that you wish to use.
+{{:app_store_connect:data_core_-_data_sources_selection.png?300|}}
+{{:app_store_connect:data_core_-_details.png?500|}}
+Under Action, click "Configure Data Source Settings"
+{{:app_store_connect:data_core_-_configure_settings.png?300|}}
+And at the bottom you will see the Machine ID for your system.
+{{:app_store_connect:data_core_-_machine_id.png?800|}}
 =====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 ..?
+For further information regarding replication and data resilience, contact support@intelligentplant.com.
 =====Other historian - IPHist replication, or vice-versa =====