MES Integration Layer — Features (Full Detail)

2. Features

• MES Endpoints — Connect external MES systems via REST, MQTT, OPC-UA, SOAP, Webhook, SFTP, or Local folder
• Event Catalog — Built-in production, quality, maintenance, inventory, and IoT event types
• Outbound Dispatcher — Queue and push events to configured endpoints with retry / backoff
• Inbound Webhook — Receive shop-floor events (scans, QC results, downtime, lab results)
• REST API — Authenticated API keys for reading endpoints/events and submitting events
• Outbound Webhooks — Notify third-party systems on event.queued, event.processed, event.failed
• Field Mapping — Transform payload fields per endpoint / event type
• Event Routes — Route event types to specific endpoints (optional plant routing)
• Integration Reports — Endpoint SLA, error rates, archive statistics
• SFTP / Local Transport — File-based inbound/outbound with cron polling
• Credential Encryption — Secure storage of endpoint secrets
• Event Archive — Archive processed events before retention purge
• Dashboard Widget — Integration stats and recent events
• Role-based Permissions — Granular staff capabilities
• Clean Uninstall — Removes all mes_* tables and options

3. How to Use

3.1 Configure Settings

1. Go to MES Integration Layer → Settings.
2. Enable integration, set default protocol, retention days, and dispatch options.
3. Optionally enable REST API, outbound webhooks, SFTP/local poll, QMS/LIMS routing.
4. Click Save.

3.2 Add an MES Endpoint

1. Go to MES Endpoints → New.
2. Enter endpoint code (e.g. MES-PLANT1), name, vendor, protocol, and direction.
3. Fill protocol-specific config (URL, credentials, paths, topics, etc.).
4. Mark as active and save.

3.3 Create Event Routes (optional)

1. Go to Event Routes.
2. Map an event type (e.g. Work Order Started) to an endpoint.
3. Set priority and activate the route.

3.4 Field Mappings (optional)

1. Go to Field Mappings.
2. Choose endpoint (+ optional event type).
3. Map source field → target field and optional transform.

3.5 View Integration Events

1. Open Integration Events to review queued, processed, and failed events.
2. Create a manual test event if needed.
3. Use Reprocess on failed events (permission required).

3.6 Outbound Webhooks

1. Go to Webhooks → New.
2. Enter destination URL, secret, and selected events.
3. Deliveries are logged under each webhook.

3.7 API Keys

1. Go to API Keys (Settings permission).
2. Create a key with read / write / read_write scope.
3. Copy the token immediately — it is shown once.
4. Use the token in the X-API-KEY (or configured) header against MES REST endpoints.

3.8 Reports

Open Reports for endpoint performance, failure rates, and archive stats.

4. Inbound Webhook Example

Enable inbound under Settings and use the webhook secret in the request header.

curl -X POST "https://your-domain.com/admin/mes/mes_webhook/receive" \
  -H "Content-Type: application/json" \
  -H "X-MES-Token: YOUR_WEBHOOK_SECRET" \
  -d '{
    "event_ref": "MES-EXT-1001",
    "event_code": "operation_scan",
    "payload": {
      "scan_code": "OP:123",
      "action": "start",
      "work_order_id": 10,
      "operation_id": 123
    }
  }'

Common inbound event codes: operation_scan, iot_reading_ingested, downtime_started, downtime_ended, qc_result, qc_failed, lab_result.

Exact admin/public URL path may vary with your Perfex rewrite / base URL. Check the module webhook controller route after install.

5. Permissions

Assign under Setup → Staff → Roles:

6. Cron Jobs

Dispatch retries, SFTP/local polling, webhook delivery, and retention use Perfex CRM’s main cron.

* * * * * php /path/to/perfex/index.php cron/index >/dev/null 2>&1

Ensure cron is already configured for Perfex. No separate crontab entry is required for this module.

7. Uninstall

1. Go to Setup → Modules.
2. Deactivate MES Integration Layer.
3. Click Uninstall.

Uninstall removes:

• All database tables matching {db_prefix}mes_% (endpoints, events, routes, webhooks, API keys, archives, logs, etc.)
• All options whose names start with mes_

Perfex core data (invoices, customers, manufacturing records outside MES tables) is not deleted.