About Operational Events

Smart equipment and assets can generate events related to production updates, such as details on quantities produced, quality inspection results, operational parameters, and alerts related to machine errors or asset failures.

Smart Operations currently support the following standard event types:

  • Operation Execution Start: Indicates the start of a work order operation at a workstation. This event type has the following data attributes:
    • WORK_ORDER_NUMBER: Required string.
    • OPERATION_SEQUENCE: Required number.
  • Operation Execution Stop: Indicates the stopping of work order operation execution at a workstation. This event type has no data attributes.
  • Quantity Report: Reports production quantities, such as completed and rejected quantities, for a work order operation at a workstation. Also reports inspection results that includes values for the inspection characteristics. This event type has the following data attributes:
    • SERIAL_NUMBER: Optional string.
    • QUANTITY_REPORT_TYPE: Required string. Allowed values are COMPLETE, REJECT, and INSPECT.
    • QUANTITY: Required number.
    • INSPECTION_CHARACTERISTICS: BLOB value that supports multiple "key: value" pairs. Required only if the QUANTITY_REPORT_TYPE is INSPECT.

      The keys should use the inspection characteristic names. For example:

      {
          "entityCode": "RT39578219-2712",
          "eventTypeCode": "CA_QUANTITY_REPORT",
          "eventTime": "2024-06-04T13:21:14Z",
          "data": {
              "QUANTITY": 1,
              "SERIAL_NUMBER": "SR001",
              "QUANTITY_REPORT_TYPE": "INSPECT",
              "INSPECTION_CHARACTERISTICS": {
                  "temperature": 23,
                  "pressure": 3500,
                  "label": "SR001TP"
              }
          }
      }

      The locale for the characteristic name should also be included in the header. The default is English (en).

      Optional attributes should be included only if they contain data.

  • Asset Fault: Indicates a fault generated by a connected equipment or asset. Faults are associated with fault codes and can be of types diagnostic and failure. This event type has the following data attributes:
    • FAULT_CODE: Optional string.
    • FAULT_TYPE: Optional string. Allowed values are: FAILURE and DIAGNOSTIC.
  • Asset Status: Indicates the status of the connected equipment or asset, such as idle, in-use, or down. This event type has the following data attribute:
    • STATUS: Required string. Allowed values are: IN_USE, IDLE, and DOWN.
  • Operational Parameters: Includes connected equipment attributes to be collected in the context of the operation being performed. These can also be used to detect anomalous behavior. Operational parameters are measurable variables, conditions, or metrics that control and influence the production process’s performance, quality, and efficiency. Operational parameters can include process parameters, such as temperature, pressure, or speed, and environmental parameters, such as humidity and sterility, that directly impact product attributes.
    • Parameter Codes: Optional strings. Should be one of the defined operational parameters and at least one should be present.
    Note: See Create and Use Process Operational Parameters in Work Definitions in the Using Manufacturing guide for more information on creating operational parameters.
  • Meter Readings: Includes the usage or operational status of connected equipment or an asset, such as the odometer reading for a vehicle or the hours of operation for a machine. You can use the meter readings to track asset utilization and trigger alerts or maintenance work orders when certain threshold conditions are met for proactive, meter-based preventive maintenance.
    • METER_READINGS: BLOB value that supports multiple "key: value" pairs. The keys should use the meter code.
    Note: See How You Create Meters for an Asset in the Using Maintenance guide for more information on creating asset meters.

All event types additionally contain the following metadata about the event and the connected equipment or asset that generates the event:

  • entityCode: Required string. The code for the connected entity, such as the asset number.
  • eventTypeCode: Required string. The code for the event type, as described in the Fusion application. Possible values are CA_OPERATION_EXECUTION_START, CA_OPERATION_EXECUTION_STOP, CA_QUANTITY_REPORT, CA_FAULT, CA_STATUS, CA_OPERATIONAL_PARAMETERS, and CA_METERS corresponding to the standard event types.
  • eventTime: Required string (date-time). Time when the event occurred in ISO 8601 format.
Note: See Create Operational Events in the REST API for Oracle Supply Chain Management Cloud guide for sample payload examples.

Your IIoT environment or external system should have been configured to map the relevant equipment or asset attributes to the event payload attributes specification. This includes the following:

  • Direct mapping for attributes that are fetched directly from the connected asset or machine:
    • FAULT_CODE (String)
    • WORK_ORDER_NUMBER (String)
    • OPERATION_SEQUENCE (Number)
    • SERIAL_NUMBER (String)
    • QUANTITY (Number)
    • INSPECTION_CHARACTERISTICS(Multiple data types): The various inspection characteristics and their respective data types.
    • Parameter Codes (Number/String): The various operational parameter codes.
    • METER_READINGS (Number): The various meter codes.
  • Derived mapping for attributes that are transformed into Oracle-specified event attributes, including the supported List of Values (LoV).

    The STATUS LoV supports the following: IN_USE, IDLE, and DOWN. The QUANTITY_REPORT_TYPE LoV supports COMPLETE, REJECT, and INSPECT.

  • Additional optional mappings if required.

    For example, you may need to map fault types to fault codes. Say, fault type FAILURE maps to fault codes E01 and E03, and fault type DIAGNOSTIC maps to fault codes E02 and E04.