Reference · built on requestConnectorPLC, SCADA & MES

AVEVA PI System

PI Points, AF elements, attributes, event frames, and streaming values from the PI System over PI Web API.

Request accessPricing ↗

About

AVEVA PI System is a time-series historian (the Data Server, holding PI Points) paired with the Asset Framework (the Asset Server, holding databases of elements, attributes, and event frames). PI Web API is its RESTful interface: a stateless JSON service over HTTPS where every primary object has a persistent, URL-safe WebID and responses carry links to related resources. Its controllers include Point, Stream, StreamSet, Element, Attribute, EventFrame, AssetDatabase, DataServer, Analysis, Batch, and Channel, and it supports create, read, update, and delete on AF objects.

An operator on Fibric reads recorded, interpolated, and summary values, subscribes to channels for live changes, and proposes a value write or a new event frame for your approval. Each proposal carries a receipt with the WebIDs it touched.

This is a reference listing. It documents what Fibric would read from AVEVA PI System and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Time-series values from the Stream controller: GetRecorded, GetInterpolated, GetPlot, GetSummary, GetValue, and GetEnd for a point or attribute
  • Many streams at once through StreamSet, and live value changes over a Web Socket channel at wss://.../streamsets/{webId}/channel
  • AF elements, their attributes, and templates from the Element and AssetDatabase controllers, found by path, WebID, or GetElementsQuery
  • Event frames with start and end times, referenced elements, captured values, and annotations from the EventFrame controller
  • PI Point metadata by search through Point.GetPointsBySearch, and Data Server and Asset Server inventories
  • Analyses and notification rules attached to elements, through the Analysis and NotificationRule controllers

Proposed actions

  • Target capability: propose a value write to a point or attribute through Stream.UpdateValue or UpdateValues
  • Target capability: propose a new event frame through EventFrame.CreateEventFrame, with CaptureValues to snapshot its attributes
  • Target capability: propose an annotation on an event frame through CreateAnnotation, or Acknowledge one already open
  • Target capability: propose creating an element or attribute in an AF database through Element.CreateElement or CreateAttribute
  • Target capability: propose several related calls as one Batch.Execute request, which packs multiple logical REST requests into one HTTP request

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Open a work order from a trend, not a trip

    Read summary values for vibration and temperature attributes per asset, project when a limit will be crossed, and propose a work order in your CMMS.

    With Predictive Maintenance

  • Explain a stoppage from its event frame

    When an event frame closes on a line element, gather the captured values and neighbouring streams, and draft a root cause note for review.

    With Root Cause

  • Catch a submeter drifting from its parent

    Compare interpolated energy values for child meters against the parent feed each interval and flag the meter whose share moves.

    With Submeter Drift

  • Shave peak demand with historian context

    Subscribe to demand streams over a channel, compare against the day's peak so far, and propose a load reduction for approval.

    With Peak Demand

Requirements

  • A PI Web API instance reachable over HTTPS, in front of your Asset Server and Data Server
  • PI Web API configured for Bearer authentication, with a client registered on the identity provider and its client_id and client_secret held by Fibric
  • Clientid mappings on each AF database and Data Server the operator will read or write, since access follows those identities
  • Web Socket (wss) reachability from the connector's host to PI Web API if you want channels rather than polling
Authentication
Bearer authentication with OpenID Connect: a client registration on your identity provider with the client_credentials grant, a token requested with scope=system from the token endpoint named in /piwebapi/.well-known/openid-configuration, and clientid mappings on the AF and Data Server resources the connector reads.

Limits

  • Channel messages are not guaranteed to arrive in chronological order, and only streams whose values changed appear in each message
  • A channel polls the PI data update queue at ChannelPollingInterval, default 1000 milliseconds; changes cannot arrive faster than that
  • Modified history reaches a channel with Substituted set to true, and deleted values with Good set to false and a digital state of No Data
  • PI Web API is stateless: there is no check-out, change, check-in transaction, so every request stands alone

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request AVEVA PI System ↗

Questions and answers

How does PI Web API identify objects?
Every primary resource carries a WebID, an identifier that is persistent and URL-safe. Clients treat it as opaque and may cache URLs that contain it. Responses also include links to related resources, so a client navigates from an Asset Server to its databases, elements, and attributes without building URLs by hand.
Can the connector receive values as they change?
Yes, through channels: a Web Socket at wss://host/piwebapi/streams/{webId}/channel or a streamsets equivalent. Each message holds the value changes since the previous one, in the same shape as GetEnd. includeInitialValues sends current values on connect, and heartbeatRate sends an empty message after idle polling intervals.
Which HTTP verbs does PI Web API use for writes?
POST creates a resource and returns 201 with a Location header holding the new WebID URL. PUT updates with a complete definition, PATCH with a partial one, and DELETE removes. Stream.UpdateValue and UpdateValues write values to a point or attribute.
Ask about AVEVA PI System

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with AVEVA PI System through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy