AMQP Endpoint Configuration

Connection Properties

Required CONNECTION PROPERTIES for AMQP 0.9.1

  • "host"

  • "port"

  • "virtual.host"

  • "username"

  • "password"

For more information, please see the following page.


Required CONNECTION PROPERTIES for AMQP 1.0.0

  • "uri" or "host" and "port"

  • "jms.username"

  • "jms.password"

For more information, please see the following page (only for properties which are prefixed with "jms.", the rest must be specified in the uri as query parameters in order to be processed).


Destination Properties

Required DESTINATION PROPERTIES for AMQP 0.9.1

  • "exchange"

  • "routingKey"

Optional DESTINATION PROPERTIES for AMQP 0.9.1

  • "customHeader"

For more information, please see the following page.


Required DESTINATION PROPERTIES for AMQP 1.0.0

  • "queueName" or "topicName"


Optional DESTINATION PROPERTIES for AMQP 1.0.0

  • "customHeader"

  • "transientMessages"

  • "manualAck"



AMQP Event Forwarding Properties

EVENT GROUPS

  • "generic" - for Generic events.

  • "gdm-cu" - for Control Unit events.

  • "gdm-sv" - for State Variable events.

  • "gdm-h" - for Hierarchy events.

  • "osgidm-fi" - for Functional Item events.

EVENT FORMAT

  • "json-default".


EVENT PROPERTIES

Event-group specific

  • "generic":

    • listenerProps:Dictionary;

Information covering listenerProps' supported values can be found in the in the documentation and in the System Package javadoc.

  • "gdm-cu":

    • nodePath:String;

    • cuListenerProps:Dictonary;

Information covering cuListenerProps' supported values can be found in the documentation, in Generic Device Management's javadoc and in the System Package's javadoc (same as listenerProps).

  • "gdm-sv":

    • nodePath:String;

    • svListenerProps:Dictionary;

Information covering svListenerProps' supported values can be found in the documentation, in Generic Device Management's javadoc and in the System Package's javadoc (same as listenerProps).

  • "gdm-h":

    • nodePath:String;

    • regProps:Dictionary;

Information covering regProps' supported values can be found in the documentation, in the javadoc and in the System Package's javadoc (same as listenerProps).

  • "osgidm-fi":

    • gatewayID:String;

    • nodePath:String;

    • topics:String [];

    • filter:String;

Information covering the topics and filters' supported values can be found in both Edge Services's and Remote Manager's documentation and in the corresponding FIM and GDM javadoc.

Event-format specific

  • "json-default".

    • "ignoreFields":string[] - when set, the fields from the array will be removed from the event body before sending.

    • "prettyPrint":string ("true" or "false") - when set, the payload will be formatted in a more readable and user-friendly manner.

Useful Information:

Connection properties, destination properties and event properties support arrays and maps by using the default syntax for string representation of these structures, e.g. [element1,element2, ... elementN] and {key1=value1,key2=value2, ..., keyN=valueN}