Result definitions

Result definitions define specific logic for retrieval of data using defined time contexts based on data journal objects and state transition times.

Each result definition has a set of common variables, and time parameters and data parameters that depend on the type of result definition.

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.

Result definition variables

• Output

  Defines how the report runs and logs error messages.

  Selecting Output logs a message to the RtReports Server and stops running if there is an error with the journal action.

  Clearing Output logs a message to the RtReports Server and continues running if there is an error with the journal action.

• Name

  Names the result definition.

• Type

  Defines the result definition type.

  Type	Used for
  AF Attribute Value	Retrieving a standalone AF attribute value or EF attribute value
  Event Frame Details	Retrieving an Event Frame's severity, acknowledgement, and annotations on any level of a batch report
  Simple	Passing string values and resolving aliases
  Trend	Populating a trend over a time range for a data source(s)
  Compressed Values	Retrieving recorded values over a time range for a data source(s)
  Exact Time Value	Retrieving the value at a timestamp for a data source(s)
  Summary Value	Retrieving summary values (minimum, maximum, mean, average, total) for a data source(s)
  Profile	Retrieving Start, End, Minimum, or Maximum values over a time range for a data source(s)
  PI Batch Property	Retrieving PI Batch property values populated by the EVT Interface
  Interpolated Values	Retrieving evenly spaced values over a time range for a data source(s)
  Calculation Time Value	Executing a PI performance equation at a timestamp
  Calculation Recorded Value	Executing a PI performance equation at a certain time
  Summaries Value	Retrieving multiple summary calculations
  Expression Summaries	Retrieving multiple expression summary calculations
  EVT Interface Event Tag	Retrieving data from string pool tags populated by the EVT Interface
  RtBaseline Services Dataset	Retrieving data from an RtBaseline dataset PI Calculation Datasets are not supported through the RtBaseline Services Datasets journal action result type RtBaseline services Analysis Framework Datasets are no longer supported
  Batch Interface Framework	Retrieving complex PI Batch data from Batch Framework interfaces, including DeltaV and FactoryTalk
  Parsing String Tag	Retrieving recorded values over a time range for a data source, including complex string parsing definitions

• Description

  Defines the description for the result definition.

Time Parameters

When result definition types use time parameters, the available fields vary depending on the time parameters needed for the result definition type.

• Context

  Defines the time context to use for the result definition.

• Context Start

  The start time uses the start time of the parent context element of the journal action.

• State Start

  The start time uses the start time of the current state.

• Context End

  The end time uses the end time of the parent context element of the journal action.

• State End

  The end time uses the end time of the current state.

• Offset

  Time offset from start or end time. Uses PI time expression syntax.

Data Parameters

Data parameter options vary depending upon the parameters needed for the selected data set.

If a placeholder has a default value, you can hover over the field to view the value as a tool tip. The default value is only available for reference the first time the data set is selected.

Refer to the documentation for each result definition type for a list of type-specific options.