WebSphere MQ connector properties
Properties define how the connector operates in a job. Different properties are available depending upon the context in which you use the connector: source context, target context, or request context for request and reply scenarios.
All of the properties that display in the Connection section or the Usage section of the Properties tab are listed in alphabetical order.
- Access mode
Use this property to specify how the source queue is opened. - Accounting token
Use the properties in this group to specify the accounting token in messages. - Alternate security ID
Use the properties in this group to specify the Windows security identifier (SID) that uniquely identifies the alternate user. - Alternate user ID
Use this property to specify the identifier of the alternate user that the security service of the queue manager uses to open this queue. - Append node number
Use this property to append the node number to the work queue name. - Application ID data
Use this property to specify values that represent the application that originally put the message on the queue. - Application origin data
Use this property to specify customized, application-specific information about the origin of the message. - Backout count
For output links only, use this property to specify the specific value or a range of values that represents the number of times that a message was rolled back for message filtering. - Binding mode
Select the binding mode to use when the queue manager selects a physical queue instance from the cluster. - Blocking transaction processing
Use this property to indicate whether the connector should call an external method, which is created by the user and provided in a shared library, for each input message to determine if it is a blocking transaction message. - Case sensitive
Use this property to specify whether or not text comparisons are case-sensitive. - Channel name
Use this property to specify the name of the client connection channel through which messages are sent from the connector to the remote queue manager. - Client channel definition
Use the properties in this group to define the connection channel that connects to the remote queue manager from the connector. - Cluster queue
Use this property to specify whether the target queue is accessed as a shared cluster queue. - Coded character set ID
Use this property to specify the identifier for the coded character set for messages. - Coded character set ID for Message conversion
Use this property to specify the identifier for the coded character set used when the queue manager converts character data in source messages. - Connection name
Use this property to specify the name of the client connection for this connector. - Content filter
Use this property to specify the content filter when the subscriber registers or deregisters. - Context mode
Use this property to specify whether any identity context or origin context values are included in all messages when the target queue is opened. - Context mode for Error queue
Use this property to specify the context mode when the error queue is opened. - Context mode for work queue
Use this property to specify the context mode when the work queue is opened. - Correlation ID
Use the properties in this group to specify the correlation identifier for messages. - Correlation ID for Deregistration
Use this property to specify the correlation identifier for deregistration command messages. - Correlation ID for Registration
Use this property to specify the correlation identifier for registration command messages. - Custom value for Feedback
Use this property to specify a user-defined feedback code or reason code for the report message. - Custom value for Format
Use this property to specify a user-defined value for the message format. - Custom value for Message type
Use this property to specify a user-defined value for the message type (input links) or a range of values for source messages (output links). - Custom value for Publication format
For input links only, use this property to specify a user-defined format for the publication payload. - Custom value for Put application type
Use this property to specify a user-defined value for the application type upon which the message is put. - Deregistration
Use this property to specify whether the broker deregisters this publisher or subscriber from the specified topic. This deregistration occurs before job completion, but after all of the messages in the job are produced or consumed. - Dynamic queue
Use this property to specify whether the queue manager creates a dynamic queue at run time to serve only the message operation of a specific application. This queue name is based upon the name of a model queue. - Dynamic reply queue
Use this property to specify whether the reply queue is accessed as a dynamic queue. The broker uses this reply queue to send replies to the command messages that the connector sends to the broker. - Enable payload reference
Use this property to specify whether to pass a reference to the message payload rather than passing the actual payload data. - Encoding
Use this property to specify the encoding value or values for numeric data in a message. - Encoding for Message conversion
Use this property to specify the encoding when the queue manager converts numeric data in source messages. - End of data
Use this property to specify whether the end of wave marker is inserted for the last remaining set of records. This scenario is invoked when the number of records in that last set is less than the value in the Record count property. - End of data message type
Use this property to specify the message type in the message header that specifies the end of the message reading process. - End of wave
Specify how the end of wave markers are handled in all of the transactions. - Error queue
Use the properties in this group to define a local or remote error queue. - Expiry
Use this property to specify the value that defines the lifetime of a message. - Feedback
Use the properties in this group to specify acceptable feedback and reason codes for target messages (input links and request links) or source messages (output links). - Filter messages
Use the properties in this group to specify filter criteria for source messages (output links). - Format
Use the properties in this group to specify the format for the message. - General options for Deregistration
Use this property to specify whether the broker deregisters the publisher for input links or deregisters the subscriber for output links from the specified topic upon job completion. - General options for Registration
Use this property to specify how the publisher (for input links) or subscriber (for output links) is identified to a broker. - Group ID
Use this property to specify the group identifier for messages. The group identifier defines the messages that belong to a specified group. - Header version
Use this property to specify the WebSphere MQ application version number for the header structure of the source message. - Hex for Accounting token
Use this property to specify whether the value in the Value property is treated as an array of pairs of hexadecimal digits or as text. - Hex for Alternate security ID
Use this property to specify whether the value in the Value property is treated as an array of pairs of hexadecimal digits or as text. - Hex for Correlation ID
Use this property to specify whether the value in the Value property is treated as an array of pairs of hexadecimal digits or as text. - Hex for Group ID
Use this property to specify whether the value in the Value property is treated as an array of pairs of hexadecimal digits or as text. - Hex for Message ID
Use this property to specify whether the value in the Value property is treated as an array of pairs of hexadecimal digits or as text. - Identity options
Use this property to specify identity registration options for this subscriber. - Key column
Use this property to specify the name of the column to use as the sort key. - Match all
Use this property to determine how filtering based on report values or message flags is handled. - Message content descriptor
Use this property to specify whether the connector includes the service folder (<mcd>) for the message content descriptor in the publication messages. - Message controlled
Use this property to indicate whether the connector should make an external method call after each message to determine whether the transaction should be committed after that message. If the End of wave property is set to a value other than None, committing the transaction also implies the end of the current transaction wave. - Message conversion
Use the properties in this group to specify whether the connector requests that the queue manager performs a message conversion. - Message flags
For input links, this property specifies the flags that are associated with this target message. For output links, use the properties in this group to specify the flags that are associated with this source message. - Message ID
Use the properties in this group to specify the message identifier for messages. - Message options
Use the properties in this group to specify whether you are going to define the order, the structure, and the access mode of the messages. - Message order and assembly
Use this property to specify how segments, logical messages, and groups of messages are retrieved from the source message queue. - Message padding
Use this property to specify whether padding is added to the message payload column. The message payload column is the message body minus any format headers. - Message quantity
Use this property to specify the number of messages (not rows) to retrieve from the input queue. - Message read mode
Use this property to specify how messages are read in the current transaction. - Message sequence number
Use this property to specify the sequential number of the logical message within a message group. - Message sequence number for Publication settings
Use this property to specify whether to update the message sequence number in the published messages. - Message service domain
Select the service domain for the publication messages. - Message set
Use this property to specify the name of the message set for publication messages. - Message truncation
Use this property to specify whether truncation is performed on messages with source message payloads that are larger than the column size for that payload. - Message type
Use the properties in this group to define the message types that filter source messages (output links). Alternatively, select the message type to set on the target messages (input links). - Message type for Message content descriptor
Use this property to specify the name of the message type for the publication messages. - Message write mode
Use this property to specify how messages are written in the current transaction. - Method name (Blocking transaction processing)
Use this property to specify the external (user-defined) method that the connector calls for each input message to determine if that message represents a blocking transaction message. - Method name (Message controlled)
Use this property to specify the external, user-defined, method that the connector should call after each message to determine whether the transaction needs to be committed after that message. If the End of wave property is set to a value other than None, committing the transaction also implies the end of the current transaction wave. - Mode
Use this property to specify whether the connector functions as a server or client application. - Module name
Use this property to specify the name of the shared (dynamic) library that implements the method that the connector calls after each message to determine whether it should commit the transaction after that message. - Module name (Blocking transaction processing)
Use this property to specify the name of the shared (dynamic) library which implements the method that the connector calls after each message to determine whether the message represents a blocking transaction message. - Monitor queue depth
Use this property to control the work queue depth during job execution. - Name
Use this property to specify the work queue that messages will be moved to. - Null order
Use this property to specify where to place null values in the sort order. - Offset
Use this property to specify the location, in bytes, of a physical message segment relative to the start of the logical message to which the segment belongs. - Original length
For output links only, use this property to specify the length of the message segment to which the report message relates. This property is not the length of the entire logical message, nor is it the length of the data in the report message itself. The report message thus becomes another segment in the logical message. - Other queue settings
Use the properties in this group to specify whether you want to specify additional settings for the queue to be accessed. - Password
Use this property to specify the password of the user specified by the value typed in the Username property. The connector impersonates this user on the local computer before connecting to the queue manager (Windows only). - Payload size
For output links only, use this property to specify acceptable payload sizes and ranges of payload sizes for source messages. - Period
Use this property to specify the number of seconds to read messages from the input queue before repositioning the queue cursor at the beginning of that queue. - Persistence
Use this property to specify whether the message survives after the queue manager is restarted. Restarts might occur because of a system failure or because the queue manager has been manually restarted. - Persistence options
Use this property to specify the persistence registration value for the subscriber. - Physical format
Use this property to specify the name of the Message Repository Manager (MRM) physical format in the specified message set that is used for the publication messages. - Priority
Use this property to specify the importance of the message in comparison with other messages on the queue. - Publication format
Use the properties in this group to specify the format of the publication payload. - Publication options
Use this property to specify the publication options when you publish messages. - Publication settings
Use the properties in this group to specify the options to apply when you prepare publication messages. - Publish/Subscribe
Use the properties in this group to specify whether the connector is used in the Publish/Subscribe mode of operation. - Put application name
Use this property to specify the name of the application for target messages (for input links) or source messages (for output links). - Put application type
Use the properties in this group to specify the put application values for target messages (for input links) or source messages (for output links). - Put date
Use this property to specify the put date for target messages (for input links) or source messages (for output links). - Put time
Use this property to specify the put time for target messages (for input links) or source messages (for output links). - Queue manager for Cluster queue
Use this property to select the cluster queue manager name to which the message is sent. - Queue manager for Connection
Use this property to select the name of the queue manager to access for the connection. - Queue manager for Error queue
Use this property to select the name of the queue manager that hosts the error queue. - Queue name
Use this property to select the name of the queue from which you want to receive messages (for output links), to which you want to send messages (for input links), or to which you want to send request messages (for request links). - Queue name for Dynamic queue
Use this property to specify the name or portion of the name of the dynamic queue. - Queue name for Dynamic reply queue
Use this property to specify the name of the dynamic reply queue. - Queue name for Error queue
Use this property to select or type the name of the error queue. - Record count
Use this property to specify the number of records to process before the connector commits the current transaction or unit of work. - Record ordering
Use this property to specify how to process records across multiple links. - Refresh
Use this property to specify whether the queue cursor is repositioned to the beginning of the input queue. - Registration
Use this property to specify whether the publisher or subscriber registers with the broker after the job starts and before messages are either produced or consumed. - Registration options
Use this property to select the registration options for the publication of messages. - Reply queue
Use this property to select the name of the reply queue that appears in the registration and deregistration command messages that the connector sends as part of the job. - Reply queue close options
For request links only, use this property to specify how the dynamic reply queue is closed. - Reply to queue
Specify the name of the message queue upon which reply messages or report messages are returned for the messages that are sent by the connector. - Reply to queue manager
Use this property to specify the name of the reply queue manager upon which the reply queue resides. - Report
For input and request links, use this property to specify the report information that the connector sends in the message header. For output links, use the Value sub-property to specify the value used to filter report messages. - Row buffer count
Use this property to specify the number of rows (records) that create one composite message to be sent to the target queue. - Segment size
Use this property to specify the size of each segment in bytes. - Segmented message
Use this property to specify whether target messages are separated into segments that are then sent to the target queue as opposed to sending a single message. - Service type
Use this property to specify the message format of command messages that the connector sends to the broker. - Set header fields
For input links and request links only, use the properties in this group to specify whether message header data is overwritten by the values in this group. - Sort order
Use this property to specify whether to sort values in ascending or descending order. - Start value
Use this property to specify the initial message sequence number for the first published message. - Stream name
Use this property to specify the name of the stream for publications. - Subscription identity
Use this property to specify the subscriber application identity for the subscription that is registered, deregistered, or both registered and deregistered. - Subscription name
Use this property to define the name of the subscription for registration, deregistration, or both, depending upon the publish/subscribe values. - Subscription point
Use this property to specify the subscription point when you register or deregister the subscriber. - System value for Feedback
For input links, select one feedback code or reason code (MQRC) for target messages. For output links, select one or more feedback codes or reason codes (MQRC) for source messages. - System value for Format
For input links, select one format for target messages. For output links, select one or more formats for source messages. - System value for Message type
For input links, select one message type for target messages. For output links, select one or more message types for source messages. - System value for Publication format
For input links, select one publication payload format for target messages. - System value for Put application type
For input links, select one put application type for target messages. For output links, select one or more put application types for source messages. - Timeout (Blocking transaction processing)
Use this property to specify the time, in seconds, that the connector will wait for a job to process the blocking transaction message before logging error messages and stopping the job. - Timestamp
Use this property to specify whether timestamp information is included in published messages. - Topic for Publication settings
Use this property to specify the name of the topic upon which the publications are sent. - Topic for Registration and Deregistration
Use this property to specify the one or more topics for which to register or deregister the publisher or subscriber. - Transaction
Use the properties in this group to tune parameters for transactional processing, including end of wave markers, for this connector. - Transmission queue for Error queue
Use this property to specify the name of the transmission queue when you want to use a remote queue for the error queue. - Transmission queue for Other queue settings
Specify the name of the transmission queue if the destination queue is a remote queue. - Transport type
Select the transport protocol for this client connection. - Treat EOL as row terminator
Use this property to specify whether the end-of-line character in the message payload is processed as the end of a row. - Use wildcard
Use this property to determine whether an asterisk (*) in the property value is interpreted as a wildcard character that represents a contiguous group of characters. - User ID
Use this property to specify the user identifier for the application that receives the source messages or that sends the target messages. - Username
Use this property to specify the user name of the user that the connector impersonates on the local computer before the connector connects to the queue manager (Windows only). - Value for Accounting token
Use this property to specify the accounting token in source messages (for output links) or target messages (for input links and request links). - Value for Alternate security ID
Use this property to specify the alternate security identifier to open a queue. - Value for Correlation ID
Use this property to specify the correlation identifier in source messages (for output links) or target messages (for input links and request links). - Value for Group ID
Use this property to specify the group identifier in source messages (for output and request links) or target messages (for input links). - Value for Message flags
For output links (source messages) only, use this property to specify flags that are associated with the message. - Value for Message ID
Use this property to specify the message identifier in source messages (for output and request links) or target messages (for input links). - Value for Report
For output links only, select the report flag values that are used to filter source messages. Only messages with the specified report message header field values are accepted by the connector. - Wait time
Use this property to specify the maximum number of seconds to wait for a new message to arrive upon the input queue. - Work queue
Use the properties in this group to define a work queue.
Parent topic: IBM WebSphere MQ connector