correlationID is object that specifies a unique identifier at design time that can be used for message tracing and correlation.

example : 

In this example we associate the object MyCorrelationID to the message PersonMessage.

The correlationID will be searched in the headers of the message in the tracId field which in this case must be declared in the MyHeader facade

message PersonMessage{
    payload: Person
    headers: MyHeader
    correlationId: MyCorrelationId

correlationId MyCorrelationId {     description"My Correlation Id"     location"header.tracId" }

Standard message properties :

  • description (String)
    • description of the correlationId object
  • location (String)
    • Location of the field containing the id to use for the correlation
      • Must start with header or message followed by the path to the field in the payload or header structure