system.historian
Historian Functions
The following functions give you access to interact with the Historian system.
Path Syntax
The historian system functions all include a path or source parameter of some form. It is recommended to use a qualified historical path syntax that includes sys and prov to identify the Gateway and Tag Provider name, respectively. For example, the following path identifiers would result in the Historical Path Example below:
- The name of the Historian Provider: Sample_DB
- The Gateway name: myGateway
- The Tag Provider name: myProvider
- The tag folder path: Folder/New_Folder
histprov:Sample_DB:/sys:myGateway:/prov:myProvider:/tag:Folder/New_Folder
Note that this format will not work for the SQL Historian, as this historian requires the drv key-value pair to be used. Additionally, any drv syntax used in Ignition 8.1 will still work in 8.3.
histprov:Sample_DB:/drv:myGateway:myProvider:/tag:Folder/New_Folder
📄️ browse
Returns a list of browse results for the specified historian.
📄️ deleteAnnotations
Deletes desired annotations from the specified historian.
📄️ queryAggregatedPoints
Queries aggregated data points for the specified historian.
📄️ queryAnnotations
Queries annotations for the specified historian.
📄️ queryMetadata
Queries metadata for the specified historian.
📄️ queryRawPoints
Queries raw data points for the specified historian.
📄️ storeAnnotations
Store a list of annotations to the specified historian.
📄️ storeDataPoints
Store a list of data points to the specified historian.
📄️ storeMetadata
Store a list of metadata to the specified historian.
📄️ updateRegisteredNodePath
Updates the existing historical path for a stored historian node to the newly specific path.