OSI PI Historian Integration Guide

review the following guide for setting up an integration to allow the litmus edge systems to connect with the pi historian web api for data exchange and interaction before you begin you will need the following access to osi pi server and pi system management tools make sure to update your litmus edge version to 3 16 0 or later to access the osi pi historian connector in the integrations step 1 add device follow the steps to connect a device docid 3eyafppweuvmblcey17sq the device will be used to store tags that will be eventually used to create outbound topics in the connector make sure to select the enable data store checkbox step 2 add tags after connecting the device in litmus edge, you can add tags docid 8se7z3pmrfwl1nmzcwalx to the device create tags that you want to use to create outbound topics for the connector step 3 add the osi pi historian connector follow the steps to add a connector docid\ b7emdh8ao2 noqdhwpd7y and select the osi pi historian provider configure the following parameters name enter a name for the connector description (optional) enter a description for the connection endpoint enter the address of the osi pi historian web api (configured with omf plugin) username enter the username for access password enter the user password ca certificate (optional) upload or paste the ssl ca certificate gzip compression enable gzip compression for omf requests request timeout set the http request timeout in milliseconds data timezone (optional) utc zone information to append to outbound data timestamps data source type (optional) text to be used as the root name for the data source if empty, pi points will show "piwebapi omf" data source version (optional) text to be used as the data source suffix requires a non empty data source type point name format text with format directives to generate pi point names point datatype format text with format directives to generate af type names point description format (optional) text with format directives to generate pi point descriptions check tags (optional) select to check if the point name exists before attempting to create a new one publish count threshold set the publish count threshold (1 disables batching) publish delay threshold set the publish delay threshold in milliseconds (0 disables batching) pi data server name (optional) enter the name of the pi data archive server defaults to the first found subscribe interval enter the polling interval in seconds max subscription events enter the maximum number of events processed per subscription poll (prioritized by the most recent) insecure skip verify (optional) select to disable verification if you do not want the client to verify the server's certificate chain and host name parallel publish count set the number of simultaneously publishing messages persistent storage (optional) when 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 queue mode (optional) 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 format directive notes make sure to handle format directives with care when making changes refer to the points below for more details 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 ?;{}\[]\\'"| to use a special character in its literal form, enter the symbol twice $$ > $ , %% > % example $$$d %%$n" > "$deviceabc %tagxyz a special character must be followed by either itself or one of the supported characters refer to osi pi historian docid 0fuajiub u2 dxww y3l6 to get the list of symbols with their definition 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 step 4 enable the connector after adding the connector, click the toggle in the connector tile to enable it if you see a failed status, you can review the manage connectors docid 5hctorlhgax3ikh lvi0a and relevant error messages step 5 create topics for connector you will now need to import the tags you added in step 2 to the osi pi historian connector as topics to create outbound topics click the connector tile the connector dashboard appears click the topics tab click the add tags icon the add subscription dropdown appears click the +add a new subscription in dropdown menu the create subsubscription dialog appears for publishing litmus edge data to aws sitewise asset measurement, define the following data direction = local to remote outbound local topic = any topic in litmus edge remote topic = asset measurement alias defined on the aws sitewise portal the measurement alias is a user defined string for each measurement can be found under the alias column description = description for the subscription optional field click ok to add the subscription step 6 enable topics ensure the topics you imported are enabled by returning to the topics tab and clicking the enable all topics icon step 7 verify data in pi system management tools access the pi system management tools and verify that litmus edge is successfully sending data