AF EventFrameSearch

By using the AF EventFrameSearch activity, you can search AF EventFrame from the PI AF Server. The following sections describe the tabs for this activity.

General

On the General tab, you can specify the name of the activity in the process, establish a connection to the PI AF Server, and select the type of operation you want to perform.

The following table lists the fields on the General tab of the AF EventFrameSearch activity:

Field Module Property? Visual Diff? Description
Name No Yes A unique name of the activity in a process.
Server Connection Yes Yes The PI AF shared resource that is selected to connect to the PI AF Server.

Click the icon to select an OSIsoft PI System AF connection resource. If a matching OSIsoft PI System AF connection resource is not found, click Create Shared Resource to create one.

Note: This activity supports only PI AF Server as server type.
Operation No Yes

The type of operation user want to perform on the AFAttribute values:

searchEventFrames: search AFEventFrame objects on the PI AF Server
Search Mode No Yes

The search mode that you can perform on the searchEventFrames operation.

The following search modes are available:

  • Active Between

  • Ending Between

  • Starting Between

  • Entirely Between

  • Ending After

  • Ending Before

  • Starting After

  • Starting Before

    For more details about search modes, see the OSIsoft website.

Description

On the Description tab, you can type a short description for the AF EventFrameSearch activity.

Input

On the Input tab, you can specify AFEventFrame start time, AFEventFrame end time, AFEventFrame progress value, AFEventFrame descendant value, AFEventFrame name, AFEventFrame analysis, AFElement name, AFEventFrame category, AFEventFrame template, AFEventFrame search mode, AFEventFrame number of records to search the appropriate number of AFEventFrame for the AF EventFrameSearch activity.

Input elements on this tab differ depending on the operation that you select on the General tab:

Operation Reference
searchEventFrames searchEventFrames: Input Items

Output

On the Output tab of the AF EventFrameSearch activity, you can find the results corresponding to your inputs. The output elements on this tab differ depending on the operation name that you select on the General tab.

Note: All the timestamps are in the UTC time zone.

Output elements on this tab are different depending on the operation you select on the General tab:

Operation Reference
searchEventFrames searchEventFrames: Output Items

Fault

On the Fault tab, you can find the error messages and error codes of the AF EventFrameSearch activity.

For more information about errors, see Error Codes.

The following table lists the error schema elements on the Fault tab:

Output Item Data Type Description
msg String Displays the error message.
msgCode String Displays the error code.