Table of Contents

Data Platform API

Welcome to the reference pages for the Critical Manufacturing Data Platform API. This documentation provides a comprehensive overview for developers looking to interact with real-time manufacturing data streams originating from Critical Manufacturing MES, utilizing the Canonical Data Model (CDM).

This API enables you to both subscribe to real-time data streams produced by Critical Manufacturing MES and publish data conforming to the CDM format to leverage the platform's capabilities.

About the Critical Manufacturing Data Platform

The Critical Manufacturing Data Platform utilizes Kafka, a distributed streaming platform, to offer real-time access to manufacturing data. This asynchronous design ensures highly scalable and resilient data pipelines, empowering you to react instantly or offline to factory floor events.

Furthermore, this platform allows external systems to send Equipment Data or MES Data in the CDM format, leveraging the Data Platform's pipeline functionalities for:

  • Ingest: Ensures authentication, consistency, and enrichment with crucial system data (e.g., timestamp).
  • Store: Persists data on disk in a format accessible for both online and offline analysis.
  • Broker: Facilitates communication between system components and external systems througt a decoupled subcription system.
  • Process: Transforms data for use by other system components or subscribed external systems.
  • Serve: Delivers data for visualization purposes.

Data Platform Architecture

Canonical Data Model (CDM)

The Canonical Data Model (CDM) serves as a standardized semantic model for structuring data originating from diverse MES systems and Equipment.

This model encompasses two primary data subsets:

  • MES Data
  • Equipment Data

The Data Platform populates the CDM through canonical events. These events enable third-party solutions to integrate with Critical Manufacturing MES or utilize its data analysis features.

MES Data

This subset stores core MES System Data, including Work-In-Progress (WIP), equipment details, production schedules, production orders, and process flows. Within CM MES, this data originates from MES transactions and events.

CM MESEvents Processing

Equipment Data

This subset includes test results, telemetry data, metrology readings, and equipment files. In CM MES, this data is typically generated by IoT events and ingested through the following endpoints (often using the CM Connect IoT framework):

  • PostTelemetry: Used for transmitting time-series and continuous data such as temperature, pressure, and operational status.
  • PostMeasurement: Used for transmitting data from tests, metrology processes, and inspections.
  • PostFile: Used for transmitting unstructured data such as images and other file types.

Interacting with CDM Kafka Topics

By engaging with the Kafka topics exposed by the Data Platform, you can:

  • Subscribe to real-time manufacturing events: Receive immediate notifications about changes in equipment status, process parameters, quality events, and more.
  • Build reactive applications: Develop applications that respond in real-time to manufacturing events, enabling immediate actions and insights.
  • Integrate with real-time analytics platforms: Feed live data streams into your analytics tools for continuous monitoring and analysis.
  • Publish data to leverage platform capabilities: Integrate external systems with CM MES (for temporary migration scenarios or long-term solutions) to utilize its data processing and analytics functionalities.

Documentation

  • CDM Reference Documentation: Access here for detailed information in HTML format.
  • CDM AsyncAPI Specification: Download here the CDM documentation according to the AsyncAPI specification.

Important Note: The server addresses provided in the subsequent documentation are for illustrative purposes only.