System architecture and interfaces
Scope & context
System design pattern
| Pattern | Description |
|---|---|
Integration Events |
Communication between Self-Contained Systems takes place through integration events over AMQPS 0.9.1[] (Only references to the business data in the event. |
API Gateway |
All HTTPS and STOMP over Websocket Secure communication is routed via the PQM API Gateway to the "Business Services" |
Backend to Client Communication |
Backends publish data via STOMP over Websocket Secure to the Angular/AngularJS client, running in the browser. |
PQM Internal Service to Service Communication |
All communication between the PQM Business Services is asynchronously via Data Events (Business data in the event. |
Single Page Application |
The Angular/AngularJS client and all other static files are made available to the browser via the "static content delivery" service |
External building blocks
| Building Block | Description |
|---|---|
Portal |
Web Portal is the UI integration layer of IAS in order for other modules to integrate their views (pages) in the UI. PQM registers itself to be displayed in the portal. |
Information Router |
Information Router is the machine data integration layer of IAS to serve all IAS modules with a machine data in a unified format. PQM receives process data from the information router. |
MDM |
MDM (Master Data Management) is the central master data management component in IAS. PQM uses device, facility and process master data from MDM. |
MACMA |
MACMA (Multi-Tenant Access Management) is the central authorization and authentication provider of IAS. PQM authenticates and authorizes user requests using MACMA. |
Deviation Processor |
Deviation Processor is the central point in IAS where deviations are sent to. The deviation processor decouples the SCS where issues in the plant are detected from the SCS reacting on this information. PQM sends deviations to the deviation processor ("detecting module") so "reacting modules" can take action. (e.g. creating a ticket in a Ticket Management). |
Browser |
The Browser acts as platform for the PQM UI to be executed in. |
InfluxDB |
InfluxDB is used for persisting machine transaction data, so it can be used for further processing (visualization, data export, statistical calculations) |
Relational Database |
Relational Database is used for persisting master data (e.g. mirrored master data from MDM, view configurations and rule configurations) |
Building block view
External interfaces
| Data Source | Protocol | Data Destination | Data | Purpose |
|---|---|---|---|---|
PQM |
HTTPS |
Portal |
Registration Information |
PQM registration in the portal |
PQM |
HTTPS |
Deviation Processor |
Deviation Notifications |
Inform reactor modules about deviations in the Process Quality domain |
MACMA |
HTTPS |
PQM |
User data |
User authentication (OAuth2) and user authorization (OIDC) |
MACMA |
HTTPS |
PQM |
Tenant IDs |
PQM mirrors MDM equipment data for resilience and performance reasons. Therefore, the tenant IDs are required. PQM loads the tenants IDs by using the MACMA ACL endpoint. |
MACMA |
AMQPS |
PQM |
Tenant IDs |
PQM mirrors MDM equipment data for resilience and performance reasons. If a new tenant is created, PQM needs to the master data of this tenant. Therefore, PQM consumes the Contract Created Event. |
MDM |
HTTPS |
PQM |
Equipment data |
PQM mirrors MDM equipment data for resilience and performance reasons. * Fetch equipment data for new tenants * Fetch equipment data after receiving an entity change event |
MDM |
AMQPS |
PQM |
Equipment data |
PQM mirrors MDM equipment data for resilience and performance reasons. PQM is informed about relevant changes via integration events. |
Information router |
HTTPS |
PQM |
Machine data (PPMP) |
Machine data for PQM features |
AI Services |
AMQP |
PQM |
Machine data deviations |
Detected deviations (e.g. Anomalies) for PQM features |
-
Services to service communication is via AMQP0.9.1[] only
-
Mandatory external systems:
-
Information router (former Connectivity HUB)
-
MACMA
-
MDM
-
Portal
-