Message Destinations and Routes

To process outbound messages, Platform uses a MessageRoute and MessageDestination to describe where the outbound messages should be delivered. MessageRoutes and MessageDestinations are represented as Platform models. The following tables outline all fields for these models:

Table 16.6. MessageDestination Fields

Field

Description

ValueChainId

Value Chain which owns the MessageDestination. (KEY field)

Name

Name of the MessageDestination (KEY field)

Enterprise

If the destination is enterprise-scoped, identifies that enterprise (optional KEY field)

DestinationType

Fully-qualified classname of the com.onenetwork.platform.integ.msg.MessageDestination to which the given origin should be routed.

For convenience, also supports built-in values:

  • P2PI for routing to another Platform instance

  • SFTP for dequeuing to a remote file system

  • EMAIL for dequeuing to email address(es)

  • File for dequeuing directly to a file system.

  • Queue for creating a copy of the message in another MessageQueue in the same Platform instance

Config

Configuration passed to the MessageDestination; expected values are specific to the DestinationType


Table 16.7. MessageRoute Fields

Field

Description

ValueChainId

Value Chain which owns the MessageRoute. (KEY field)

OriginQueueName

Origin queue (KEY field)

OriginQueueEnterpriseName

If the origin queue is enterprise-scoped, identifies that enterprise (optional KEY field)

OriginInterface

Origin interface (optional). When not supplied, any message in the OriginQueue is considered a match for the route. A MessageRoute with both queue and interface specified will take precedence over one with queue only for a matching message. (KEY field)

DestinationName

Name of the MessageDestination

DestinationEnterpriseName

If the destination is enterprise-scoped, identifies that enterprise (optional)