OSI PI Historian

overview osi pi historian integration enables edge system to connect with pi historian web api supported communication outbound publish data from edge to pi inbound subscribe to data from pi to edge configurations variable detail required name connector name yes description enter a description for the connection no endpoint address of osi pi historian web api (configured with omf plugin) yes username user name yes password user password yes ca certificate ssl ca certificate no compression enable gzip compression for omf requests yes request timeout http request timeout in milliseconds yes data source type text to be used as root name for datasource if empty, pi points will show "piwebapi omf" no data source version text to be used datasource suffix requires non empty datasourcetype no point name format text with format directives to generate pi point names yes point datatype format text with format directives to generate af type names yes point description format text with format directives to generate pi point descriptions no data timezone utc timezone information to append to outbound data timestamps no check tags check if point name exists before attempting to create new no publish count threshold publish count threshold (1 disables batching) yes publish delay threshold publish delay threshold in milliseconds (0 disables batching) yes piserver name of pi data archive server defaults to first found no subscribe interval polling interval in seconds yes max subscription events maximum number of events processed per subscription poll (prioritised by most recent) yes insecure skip verify insecureskipverify controls whether a client verifies the server's certificate chain and host name select to disable verification no parallel publish count the number of simultaneously publishing messages yes persistent storage if enabled, messages in the outbound queue are stored on disk if there are interruptions in connection or power loss, messages will be retained and eventually sent when the connection is restored no queue mode select the sequence of data transfer fifo or lifo selecting fifo (first in first out) will send the earliest message first selecting lifo (last in first out) will send the latest message first no format directives warning ensure to handle format directives with care when making changes any change to metadata format settings is only applicable to proceeding data once ingested to pi, metadata of existing pi points will not be modified point names will change if inner variable value changes (e g tag description) this may result in new pi points being created the following characters will be removed from any format string ?;{}\[]\\'"| symbol definition context $ special character indicate a variable character follows a variable represents some dynamic string value supported variables defined as follows $s data source type from connector settings $v data source version from connector settings $d device name from devicehub tag $n tag name from devicehub tag $t tag type from devicehub tag (shown as opcua/pi type) $r raw tag type from devicehub tag $p tag description from devicehub tag $h hostname from os % special character indicating a function character follows a function represents some action to be taken on the next variable supported functions defined as follows %l lowercase() apply to next variable %u uppercase() apply to next variable format directive notes to use a special character in its literal form, enter symbol twice $$ > $ , %% > % example $$$d %%$n" > "$deviceabc %tagxyz a special character must be followed by either itself, or one of the supported characters in the table above any other condition will result in an error example 1 $d $n$% > error example 2 $d $n$ > error example 3 $d $n$# > error functions only act on the next variable found in the string next steps docid\ dxbxmwrxqvk5i8tjuaouk