Docs Integration 1
About this guide
On this page
1.1 Who it is for
For IT, who installs OpenCore MES; for developers who connect OpenCore MES to other systems (ERP, a LIMS, a label printer, a data platform), for the designers who write service scripts, and for IT, who issues tokens, sets secrets and runs the nodes. It describes what OpenCore MES offers today, with the limits the code holds, and marks what is planned.


The ground rule: integration is designed, not deployed. A web service, a trigger, a schedule and the outside systems they reach are design elements, drafted in a change request, reviewed, approved by the stewards of everything they reach, and live the moment the change executes: no build, no deploy, no restart. Nothing reaches the plant around that lifecycle, and every record a service reads or writes goes through the same policies, rule pipe and audit trail as a person at a form.
1.2 What is built, and what is planned
| Way in or out | What | Status |
|---|---|---|
| Web services | Outside systems call POST /svc/v1/<service> with a bearer token; GET /svc/v1/openapi.json describes what the token's user may call | built |
| Transactions and queries over the web | A transaction (POST /svc/v1/<name>, its preview) and a named query (GET /svc/v1/<name>) published over HTTP under their own names, as the token's person | built |
| Calls counted | Every call of a service, transaction and named query, by how it came (a page, the web, a route), with who called, why refused and the statements it sent: the Database area | built |
| Connections | Outside systems services call, with only the requests their design allows, credentials kept as server secrets | built |
| Record triggers | A record event (create, update, archive, restore, or a transition) sets a service off after its commit, retried while the other system is down | built |
| Schedules | The clock sets a service off: every N minutes or hours, at times of day, in a window, on days, or at the times a kind of schedule an installed suite adds works out; catch-up and overlap rules | built |
| The integration monitor | Nodes, schedules, inbound and outbound calls, triggers; pause, resume, run now | built |
| The AI design API | /ai/v1, and the same tools over MCP at /ai/v1/mcp: an AI drafts and tests designs as a person, never approves or executes | built |
| Excel import and export | Records in and out as spreadsheets, through the forms' checks | built |
| Authentication | Single sign-on (OpenID Connect), the plant's directory (LDAP, Active Directory), or a password of OpenCore MES's own; lockout; only people in People & departments (2.3) | built |
| Versioned HTTP APIs | /svc/v1 and /ai/v1 written down as a contract (docs/contracts/http-apis): API-Version on every answer, notice before a change (Deprecation, Sunset), the API kit; a plant's web services held to notice before they break their callers (7.3) | built |
| The equipment adapter contract | What an adapter for one machine protocol implements (docs/contracts/equipment-adapter): its specification, schema and conformance kit | built |
| The embedding contract | A site the plant names (EMBED_ORIGINS) shows OpenCore MES in a frame and talks to it by window messages: where the person is, and outlines by visible name (docs/contracts/embedding): specification, schema, kit | built |
| The language-pack contract | The platform's words in one language, installed as a suite is (docs/contracts/language-pack): its specification, schema and kit, which checks a pack and how much of the core's words it says | built |
| The extension API | A narrow, versioned surface for suites, with its conformance kit | planned |
| Equipment data collection | High-rate machine data handled outside the MES, which receives only derived events | planned |


1.3 Conventions
Codeis typed as it stands. JSON designs are shown as the designer's JSON tab stores them.- The examples use the seed's work order and lot, and a made-up ERP at
https://erp.plant.local/api. The same designs are proved end to end byapp/mes/test/integration.mjs, against a fake ERP. - Procedures (DV-…) have a Done box per step, for a printed copy.