How do I search and query PI Event Frames?

PI Event Frames capture time-bound events (batches, alarms, shifts). Here's how to find and query them.

PI System Explorer

1. Navigate to Event Frames in the left panel.
2. Use the Search panel (Ctrl+F) to filter by:
   • Template name
   • Time range
   • Element path
   • Attribute values

AF SDK (C#)

using OSIsoft.AF.EventFrame;
using OSIsoft.AF.Search;

// Search for event frames
var search = new AFEventFrameSearch(
    db, "MySearch",
    $"Template:'Batch' Start:>'t-7d' ElementName:'Reactor*'"
);

foreach (AFEventFrame ef in search.FindObjects())
{
    Console.WriteLine($"{ef.Name}: {ef.StartTime} - {ef.EndTime}");
    
    // Access event frame attributes
    foreach (AFAttribute attr in ef.Attributes)
    {
        Console.WriteLine($"  {attr.Name} = {attr.GetValue().Value}");
    }
}

PI Web API

GET /piwebapi/assetdatabases/{webId}/eventframes
    ?templateName=Batch
    &startTime=*-7d
    &endTime=*
    &searchMode=Overlapped

Search Modes

• StartInRange: event frame started within the time range
• EndInRange: event frame ended within the time range
• Overlapped: any overlap with the time range (most common)
• InProgress: currently open event frames

Tips

• Use AFEventFrameSearch (not the older FindEventFrames) for better performance.
• Index event frame attributes you frequently search on.
• For large result sets, use FindObjects() with pagination (startIndex, maxCount).