General Reference

About State Management in Approved Action Management

Action Management employs standard State Configuration functionality to facilitate basic Action Management operations and record state transitions.

In Action Management the menu displays a list of operations that are available for one or more currently selected records. The list of available operations will vary, depending upon the current state of the selected record and the states to which the record can transition from its current state, according to the State Configuration that exists for the entity family.

About Action States and Operations

The menu will display any operation that is valid for current state of the selected record, including any baseline operations and any custom operations.

Note: Throughout this documentation, we provide details on performing baseline operations for Recommendation families using their baseline State Configurations. If you have customized the State Configurations for the Recommendation families, additional options may be available to you.

The following diagram shows the states and operations that exist in the baseline State Configuration for the following families:

  • AMS Asset Recommendation
  • Calibration
  • Inspection
  • General Recommendation
  • Operator Rounds Recommendation
  • Policy Recommendation
  • RCA Recommendation
  • Reliability Recommendation

You can use this diagram to determine which operations will appear on the recommendation menu when you select a record in the grid on the Action Management page. The menu will display any operation to which the current record can be transitioned from its current state.

Note: A blue arrow represents an operation that creates a link between records. A red arrow represents an operation that unlinks records.

About Asset Queries in Action Management

To identify the Equipment or Functional Location record that will be used to complete an operation, the Predix Essentials system runs the following queries, which are stored in the Catalog at \\Public\Meridium\Modules\Core\Queries:
  • Equipment Asset Query: After providing a prompt for an Entity Key, the Equipment Asset Query returns the record with the provided Entity Key. In the baseline Predix Essentials database, the query returns records in the Equipment family.
  • Location Asset Query: After providing a prompt for an Entity Key, the Location Asset Query returns the record with the provided Entity Key. In the baseline Predix Essentials database, the query returns records in the Functional Location family.

You will need to modify the baseline queries only if your Recommendation records are linked to records in a family other than the Equipment family or the Functional Location family. When you modify the queries, remember that they must contain the Entity Key field from the source family whose records you want to return. A prompt must exist on the Entity Key field, but the prompt can be a simple prompt with no valid values.

When These Queries are Run

The Equipment Asset Query and Location Asset Query are not meant to be run on their own. Instead, the Predix Essentials system runs these queries when you promote a Recommendation record to an Action record.

When these queries are run, the Predix Essentials system supplies the prompt with the Entity Keys of the predecessor records that are linked to the selected Recommendation record using the following workflow:

  • The Predix Essentials system first runs the Equipment Asset Query. If any of the predecessor Entity Keys identify a record that belongs to the source family of the Equipment Asset Query, the Asset Strategy record will be linked to the record that is returned by the query.
  • If none of the predecessor Entity Keys identify a record that belongs to the source family of the Equipment Asset Query, the Predix Essentials system runs the Location Asset Query. If any of the Entity Keys identify a record that belongs to the source family of this query , the Asset Strategy record will be linked to the record that is returned by this query.
  • If none of the predecessor Entity Keys identify a record that belongs to the source family of the Location Asset Query, the Recommendation record will be promoted to an Action record, but the Asset Strategy will not be linked to an Equipment or Functional Location record.

The Equipment Asset Query always runs first. If it returns a record, that record is assumed to be the correct predecessor record, and the Location Asset Query is not run. This means that if a Recommendation record is linked to an Equipment record and a Functional Location record, the Equipment record will always be assumed to be the correct predecessor record.

Both the queries should query the family at the highest level necessary to include all equipment or location subfamilies. This means that if all your customer defined equipment and location families are structured in a hierarchy under a single parent family, such as Asset, you should modify only the Equipment Asset Query to include this parent family. In this case, the Location Asset Query will never be run because all customer-defined equipment and location records will be returned by the Equipment Asset Query.

Example: Asset Query

Suppose a Recommendation record is linked to the Equipment record HX-112 and the RBI Criticality Analysis record Analysis 101. If you promote the Recommendation record to an Action record, the Predix Essentials system will:

  • Identify the Entity Key of the Equipment record HX-112 and the RBI Criticality Analysis record Analysis 101.
  • Supply these Entity Keys to the prompt in the Equipment Asset Query.
  • Identify the record that is returned by the query. Because the source family is the Equipment family, the Equipment record HX-112 will be returned by the query.
  • Link the new Asset Strategy record to the Equipment record HX-112.

Recommended Actions Data Model

The following diagram illustrates the families that are provided to support Recommended Actions. The shaded boxes represent entity families, and the arrows represent relationship families. You can determine the direction of each relationship definition from the direction of the arrowhead: the box from which the arrow originates is the predecessor in that relationship definition, and the box to which the arrowhead points is the successor in that relationship definition.

Note: In this image, only the General Recommendation family is shown. Other Recommendation families (such as Inspection Recommendation) also participate in relationship definitions for these relationships, but those families are described in more detail in the documentation for the modules that use those families.

Action Management System Code Tables

The following table lists the System Code Tables that are used by Action Management.

Table ID

Table Description

Function

ENTY KEY COREA unique value for any record in the database.

MI BUSINESS IMPACT

CORE, Impact to company's production carrying out equipment work

Used to populate the Business Impact list in Recommendation records.

MI PRIORITY

CORE, baseline priority types

Used to populate the Recommendation Priority list in recommendation records.

MI RECOMMENDATION TYPE

CORE, Recommendation Type

Used to populate the Recommendation Type list in Recommendation records.

Note: The Recommendation Type field is not included on any baseline Recommendation datasheets.

MI STATUS

Status Codes - CORE

Used to populate the Status list in Recommendation records.

M002

Equipment Operational Status

Used to populate the Required Equipment Status list in Recommendation records.

Action Management State Configuration

Action Management employs standard State Configuration functionality to facilitate basic Action Management operations and record state transitions.

In Action Management, the button opens a menu that displays a list of operations that are available for one or more currently selected records. The list of available operations will vary, depending upon the current state of the selected record and the states to which the record can transition from its current state, according to the State Configuration that exists for the entity family.

About Action States and Operations

The menu will display any operation that is valid for current state of the selected record, including any baseline operations and any custom operations.

Note: Throughout this documentation, we provide details on performing baseline operations for Recommendation families using their baseline State Configurations. If you have customized the State Configurations for the Recommendation families, additional options may be available to you.

The following diagram shows the states and operations that exist in the baseline State Configuration for the following families: 

  • AMS Asset Recommendation
  • Calibration
  • Inspection
  • General Recommendation
  • Operator Rounds Recommendation
  • Policy Recommendation
  • RCA Recommendation
  • Reliability Recommendation

You can use this diagram to determine which operations will appear on the Recommended Action menu when you select a record in the grid on the Action Management page. The Recommendation menu will display any operation to which the current record can be transitioned from its current state.

Note: A blue arrow represents an operation that creates a link between records. A red arrow represents an operation that unlinks records.