Journal actions
- Last UpdatedAug 15, 2023
- 2 minute read
- PI System
- RtReports 5.0
- Visualization
Journal actions are sets of criteria used to select time series data for a report.
Journal actions are used to define additional data objects based on time ranges from data elements, such as PI Batches, AF Event Frames, or time templates, already defined in the report template.
Journal actions must always be contained within a context element.
Journal actions use the PI time expression syntax for time based parameters and PI performance equation syntax for result definitions. For more information about PI time and PI performance equation syntax, refer to your PI Server documentation.
When defining journal actions, you:
-
Define the action states,
-
Define the result definitions associated with either action states or the entire journal actions,
-
Edit the time and data parameters of result definitions, and
-
Optionally move, edit, or delete result definitions.
You define the criteria for journal actions in the Journal Action Edit window. Insert journal actions by clicking Insert > Journal Action. You can edit the parameters in this window by right-clicking the journal action node and then clicking Property.
Note: When you run an existing batch report against an Event Frame context, any module alias or module property references in your journal actions will be redirected to the synchronized AF Element Attribute (using the MDB-to-AF synchronization settings on the PI server).
-
Action Parameters
Are variables or placeholders that launch search controls for finding data within their native data stores, like PI tags, PI properties, AF elements attributes and event frame attributes. Attribute traits are supported.
-
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.
-
Action States
Define a series of start and end times used to retrieve a result definition.
-
Action Results
Define the start and end times used to retrieve a result definition from the start and end times of the parent context.
Predefined journal actions can be inserted in context elements from the Data Toolbox tab. For more information on inserting predefined journal actions, see Data Toolbox.