Summaries Value result definition

The Summaries Value result definition computes multiple summary calculations over a time period specified in an interval PI SDK Summaries method. It is similar to the Summary Value 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.

Data Parameters

Selecting Yes for data parameters will return that value to the data journal.

• Data Source

  The PI tag, alias, AF element attribute, or Event Frame attribute from which to gather values.

• Interval

  A string, in PI time format, representing the sampling interval.

  If you leave this field blank, the default interval value of 10 minutes is used.

• Display Digits

  Not implemented. Specify the numeric formatting using the data object and the Numeric Format property.

• Conversion Factor

  The conversion factor used to adjust the expression value the if the engineering units for a PI tag do not match the default time units for the PI System.

• Synchronize Time

  The time for which to evaluate the Interval in the form of HH:MM, where HH is the hour in 24 hour military time and MM is minutes.

  For example, an Interval set to 10m and Synchronize Time set to 14:00 gets the Minimum, Maximum, and Average for a PI tag in 10-minute increments starting from 2:00 pm. If Synchronize Time is not set, the interval starts from the report end time or from the current time if the report end time is in the future.

• Minimum

  Minimum value for the time range.

• Maximum

  Maximum value for the time range.

• Total

  Total value over time range.

• Average

  Average value over the time range.

• Range

  Range of values over the time range.

• Percentage Good

  Returns the percentage of good data over the time range.

• Snap Shot

  Selecting Yes returns values for the last time period closest to the end time used.

• Running Summary

  If Synchronize Time is set, selecting Yes calculates the summary value for the last incomplete time period in a running batch and returns the value to the data journal. Running Summary has no effect if Synchronize Time is not set.

• Event Weighted

  Selecting Yes produces an event-weighted result.

  Selecting No produces a time-weighted result.