Frends.IBMMQ.PeekMessage
Frends Task to peek messages from IBM MQ queues.
Task version: 2.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.IBMMQ
Task Parameters
MessageAsBytes : Boolean
If set to true, message contents are returned as a byte array.
Return field name is MessageBytes instead of Message.
Default: False
Example: false
GetMessageProperties : Boolean
Return Message properties in addition to the actual message.
Default: True
Example: true
GetMessageDescriptor : Boolean
Return Message descriptor information in addition to the actual message.
Default: False
Example: false
ParseRFH2Header : Boolean
Return and strip RFH2 headers from the beginning of the message so that they won't be seen in the actual message.
RFH2 headers may be present in the message if the sender has written them.
This can be set to true with no ill effect even if the message doesn't have RFH2 headers.
Default: False
Example: false
HostName : String
Host name.
Default: -
Example: localhost
PortNumber : Int32
Port number.
Default: -
Example: 1414
Channel : String
MQ Channel.
Default: -
Example: SYSTEM.DEF.SVRCONN
QueueManagerName : String
Queue manager.
Default: -
Example: QM1
Queue : String
Queue manager.
Default: -
Example: QM1
UserId : String
User ID.
Default: -
Example: user
🗝Password : String
Password.
Default: -
Example: PassWord
SslCipherSpec : String
The TLS CipherSpec used for the connection.
Ensure this matches the CipherSpec configured on the MQ Channel.
Default: -
Example: TLS_RSA_WITH_AES_256_CBC_SHA256
SslPeerName : String
Used to verify the Distinguished Name (DN) of the Queue Manager's certificate.
Provides an additional layer of security by ensuring the client connects to the correct server.
Default: -
Example: CN=QMGR.*, OU=IBM, OU=WEBSPHERE
SslResetCount : Int32
The number of bytes sent/received before the secret key is renegotiated.
Set to 0 to disable renegotiation.
Default: -
Example: 0
SslCertRevocationCheck : Boolean
Enables or disables SSL certificate revocation checking.
WARNING: This is a process-wide setting (MQEnvironment.SSLCertRevocationCheck)
that applies globally to all IBM MQ connections in the current process.
If multiple tasks run concurrently with different values, the last write wins
and may affect other tasks unpredictably.
Default: -
Example: false
CertSource : CertificateSource
Defines how the SSL certificate is sourced.
Possible values:
Store: Defines how the SSL certificate is sourced.File: Defines how the SSL certificate is sourced.
Default: 1
Example: CertificateSource.Store
StoreType : SslStoreType
Specifies the location of the certificate store.
On Windows, this distinguishes between Current User and Local Machine stores.
On Linux, .NET typically looks for certificates in the user's home directory (/.dotnet/corefx/cryptography/x509stores/my/).
Possible values:
User: Specifies the location of the certificate store.
On Windows, this distinguishes between Current User and Local Machine stores.
On Linux, .NET typically looks for certificates in the user's home directory (/.dotnet/corefx/cryptography/x509stores/my/).
System: Specifies the location of the certificate store.
On Windows, this distinguishes between Current User and Local Machine stores.
On Linux, .NET typically looks for certificates in the user's home directory (~/.dotnet/corefx/cryptography/x509stores/my/).
Default: 0
Example: SslStoreType.User
CertificatePath : String
The absolute path to the .p12 or .pfx certificate file.
Default: -
Example: Windows: "C:\certs\client.p12" Linux: "/app/certs/client.p12"
CertificatePassword : String
The password for the certificate file.
Default: -
Example: PassWord
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Gets a value indicating whether the Task was executed successfully.
Example: true
MessageFound : Boolean
Message found from the queue?
Example: true
Data : QueueMessage
Message data.
Example: { Message = "Hello", MessageBytes = null, MessageDescriptor = null, MessageProperties = null, RFH2Headers = null }
Error : Error
Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }
Task Changelog
Changelog for Task Frends.IBMMQ.PeekMessage.
[2.0.0] - 2026-04-27
Added
Breaking Changes
Removed
Sslparameter tab. All SSL options have been moved to theOptionsparameter tab.
New Features
Added certificate source configuration via
CertSourceproperty (CertificateSource.StoreorCertificateSource.File).Added support for loading client certificates from Windows/Linux certificate store via
StoreTypeproperty (SslStoreType.UserorSslStoreType.System).Added support for loading client certificates from a
.p12/.pfxfile viaCertificatePathandCertificatePasswordproperties.Added error handler with
ThrowErrorOnFailureandErrorMessageOnFailureoptions for consistent error handling.
[1.0.0] - 2024-01-24
Added
Initial implementation
Last updated
Was this helpful?