iot connector

Description - Send a ZeroMQ message

Runtime Class - com.ibi.agents.XDZeroMQEmitAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Message Format:stringDetermines how the input document is interpreted to create the message. Single Part serializes the document into a single part message. Multipart creates a multipart message from an XML document adhering to the iwzeromq.xsd schema or from a JSON array. Dynamic creates a multipart message if the document is in the expected format, otherwise it create a single part message.

Select from one of the following options:
  • Single Part {single}
  • Multipart {multipart}
  • Dynamic {dynamic}
Read Reply:booleanOn bidirectional sockets, read a reply message after sending the message. This is more appropriate for the REQ socket.
* - denotes required
 ParameterTypeDescription
Format:stringDetermines how the response message is stored in the document if the Return Document is the response. The last part can be stored flat as bytes, or parsed as XML or JSON. Alternatively, all parts can be stored in an XML or JSON container.

Select from one of the following options:
  • All parts in XML container {xmlmultipart}
  • All parts in JSON container {jsonmultipart}
  • Last part as flat {flat}
  • Last part as parsed XML {xml}
  • Last part as parsed JSON {json}
* - denotes required
 ParameterTypeDescription
Return Document:stringWhether the output document will be the response, a status document or the input document.

Select from one of the following options:
  • Response {response} - response will be the out document.
  • Status {status} - status document will be the out document.
  • Input {input} - input document will be the out document
* - denotes required

Output Events

NameDescription
onFailParseCould not parse a document.
onFailTimeoutThe operation timed out.
onFailOperationCould not perform the operation requested.
Description - Publish a message to a MQTT server

Runtime Class - com.ibi.agents.XDMqttEmitAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Return Document:stringType of output from this service.

Select from one of the following options:
  • Status document {status} - Returns a status document.
  • Input document {input} - Returns the document passed into the object.
* - denotes required

Output Events

NameDescription
onFailParseCould not parse a document.
onFailOperationCould not perform the operation requested.
onFailTimeOutThe operation timed out.
Description - Send a Constrained Application Protocol message

Runtime Class - com.ibi.agents.XDCoapEmitAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Method:stringThe method of the request. Both POST and PUT send the current document as payload.

Select from one of the following options:
  • GET
  • POST
  • PUT
  • DELETE
Content Type:stringThe content type of the request to be sent. Select a format name or enter a numeric value between 0 and 65535 inclusive. Ignored for GET or DELETE.

Select from one of the following options:
  • text/plain
  • text/csv
  • text/html
  • application/link-format
  • application/xml
  • application/octet-stream
  • application/rdf+xml
  • application/soap+xml
  • application/atom+xml
  • application/xmpp+xml
  • application/exi
  • application/fastinfoset
  • application/soap+fastinfoset
  • application/json
  • application/x-obix-binary
  • image/gif
  • image/jpeg
  • application/vnd.oma.lwm2m+tlv
  • image/png
  • application/vnd.oma.lwm2m+json
  • image/tiff
  • application/cbor
Confirmable:booleanWhether this request needs to be confirmed with an acknowledgment. Ignored for reliable protocols.
* - denotes required
 ParameterTypeDescription
Content Type:stringRestrict the type of message being sent in via a POST or PUT. Leave blank, select a format name or enter a numeric value between 0 and 65535 inclusive.

Select from one of the following options:
  • text/plain
  • text/csv
  • text/html
  • application/link-format
  • application/xml
  • application/octet-stream
  • application/rdf+xml
  • application/soap+xml
  • application/atom+xml
  • application/xmpp+xml
  • application/exi
  • application/fastinfoset
  • application/soap+fastinfoset
  • application/json
  • application/x-obix-binary
  • image/gif
  • image/jpeg
  • application/vnd.oma.lwm2m+tlv
  • image/png
  • application/vnd.oma.lwm2m+json
  • image/tiff
  • application/cbor
* - denotes required
 ParameterTypeDescription
Namespace:stringThe special register namespace from which HTTP headers for the outgoing request will be taken.

Select from one of the following options:
  • Default Namespace {default}
  • None {none}
* - denotes required
 ParameterTypeDescription
Namespace:stringThe special register namespace into which HTTP headers from the incoming response will be saved.

Select from one of the following options:
  • Default Namespace {default}
* - denotes required
 ParameterTypeDescription
Return Document:stringWhether the output document will be the response, a status document or the input document.

Select from one of the following options:
  • Response {response} - response will be the out document.
  • Status {status} - status document will be the out document.
  • Input {input} - input document will be the out document
* - denotes required

Output Events

NameDescription
onFailParseCould not parse a document.
onFailOperationCould not perform the operation requested.
onFailTimeoutThe operation timed out.
onFailClientClient error status code between 400 and 499.
onFailServerServer error status code between 500 and 599.