SubBatch templates

You specify which PI SubBatches or child event frames to include in a generated report in the SubBatch Template Edit window. SubBatches are represented in the data journal as SubBatchJournal objects.

You create a SubBatch template object by right-clicking on a unit template object and clicking Insert > SubBatch Template. You can edit the SubBatch template by right-clicking the SubBatch template node and clicking Property.

Layout

• Name

  The name displayed in the data template for the SubBatch template node.

• Display Name

  The display name for the SubBatch template in the data journal.

• Description

  The description for the SubBatch template.

Spanning

The Spanning tab defines a time span across PI SubBatches or child event frames, and filters the SubBatch collection defined on the Layout tab. You can choose a SubBatch to use for the span start time, then choose another SubBatch to use for the span end time.

• Span Start

  Defines the starting point of the span. For example, start at the start or end time of the first SubBatch.

• Span End

  Defines the ending point of the span. For example, end at the start or end time of the last SubBatch.

• Process Step

  Defines a collection of SubBatches from which to select the basis for the span start or end time. You can supply a SubBatch name, single-character wildcard (?), multi-character wildcard (*), or report parameter definition.

• Select

  Once a collection of SubBatches has been defined in the Process Step field, you use the Select field to define the particular SubBatch to use for the span start or end time.

  Select field options

  Select option	Value returned
  All	All SubBatches from the collection. Only available for Span Start when double-filtering a collection of SubBatches already defined on the Layout tab.
  First	The first SubBatch from the collection.
  Last	The last SubBatch from the collection.
  Index (value n)	The nth value of the collection.

• Condition

  A PI performance equation that the RtReports generator calculates at the start of each PI SubBatch that meets the previous criteria. If the PI performance equation returns a true value, the PI SubBatch or child event frame is included in the report. If the equation returns a false value, then the PI SubBatch is excluded.

  For example, you can exclude any subbatch that contains a digital state of SHUTDOWN.

• Evaluate From

  Once you define the SubBatch for the start time, you define the span start time using either the Start or End time of the subbatch in the Evaluate From field.

• Evaluate To

  Once you define the SubBatch for the end time, you define the span end time using either Start or End time of the subbatch in the Evaluate To field.