Action options

Action options define the criteria for the journal action that apply to the entire journal action, such as monitoring time intervals, time offsets, and sampling.

You add and edit action options in the Journal Action Edit window, in the Action Options tab. You open the Journal Action Edit window by right-clicking the journal action node and then clicking Property.

• Interval

  Defines the logic for retrieving the interval time stamps for the transition equations. The Interval value has three options.

• Interval value of -1

  The equations execute at specific times that have data stored in the PI System.

• Interval value of Integer value

  Defines the time interval, in seconds, between the executions of the transition equations from the period start time to the end time.

• Interval value of Tag Name

  The name of the PI tag that defines the time interval between the executions of the transition equations.

  This tag does not have to be included in the transition equations defined for individual states.

• Interval value of AF Element Attribute and Event Frame Attributes

  AF attributes are supported.

• Monitoring Expression

  The PI performance equation expression that determines which time intervals to suppress.

  This expression is evaluated at intervals defined in the Interval field. AF attributes are supported.

• Start Percent of Time

  Interprets the value entered in the Suppress From Start field as a percent.

• Suppress From Start

  Integer value indicating the amount of time to suppress the action logic from the start of the period.

  This value is in seconds, unless you select Start Percent of Time.

• End Percent of Time

  Interprets the value entered in the Suppress From End field as a percent.

• Suppress From End

  Integer value for the amount of time to suppress the action logic from the end of the period.

  This value is in seconds, unless you select End Percent of Time.

• Start Time Offset

  The amount of time applied to the start time to determine the actual start time.

  The offset is signed (+ or -) and entered in seconds.

• End Time Offset

  The amount of time applied to the end time to determine the actual end time.

  The offset is signed (+ or -) and entered in seconds.

• Sample at Start

  Sample at the start of the time period.

• Sample at End

  Sample at the end of the time period.

• Output Type

  Defines how the report runs and logs error messages.

• Optional

  The report logs a message to the RtReports Server and continues executing if there is any error with this journal action.

• Required

  The report logs a message to the RtReports Server and stops executing if there is any error with this journal action.