Read
The Read function reads a message from a specified queue on an IBM MQ server.
If no message is available, the function returns an empty result. If a correlation ID is specified, only messages with a matching correlation ID are returned.
Properties
Queue
Host name
The host name or IP address of the IBM MQ server. This is a mandatory field.
Port
The port number the IBM MQ server listens on. The default port is 1414.
Queue manager
The name of the IBM MQ queue manager to connect to. This is a mandatory field.
Channel
The server-connection channel used to connect to the queue manager. This is a mandatory field.
Queue name
The name of the queue to read from. This is a mandatory field.
Security
Username
The username for authentication. This is a mandatory field.
Password
The password for authentication. This is a mandatory field.
Domain
The Windows domain for authentication. Leave blank if not required.
Character set
The character encoding used to decode the message body.
IBM037
ISO_8859_1_Latin1_IBM819 (default)
IBM850
Unicode
UTF
Encoding
Specifies the numeric encoding of the message. Match these settings to the encoding of the originating system.
Binary encoding
INTEGER_UNDEFINED Encoding is unspecified; the queue manager's default is used.
INTEGER_NORMAL Big-endian integer encoding, typical of AIX and POWER-based systems.
INTEGER_REVERSED (default) Little-endian integer encoding, typical of Windows and x86-based systems.
Decimal encoding
DECIMAL_UNDEFINED Encoding is unspecified; the queue manager's default is used.
DECIMAL_NORMAL Big-endian packed decimal encoding.
DECIMAL_REVERSED (default) Little-endian packed decimal encoding.
Floating point encoding
FLOAT_UNDEFINED Encoding is unspecified; the queue manager's default is used.
IEEE_NORMAL IEEE 754 big-endian floating point encoding.
IEEE_REVERSED (default) IEEE 754 little-endian floating point encoding.
S390 IBM System/390 mainframe floating point encoding.
Options
Correlation Id
Filters messages by correlation ID. When specified, only messages with a matching correlation ID are returned. Maximum length is 24 characters.
Remove message from queue
If selected, the message is removed from the queue after reading (destructive get). If not selected, the message remains on the queue (browse). Default is not selected.
Request Signing (Certificate)
Sign with certificate
Select to enable TLS/SSL certificate authentication when connecting to the IBM MQ server.
When enabled, the following properties are displayed:
Certificate path:
The path to the X.509 client certificate file (.pfx).
Certificate password:
The password for the certificate.
Peer name:
The subject distinguished name (DN) of the server's certificate, used to verify the server's identity (used for TLS authentication). The following fields are available inside the peer object:
Country
Organization
Organizational unit
Common name
State or province
Locality
Email address
User identifier
Cipher specification:
The cipher specification for the TLS connection. Must match the SSLCIPH value configured on the server-connection channel of the IBM MQ queue manager.
TLS_RSA_WITH_AES_256_CBC_SHA256 (default)
ECDHE_RSA_AES_256_GCM_SHA384
Output
The following fields are produced as an output by the function:
CorrelationId
The correlation ID of the message.
Message
The content of the message body.
Links
Last updated