Skip to Content
Getting startedFirst message

First message

Let’s configure a complete flow and send the first message. The example uses a MES application receiving pallet data.

Create the Application

Under Applications (/applications), create an application with the code MES. The code shows up in URLs and reports, so keep it short and stable.

Create the Interface

Under Interfaces (/interfaces), create the MES_PALLET interface for the MES application. Choose the processing order:

  • Sequential when message order matters (stock movements, for instance).
  • Parallel when throughput matters more than order.

Create the Delivery Definition

Under Definitions (/definitions), create AnyToMES_PalletData pointing at the MES_PALLET interface. Configure:

  • Delivery type: HTTP_POST
  • Destination: the MES system URL
  • Timeout and retries according to the destination’s SLA
  • Transformer: optional on this first pass

Generate an API Token

Under API Tokens (/api-tokens), generate a token for the MES application. It goes in the x-api-token header of every request.

The token is shown only when created. Every later copy is recorded in the token’s copy history.

Send the message

curl -X POST http://localhost:3000/api/MES_PALLET/AnyToMES_PalletData \ -H "Content-Type: application/json" \ -H "x-api-token: YOUR_TOKEN_HERE" \ -d '{"pallet":"PAL001","weight":120.5,"line":"LINE-A"}'

Success response:

{ "id_message": "message-uuid", "message_type": "ASYNC", "return_message": "Message received and queued", "hasError": false }

Follow it through

Open Messages (/messages) and search for the returned id_message. The detail screen (/messages/:id) shows the full payload and the delivery attempt history — including the destination’s response on each attempt.

What about SOAP?

Every Definition with “Expose Web Service” enabled gets a SOAP endpoint automatically:

GET /api/ws/MES_PALLET/AnyToMES_PalletData?wsdl ← dynamically generated WSDL POST /api/ws/MES_PALLET/AnyToMES_PalletData ← SOAP envelope

Authentication can use WS-Security UsernameToken inside the envelope instead of the x-api-token header.

Next steps

  • Apply a Transformer to adapt the payload to the destination format.
  • Register Business Errors to classify failure responses.
  • Configure Alerts to be notified when something stops.