Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following fields are included in the MQConnectionInfo UDR:


 

Field
Description
ChannelName (string)The name of the MQ channel.
Host (string)The host name of the queue manager host.
Port (integer)The port for the queue manager.
Properties (map <any,any>)(optional)A map of optional properties to be set, for example, user name.
QueueManager (string)The name of the queue manager.
Queues (list <string>)A list of queues to listen to.

 


MQConnectionInfoTopic

If the connection mode is set to Topics, MQConnectionInfoTopic will be used as the connection UDR.

The following fields are included in the MQConnectionInfoTopic UDR:

...


Field
Description
ChannelName (string)The name of the MQ channel.
Host (string)The host name of the queue manager host.
Port (integer)The port for the queue manager.
Properties (map <any,any>)(optional)A map of optional properties to be set, for example, user name.
QueueManager (string)The name of the queue manager.
TopicNames (list <string>)A list of topics to subscribe for.

 


MQConnectionInfoDurableTopic

...

The following fields are included in the MQConnectionInfoDurableTopic UDR:

...


Field
Description
ChannelName (string)The name of the MQ channel.
DurableSubscriptions (list <string>)A list of subscriptions to listen to.
Host (string)The host name of the queue manager host.
Port (integer)The port for the queue manager.
Properties (map <any,any>)(optional)A map of optional properties to be set, for example, user name.
QueueManager (string)The name of the queue manager.

Anchor
mq_message
mq_message

...

The following fields are included in the MQMessage UDR:

...


Field
Description
CorrelationID (bytearray)This ID can be used for correlating messages that are related in some way or another, e g requests and answers. The length of this field will always be 24, meaning that fillers will be added to IDs that are shorter, and IDs that are longer will be cut off.
Id (bytearray)The message id.
Message (bytearray)The message.
Persistent (boolean)If set to "true", the message will be sent as a persistent message, otherwise the queue default persistence will be used.
ReplyToQueue (string)The name of the queue to reply to.
ReplyToQueueManager (string)The name of the queue manager to reply to.
SourceQueueName (string)The name of the source queue.

 


MQMessageTopic

For each topic message, a UDR is created and sent into the workflow.

The following fields are included in the MQMessageTopic UDR:

...


Field
Description
DataMessage (bytearray)The message id.

 


MQQueue

The MQQueue UDR is a reference to an IBM MQ queue when using APL commands. The UDR is created by the mqConnect function and all fields are read-only.

The following fields are included in the MQQueue UDR:

...


Field
Description
CurrentDepth (integer)The number of messages currently in the queue.
ErrorDescription (string)A textual description of an error.
IsError (boolean)Returns true if the UDR contains an error message.
IsOpen (boolean)Returns true if the connection was successfully opened.
MaxDepth (integer)The maximum number of messages allowed in the queue.
MqError (string)The error code provided by IBM MQ when a connection attempt fails or in case of an error related to the mqPut or mqClose commands occurs.
QueueManager (string)The name of the queue manager.
QueueName (string)The name of the queue to connect to.
 


MQQueueManagerInfo

The MQQueueManagerInfo UDR type is used by the APL functions when establishing a connection towards a queue on the Queue Manager for outgoing messages.

The following fields are included in the MQQueueManagerInfo UDR:


 

Field
Description
ChannelName (string)The name of the MQ channel.
Host (string)The host name of the queue manager host.
Port (integer)The port for the queue manager.
Properties (map<any,any>)A map of optional properties to be set, for example, user name.
QueueManager (string)The name of the queue manager.


Scroll ignore
scroll-viewportfalse
scroll-pdftrue
scroll-officefalse
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse


Next: