Action parameters

Action parameters are variables or placeholders that search for data within objects, such as PI tags or PI properties, when the report is generated.

You add and edit action parameters in the Journal Action Edit window, in the Action Parameters pane. You open the Journal Action Edit window by right-clicking the journal action node and then clicking Property.

Action parameters have four values that must be set.

• Name

  The name of the action parameter. Double-click to edit the name.

• Type

  The type of action parameter. Double-click to view and select the action parameter type.

• Value

  Either the placeholder variable for the action parameter or the value itself for the action parameter, to be used when the action parameter is run during report generation.

• Dynamic

  Dynamic values of Yes use the Value field for a placeholder when the action parameter runs during report generation.

  Dynamic values of No use the value in the Value field as the action parameter value.

Action parameter types

The action parameter type determines which options are available for configuration.

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).

• Literal

  A static number or string value.

  After selecting Literal, enter a static number or string in the Value field.

  Literal action parameters always have a Dynamic value of Yes.

• PITag

  A PI tag name.

  Selecting a PI tag, then clicking OK enters the PI tag in the Value field.

  PITag action parameters can have a Dynamic value of Yes or No.

  For more information about the PI tag search window functions, refer to the PI SDK documentation.

• PIProperty

  A property value of a module in the PI Module Database.

  The property value can be an absolute PI property that maps to a dedicated path within the PI Module Database, or a unit-relative PI property that changes the path relative to the current context of the template section.

  The PIProperty type always has the Dynamic value of No.

• PIAlias

  The PIAlias value can be an absolute alias that maps to a dedicated path within the PI Module Database or a unit relative alias that changes path relative to the current unit template context.

  PIAlias action parameters can have a Dynamic value of Yes or No.

  Refer to the PI SDK documentation for more information on using PI aliases.

• AFAttribute

  An AF attribute of an element in an AF database. The Attribute Search dialog can be used to select attribute to create an action parameter for the selected attribute.

  Each AFAttribute action parameter must have its path value set to an absolute or relative path.

  • Absolute path values use a fully qualified path to the AF attribute, in the format \Element\SubElement\...\SubElement|Attribute.

    For example: \RtReportsFactory\My Pulp Co.\San Leandro\Pulp Area\Line 1\Digester1|Pressure.

  • Relative path values use the property name as a variable to be resolved relative to the parent context of the journal action, in the format |Attribute or |Attribute|...|Attribute or.\Element\...|Attribute|...|Attribute. For example, |Pressure|Minimum.

    AF Attribute action parameters can have a Dynamic value of Yes or No.

• EFAttribute

  An attribute of an event frame in an AF database.

  Each EFAttribute action parameter is set to the relative path of EF attribute to be resolved relative to the parent context of the journal action.

  The format is |||Attribute or |||Attribute|...|Attribute.

  EF Attribute action parameters can have a Dynamic value of Yes or No.