--- title: OSI PI Historian slug: litmusedge/product-features/integration/integration-connectors/aveva/osi-pi-historian docTags: createdAt: 2026-09-04T21:17:03.635Z --- The OSI PI Historian Gen 2 integration enables Litmus Edge to connect with the PI Historian Web API. :::hint{type="info"} **Note:** This connector is experimental and under development. Some features and functionality might not be fully functional. ::: ## Supported communication - Outbound (Publish data from Edge to PI Historian Web API) - Yes - Inbound (Subscribe data from PI Historian Web API to Edge) - Yes ## Configurations | **Field** | **Details** | **Required** | | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | Name | Name of the connector instance. | Yes | | Description | Description of the connector instance. | No | | Endpoint | Base URL of the PI Web API server this connector connects to. | Yes | | Username | Username used for authentication. | Yes | | Password | Password used for authentication. | Yes | | Insecure skip verify | Disable server certificate chain and host name verification. | No | | CA Certificate | CA certificate used to verify the server, in PEM format. Can also be installed in the system-wide certificate store. | No | | Data Timezone | UTC timezone of outbound data. | No | | Data Source Type | Optional root name of datasource for PI points. | No | | Data Source Version | Optional version suffix for root datasource, requires non-empty Data Source Type. | No | | Point Name Format | Formatting directives for PI point name. | Yes | | Point Datatype Format | Formatting directives for PI point datatype (AF type name). | Yes | | Point Description Format | Optional formatting directives for PI point description. | No | | Check Tags | Check if point name exists before attempting to create new when writing. | No | | PI Data Server Name | Optional name of PI Data Archive server. | No | | Request Timeout (ms) | HTTP request timeout in milliseconds. | Yes | | Publish Delay Threshold (ms) | Publish delay threshold in milliseconds. | Yes | | Publish Count Threshold | Publish count threshold. | Yes | | Subscribe Interval (s) | The subscription polling interval in seconds. | Yes | | Max Subscription Events | The maximum number of events processed per subscription poll (prioritised by most recent). | Yes | | Parallel Publish Count | The number of simultaneously publishing messages. | No | | Throttling limit | Set a limit on the number of outbound messages per second. If sending data to a server that has restrictions on the rate of incoming messages, this ensures that no messages are lost. | No | ## Persistent storage configurations | **Field** | **Details** | **Required** | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | Persistent storage | If enabled, messages in the outbound queue are stored on disk. If there are interruptions in connection or power loss, messages are retained and eventually sent when the connection is restored. | No | | Persistent storage size limit | Set the size limit for storing persisted data in GB. | No | | Queue mode | Select the sequence of data transfer: `FIFO` or `LIFO`. Selecting `FIFO` (First In First Out) sends the earliest message first. Selecting `LIFO` (Last In First Out) sends the latest message first. | No | ## Format directives **Caution:** Take care when modifying format directives. - Any change to metadata format settings applies only to subsequent data. Once data is ingested to PI, the metadata of existing PI points is not modified. - Point names change if an inner variable's value changes (e.g., Tag Description). This may result in new PI points being created. - The following characters are removed from any format string: `\*?;{}[]\\'"|` | **Symbol** | **Definition** | **Context** | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | | $ | Special character indicates 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 the 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 results 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 Example 1 `%U$D.$N` > `DEVICEABC.tagXYZ` (device name all uppercase) Example 2 `$D%L.$N` > `deviceABC.tagxyz` (tag name all lowercase) Example 3 `$D.$N%L` > `deviceABC.tagXYZ` (no effect)