Skip to main content
Technical Preview

Overview

Client-mode REST API connector for AVEVA MES (formerly Wonderware MES): read the job queue, work orders, OEE and utilization, and post production counts, consumption, downtime events and job state changes from MQTT through the MES Web API V3. This is one of the templates in the AVEVA MES (formerly Wonderware MES) REST API app (aveva-mes). Deploy it alongside the other connectors of that app when they depend on each other (for example a token connector plus an API connector).
Not yet verified against the live vendor API: No AVEVA MES server or AIM client on the factory box (no AVEVA_MES_* variables) and AVEVA offers no public MES sandbox; the ready gate needs an authenticated live GET + POST (or broker MQTT round-trip). Mock-server checks do not clear the gate.

Auth

MES security mode OS User or OS Group + AVEVA Identity Manager. Register a service client with RegisterAIMServiceClient.ps1 (InstallFiles/CD-MES/AIMRegistration), POST https://<AIM host>/identitymanager/connect/token grant_type=client_credentials (form) -> access_token (24 h default), then Authorization: Bearer <token> from the MQTT payload field authorization. Service-to-service calls run as the MES Default Background User (system attribute 199). Auth headers used by the template: Authorization: {value.json.authorization}.

Template parameters

BASE_ADDRESS default: https://YOUR_MES_SERVER.

Events

Deploy

Get the template card (JSON with template and metadata) from the broker, then deploy the connector:
The deployable connector from the REST API app, with BASE_ADDRESS already filled in:
Deploy it with -addRoute (do not include ADD METADATA).

Usage example

Call GetOpenApiSpec by publishing a JSON payload to its request topic, and read the reply on the response topic:
Last modified on October 21, 2026