Version 0.1.0 runs as a container on a Tetra Hub or in the Tetra cloud, like other Pluggable Connectors. It has no Windows installer. All configuration is done through the Tetra UI. If you need Kerberos/SSPI authentication or tag-based data collection, use v0.2.0 instead.

🚧

IMPORTANT

v0.1.0 supports basic authentication only (username and password). Kerberos/Windows-integrated authentication is not available in this version.

Overview

To deploy and run the AVEVA PI Connector v0.1.0, do the following:

1. Complete the prerequisites
2. Deploy the connector
3. Configure PI settings in Tetra
4. Verify data is flowing

Step 1: Complete the Prerequisites

Network Requirements

The connector connects to your PI Web API server over HTTPS (port 443):

• Hub deployment: the Hub machine must have outbound HTTPS access to the PI Web API server.
• Cloud deployment: Tetra's cloud infrastructure connects to the PI Web API server; the server must be reachable from Tetra's cloud IP ranges.

The connector also requires outbound HTTPS access to:

PI Prerequisites

• PI Web API must be installed and accessible over HTTPS.
• The PI Web API server must accept username and password credentials (basic authentication).
• The PI user account must have read access to the PI Asset Framework (AF) database you want to poll.
• SSL certificates: if your PI Web API uses a self-signed or internal CA certificate, you have two options:
  • Upload your CA certificate to your Tetra organization and set Verify SSL Certificates to selected to enable full verification (recommended for production).
  • Clear Verify SSL Certificates to skip certificate verification (development and test environments only).

Step 2: Deploy the Connector

Create the connector by following Create a Pluggable Connector:

1. In the Tetra UI, open the Connectors page and choose Create Connector.
2. For HOST, select Hub and choose your Hub, or select Cloud.
3. For CONNECTOR TYPE, select AVEVA PI. For CONNECTOR VERSION, select v0.1.0.
4. Choose Create.

The connector starts in IDLE state. You will set it to Running after configuring it in the next step.

Step 3: Configure PI Settings in Tetra

All PI configuration is managed through the Tetra UI.

1. In the Tetra UI, navigate to Connectors and select your AVEVA PI connector.
2. Select Configuration.
3. Set the required fields:

4. Optionally, configure additional fields:

📘

NOTE

v0.1.0 polls PI Asset Framework event frames only. Tag-based (PI Point) and element-path-based data collection are not available in this version — use v0.2.0 for those modes.

5. Save the configuration.
6. On the connector's details page, select Set to Running. The connector begins polling on the next interval.

Step 4: Verify Data Is Flowing

1. Wait for the first polling cycle to complete (default interval: 5 minutes).

📘

NOTE

On the first poll after deployment, the connector retrieves the last 24 hours of event frame data as a baseline. Subsequent polls retrieve only new data since the last poll.

2. In Tetra, navigate to Data Lake and search for files uploaded by this connector.
3. Files should appear under the connector's source path in the data lake.

Custom Commands

RetrieveTimeWindowData

Action: TetraScience.Connector.PI.RetrieveTimeWindowData.v1

Retrieves PI event frame data for specific historical time windows and uploads each window as a separate file. Use this to backfill data for periods the connector missed.

Parameters:

Example:

Send the command using the Create Command endpoint. Replace your-connector-id with the Connector ID from the connector's detail page in Tetra, and set expiresAt to a future timestamp.

{
  "targetId": "your-connector-id",
  "action": "TetraScience.Connector.PI.RetrieveTimeWindowData.v1",
  "expiresAt": "2026-11-01T00:00:00.000Z",
  "payload": {
    "time_windows": [
      {
        "start_time": "2024-01-15T00:00:00Z",
        "end_time": "2024-01-15T23:59:59Z",
        "window_name": "2024-01-15-backfill"
      }
    ]
  }
}

Time windows must not overlap each other. The command processes each window sequentially and uploads a file for each one, even if a window contains no data.

Troubleshooting

Upgrade to v0.2.0

Version 0.2.0 adds tag egress, element egress, Kerberos/SSPI authentication, and Windows MSI deployment. It also changes how event frame polling is enabled.

Before upgrading, note:

• Authentication Mode is now required. v0.1.0 configs don't have this field. After upgrading, set Authentication Mode to basic in the Tetra configuration UI, or the connector won't validate.
• Event frame polling is off by default in v0.2.0. In v0.1.0, the connector always polls event frames. After upgrading, select Enable Event Frame Polling in the Tetra configuration UI, or the connector stops collecting event frames.
• Two configuration fields were renamed: PI Asset Server Name (asset_server) → PI Asset Framework Server Name (af_server); Asset Database Name (asset_database) → AF Database Name (af_database). See the AVEVA PI Connector Installation Guide (v0.2.0) for full migration steps.

For Hub or Cloud deployments, follow the standard upgrade procedure for Pluggable Connectors: edit the connector in Tetra and change the version to v0.2.0. There is no separate installer. After upgrading, update the configuration as noted above.

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘

NOTE

Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.