Batch Interface Framework Property result definition

Events

Columns

The Batch Interface Framework Property result definition retrieves any event values from a PI Batch property, located at any level of the PI Batch structure.

This result definition can be configured to filter events for particular properties, providing custom support for any user-defined PI Batch property structure.

This result definition can also be used to support PI Batches generated with the EVT Interface, both for procedure-level batch execution systems and for unit operational systems.

You add and edit result definitions in the Result Definition pane of the Journal Action Edit window. You open the Journal Action Edit window by right-clicking the journal action node and then clicking Property.

• Delimiter

  The character used in the tags which separate the values into columns. The default is a pipe |.

• Parent Property

  Defines the path to the particular property. The path can be absolute, relative or left empty.

• Absolute paths begin with \\ and define the entire path of the PI Batch record down to the level that contains the event data.

• Relative paths define the location of events based on the level of the batch structure in the data template where the journal action is located. Two dots can be used to go up one level in the batch structure. For example, ..\[Recipe].

• An empty path retrieves events from the level in the PI Batch structure that corresponds to the level in the data template where the journal action is defined.

• Property

  Defines the name of the event for which you wish to retrieve data.

  This can be a single event name, or a collection of events defined using wildcard characters.

The Columns table defines which columns are created in the data journal, based on the order of values in the event tags. Columns can be added, removed, and reordered.

• Column

  The index number for the current column.

  This value cannot be changed and is not returned to the data journal.

• Column Name

  The name for the column, as it is stored in the Name field of the data journal.

• Display

  Determines if the column is included in the data journal.

  The Yes option includes this column and No leaves it out.

• Filter (n)

  Defines a particular set of criteria which determines if the event data is written to the data journal.

  Single or multiple filter columns filter the event data.

  • If event tag data matches any of the criteria in the filter columns, the data is written to the data journal.

  • Data that does not match any of the filter column criteria is left out.

  • Without any defined filter columns, all event tag data is written to the data journal.

BIF (Batch Interface Framework) property journal action

When running reports against event frame contexts, the BIF property journal action can be used to reference event frame attributes. The BIF event frame attribute will support all data references as long as the value type is Basic/Enumeration sets.

Note: Child attributes are not compatible and will be omitted from the Data Journal.

AF Attributes with a batch context

If you try to run a batch report against AF data types, the report will fail to run. AF data types are not supported for batch contexts. You will see the below error message.