

API Docs - v3.0.0

Tested Siddhi Core version: 5.1.2

It could also support other Siddhi Core minor versions.

Sink

ibmmq (Sink)

IBM MQ sink allows you to publish messages to an IBM MQ broker.

Syntax

@sink(type="ibmmq", destination.name="<STRING>", host="<STRING>", port="<STRING>", channel="<STRING>", queue.manager="<STRING>", username="<STRING>", password="<STRING>", batch.properties="<STRING>", @map(...)))

QUERY PARAMETERS

Name	Description	Default Value	Possible Data Types	Optional	Dynamic
destination.name	The name of the queue to which the IBM MQ sink should send events.		STRING	No	No
host	The host address of the MQ server.		STRING	No	No
port	The port of the MQ server.		STRING	No	No
channel	The channel used to connect to the MQ server.		STRING	No	No
queue.manager	The name of the queue manager.		STRING	No	No
username	The username to connect to the server. If this is not provided, the connection is attempted without both the username and the password.	null	STRING	Yes	No
password	The password to connect to the server. If this is not provided, the connection is attempted without both the username and the password.	null	STRING	Yes	No
batch.properties	IBM MQ properties which are supported by the client can be provided as key value pairs which is separated by ",". as an example batch.properties = 'XMSC_WMQ_CLIENT_RECONNECT_OPTIONS:1600,WMQ_CLIENT_RECONNECT:5005'.	null	STRING	Yes	No

Examples EXAMPLE 1

@sink(type='ibmmq',destination.name='Queue1',host='192.168.56.3',port='1414',channel='Channel1',queue.manager = 'ESBQManager',password='1920',username='mqm',batch.properties = 'XMSC_WMQ_CLIENT_RECONNECT_OPTIONS:1600,WMQ_CLIENT_RECONNECT:5005',@map(type='text'))define stream SweetProductionStream(name string, amount double);

This example shows how to connect to an IBM MQ queue and send messages.

Source

ibmmq (Source)

IBM MQ source allows you to subscribe to an IBM message queue and receive messages. It has the ability to receive messages of the 'map' and 'text' message formats.

Syntax

@source(type="ibmmq", destination.name="<STRING>", host="<STRING>", port="<STRING>", channel="<STRING>", queue.manager="<STRING>", username="<STRING>", password="<STRING>", worker.count="<INT>", batch.properties="<STRING>", client.reconnecting.timeout="<INT>", @map(...)))

QUERY PARAMETERS

Name	Description	Default Value	Possible Data Types	Optional	Dynamic
destination.name	The name of the queue name to which the IBM MQ source should subscribe.		STRING	No	No
host	The host address of the IBM MQ server.		STRING	No	No
port	The port of the IBM MQ server.		STRING	No	No
channel	The channel used to connect to the MQ server.		STRING	No	No
queue.manager	The name of the queue manager.		STRING	No	No
username	The username to connect to the server. If this is not provided, the connection is attempted without both the username and the password.	null	STRING	Yes	No
password	The password to connect to the server. If this is not provided, the connection is attempted without both the username and the password.	null	STRING	Yes	No
worker.count	Number of worker threads listening on the given queue. When the multiple workers are enabled event ordering is not preserved.	1	INT	Yes	No
batch.properties	IBM MQ properties which are supported by the client can be provided as key value pairs which is separated by ",". as an example batch.properties = 'XMSC_WMQ_CLIENT_RECONNECT_OPTIONS:1600,WMQ_CLIENT_RECONNECT:5005'	null	STRING	Yes	No
client.reconnecting.timeout	The time a client waits for reconnection. The value should be provided in seconds.	30	INT	Yes	No

Examples EXAMPLE 1

@source(type='ibmmq',destination.name='Queue1',host='192.168.56.3',port='1414',channel='Channel1',queue.manager = 'ESBQManager',password='1920',username='mqm',batch.properties = 'XMSC_WMQ_CLIENT_RECONNECT_OPTIONS:1600,WMQ_CLIENT_RECONNECT:5005',@map(type='text'))define stream SweetProductionStream(name string, amount double);

This exampe shows how to connect to an IBM message queue and receive messages.