Skip to main content

Documentation Portal

How does the integration work
PI event frames

Events are important process or business time periods that represent something happening that impacts your process or operations. Examples of different types of events include: asset downtime, process excursions, equipment startups and shutdowns, environmental monitoring excursions, product tracking batches or paper grades, operator shifts, or any other event type that has both a start time and end time.

The PI System has a feature called event frames that capture critical event contexts.  The event frames feature permits customers to capture a name, start time, end time, and a series of related information (event attributes) that are useful for analysis. Typically, event frame templates are made to standardize the related data associated with different types of events.

TrendMiner context items

TrendMiner context items allow the user to add and classify process events on top of its time series, to create situational awareness inside of your process data. When linked to PI event frames, context items contain all the properties that event fames have, including any additional properties provided by the user.

Linking PI event frames to TrendMiner context items

The table below shows an overview of how properties of PI event frames are mapped to properties of context items.

PI Event Frame

TrendMiner context item

Template

Type

Name

Context field: EVENT_FRAME_NAME

Description

Description

Start time

Time of start-event (EFStarted)

End time

Time of end-event (EFEnded)

Primary element (PI AF Element)

Component (asset or attribute)

Attributes

Fields

Other referenced elements

Additional properties

For each PI EF template, a corresponding context item type is created in TrendMiner that will show up in the configuration screen of context item types. This means that an admin user can update the name of the type which is visible in TrendMiner, but will have no effect on the information stored in your PI system.

The “primary element” in a PI event frame refers to an element in the related PI asset framework; the same is valid for TrendMiner: the component in a context item refers to an asset or attribute in the TrendMiner asset framework.