AVEVA PI (Beta), Configuration Guide

Purpose 

To provide details about the necessary steps to implement the AVEVA PI data connector for use with the Benchling Connect platform.

Introduction

The AVEVA PI data connector is a component used in the context of the Benchling Connect platform to parse data directly from the AVEVA PI software and make those data available within the Benchling UI in the context of a Run. 

The Benchling Connect - AVEVA PI data connector is an API-based integration, meaning that it is able to communicate directly to your PI instance via the PI Asset Framework (AF) SDK. The AVEVA PI connector is designed to interface with PI System, facilitating operations such as checking system status, browsing files within the system, and copying objects. The benefit to the user is that once configured, the interaction between Benchling and AVEVA PI appears more seamless, with few actions that need to be performed by the user during each session

In order to successfully implement the AVEVA PI data connector for use with the Benchling platform, there are specific steps that need to be followed across both the AVEVA PI software and Benchling user interfaces. 

This guide details the steps to be taken in both applications in order to configure the integration. 

Note: At present, the AVEVA PI data connector is designated as a Beta, meaning that the connector has been tested on minimal example data, with acknowledgment of limitations of the functionality of the connector. Current functionality as well as limitations are included in this guide below.

Steps within Benchling

From within Benchling, a user must:

1. Enable the AVEVA PI data connector on the tenant [internal admin console]
2. Configure a AVEVA PI Connection
3. Configure a Run schema to accept data from AVEVA PI

Enable the AVEVA PI Data Connector

To enable the AVEVA PI data connector, as well as any other Benchling Connect data connectors, please reference the Benchling Connect Installation Guide for enabling data connectors via the Internal Admin Console, as well as details related to creating and installing a Gateway and configuring a Connection.

Configure a AVEVA PI Connection

To configure an AVEVA PI Connection, create a new Connection from either the Connections side panel or global Create, and select the AVEVA PI option.

1. Connection Name
2. Benchling Gateway see previous step
3. Benchling Location - Files stored and can be accessed through this folder inside of Benchling
4. Database - PI database instance to use
5. Element Path - PI Element to retrieve data for

Configure Run Schema to employ AVEVA PI Connection

The Run schema can be created from the menu under Feature Settings.

As part of the Run schema creation, the user should specify 'AVEVA PI' as the Connection Schema.

A run schema is made up of four distinct sections: ‘metadata’, ‘run fields’, ‘input file configurations’, and ‘output file configurations’. For retrieving data from AVEVA PI, follow all of these steps below when making a Run Schema. 

Metadata

• Add the name and other preferences at the top of the schema

Run Fields

• There are required fields that are necessary to retrieve data
  • To retrieve data, the required fields are:
    • Start Time (datetime field type) - any field with “start” and “time” in the name will be recognized
    • End Time (datetime field type) - any field with “end” and “time”
    • Interval – default in seconds (integer field type) - any field with “interval”
      • Minutes and Hours also supported - add “min” or “hour” to field name
• Optionally, users can add a Prefix text field which will replace the default (‘aveva-pi-adapter’) naming prefix of the ingest file
• Under ‘Definition’, search for the desired entity’ or field type

 Configure the Output File Processor

For details on configuring the Output File Processor within the Run schema, please refer to these articles.

• Configure the Output File Config of a Benchling Connect Run
• Configure the Output File Processor to Create New Entities
• Configure the Output File Processor to Capture Results

Optionally, users can Configure the Display Name of their run by entering a name for the header of the output file.

AVEVA PI Data Connector Requirements

Revision History

2024/12/19

Initial Version

2025/04/03

Update configuration fields for AVEVA PI connection creation

Update configuration fields for AVEVA PI Run Schema creation

Remove column mapping from PI Attributes – not currently supported by connector