Batch JMS Dispatcher (batchJmsDispatcher)

Configures the Batch JMS dispatcher.

Attribute name Data type Default value Description
connectionFactoryRef A reference to top level jmsConnectionFactory element (string). batchConnectionFactory The identifier of the JMS connection factory that the Batch dispatcher should use to obtain JMS connections.
id string   A unique configuration ID.
queueRef A reference to top level jmsQueue element (string). batchJobSubmissionQueue The identifier of the JMS queue that the Batch JMS dispatcher uses to send JMS messages.
connectionFactory
Description: The identifier of the JMS connection factory that the Batch dispatcher should use to obtain JMS connections.
Required: false
Data type:
Attribute name Data type Default value Description
connectionManagerRef A reference to top level connectionManager element (string).   Connection manager for a connection factory.
containerAuthDataRef A reference to top level authData element (string).   Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
jndiName string   JNDI name for a resource.
recoveryAuthDataRef A reference to top level authData element (string).   Authentication data for transaction recovery.
connectionFactory > connectionManager
Description: Connection manager for a connection factory.
Required: false
Data type:
Attribute name Data type Default value Description
agedTimeout A period of time with second precision -1 Amount of time before a physical connection can be discarded by pool maintenance. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
connectionTimeout A period of time with second precision 30s Amount of time after which a connection request times out. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxConnectionsPerThread int

Minimum: 0

  Limits the number of open connections on each thread.
maxIdleTime A period of time with second precision 30m Amount of time after which an unused or idle connection can be discarded during pool maintenance, if doing so does not reduce the pool below the minimum size. A value of -1 disables this timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
maxPoolSize int

Minimum: 0

50 Maximum number of physical connections for a pool. A value of 0 means unlimited.
minPoolSize int

Minimum: 0

  Minimum number of physical connections to maintain in the pool. The pool is not pre-populated. Aged timeout can override the minimum.
numConnectionsPerThreadLocal int

Minimum: 0

  Caches the specified number of connections for each thread.
purgePolicy
  • ValidateAllConnections
  • FailingConnectionOnly
  • EntirePool
EntirePool Specifies which connections to destroy when a stale connection is detected in a pool.
ValidateAllConnections
When a stale connection is detected, connections are tested and those found to be bad are closed.
FailingConnectionOnly
When a stale connection is detected, only the connection which was found to be bad is closed.
EntirePool
When a stale connection is detected, all connections in the pool are marked stale, and when no longer in use, are closed.
reapTime A period of time with second precision 3m Amount of time between runs of the pool maintenance thread. A value of -1 disables pool maintenance. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
connectionFactory > containerAuthData
Description: Default authentication data for container managed authentication that applies when bindings do not specify an authentication-alias for a resource reference with res-auth=CONTAINER.
Required: false
Data type:
Attribute name Data type Default value Description
password Reversably encoded password (string)   Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.
user string   Name of the user to use when connecting to the EIS.
connectionFactory > properties.wasJms
Description: A JMS connection factory is used to create connections to the associated JMS provider of JMS destinations, for both point-to-point and publish/subscribe messaging.
Required: false
Data type:
Attribute name Data type Default value Description
busName string defaultBus The name of a bus when connecting to the service integration bus in a full profile server.
clientID string clientID The JMS client identifier needed for durable(and for shared non-durable) topic subscriptions on all connections. This identifier is required if the application is doing durable(and for shared non-durable) publish/subscribe messaging.
durableSubscriptionHome string defaultME Durable subscription home defines ME name to which connection needs to be established.
nonPersistentMapping
  • BestEffortNonPersistent
  • ReliableNonPersistent
  • ExpressNonPersistent
ExpressNonPersistent The reliability applied to Non-persistent JMS messages sent using this connection factory.
BestEffortNonPersistent
BestEffortNonPersistent
ReliableNonPersistent
ReliableNonPersistent
ExpressNonPersistent
ExpressNonPersistent
password Reversably encoded password (string)   It is recommended to use a container managed authentication alias instead of configuring this property.
persistentMapping
  • AssuredPersistent
  • ReliablePersistent
ReliablePersistent The reliability applied to persistent JMS messages sent using this connection factory.
AssuredPersistent
AssuredPersistent
ReliablePersistent
ReliablePersistent
readAhead
  • AlwaysOff
  • Default
  • AlwaysOn
Default Read ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.
AlwaysOff
AlwaysOff
Default
Default
AlwaysOn
AlwaysOn
remoteServerAddress string   The remote server address that has triplets separated by a comma, with the syntax hostName:portNumber:chainName, used to connect to a bootstrap server. For example, Merlin:7276:BootstrapBasicMessaging. If hostName is not specified, the default is localhost. If portNumber is not specified, the default is 7276. If chainName is not specified, the default is BootstrapBasicMessaging. Refer to the information center for more information.
shareDurableSubscription string   Controls whether or not durable subscription can be shared across connections.
targetTransportChain string   Transport chains specify the communication protocols that can be used to communicate with the service integration bus in a full profiles server.
temporaryQueueNamePrefix string temp The prefix of up to twelve characters used for the temporary queues created by applications that use this queue connection factory.
temporaryTopicNamePrefix string temp The prefix of up to twelve characters used for the temporary topics created by applications that use this topic connection factory.
userName string   It is recommended to use a container managed authentication alias instead of configuring this property.
connectionFactory > properties.wmqJms
Description: WebSphere MQ JMS connection factory
Required: false
Data type:
Attribute name Data type Default value Description
CCSID int

Minimum: 1

819 The coded character set identifier for a connection.
applicationName string   The name by which an application is registered with the queue manager.
arbitraryProperties string   Ability to specify properties not defined elsewhere
brokerCCSubQueue string   The name of the queue from which a connection consumer receives nondurable subscription messages
brokerControlQueue string   The name of the broker control queue
brokerPubQueue string   The name of the queue where published messages are sent (the stream queue).
brokerQueueManager string   The name of the queue manager on which the broker is running
brokerSubQueue string   The name of the queue from which a nondurable message consumer receives messages
brokerVersion
  • 2
  • 1
  The version of the broker being used
2
2
1
1
ccdtURL string   A URL that identifies the name and location of the file containing the client channel definition table (CCDT) and specifies how the file can be accessed.
channel string   The name of the MQI channel to use.
cleanupInterval A period of time with millisecond precision   The interval, in milliseconds, between background runs of the publish/subscribe cleanup utility. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
cleanupLevel
  • SAFE
  • FORCE
  • NONDUR
  • NONE
  • STRONG
SAFE The cleanup level for a broker-based subscription store.
SAFE
SAFE
FORCE
FORCE
NONDUR
NONDUR
NONE
NONE
STRONG
STRONG
clientId string   The client identifier for a connection
cloneSupport
  • ENABLED
  • DISABLED
DISABLED Whether two or more instances of the same durable topic subscriber can run simultaneously.
ENABLED
ENABLED
DISABLED
DISABLED
connectionNameList string   A list of TCP/IP connection names (hostname(port))used for communications. ConnectionNameList supersedes the hostname and port properties.
failIfQuiesce boolean true Whether calls to certain methods fail if the queue manager is in a quiescing state.
headerCompression
  • SYSTEM
  • NONE
NONE A list of the techniques that can be used for compressing header data on a connection
SYSTEM
SYSTEM
NONE
NONE
hostName string   The host name or IP address of the system on which the queue manager resides. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
localAddress string   For a connection to a queue manager, this property specifies either or both of the following, (1) The local network interface to be used, (2) The local port, or range of local ports, to be used
messageCompression
  • RLE
  • NONE
NONE A list of the techniques that can be used for compressing message data on a connection.
RLE
RLE
NONE
NONE
messageSelection
  • CLIENT
  • BROKER
CLIENT Determines whether message selection is done by WebSphere MQ classes for JMS or by the broker.
CLIENT
CLIENT
BROKER
BROKER
password Reversably encoded password (string)   The default password to use when creating a connection to the queue manager. (It is recommended to use a container managed authentication alias instead of configuring this property)
pollingInterval A period of time with millisecond precision   If each message listener within a session has no suitable message on its queue, this value is the maximum interval, in milliseconds, that elapses before each message listener tries again to get a message from its queue. If it frequently happens that no suitable message is available for any of the message listeners in a session, consider increasing the value of this property. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
port int

Minimum: 1

1414 The port on which the queue manager listens. The hostname and port properties are superseded by the ConnectionNameList property when it is specified.
providerVersion
  • 7
  • 6
  • unspecified
unspecified The version, release, modification level and fix pack of the queue manager to which the application intends to connect.
7
7
6
6
unspecified
unspecified
pubAckInterval int

Minimum: 0

25 The number of messages published by a publisher before WebSphere MQ classes for JMS requests an acknowledgment from the broker
queueManager string   The name of the queue manager to connect to
receiveExit string   Identifies a channel receive exit program, or a sequence of receive exit programs to be run in succession
receiveExitInit string   The user data that is passed to channel receive exit programs when they are called
rescanInterval A period of time with millisecond precision 5s When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, WebSphere MQ classes for JMS searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
securityExit string   Identifies a channel security exit program
securityExitInit string   The user data that is passed to a channel security exit program when it is called
sendCheckCount int

Minimum: 0

  The number of send calls to allow between checking for asynchronous put errors, within a single non-transacted JMS session.
sendExit string   Identifies a channel send exit program, or a sequence of send exit programs to be run in succession.
sendExitInit string   The user data that is passed to channel send exit programs when they are called.
shareConvAllowed boolean true Whether a client connection can share its socket with other top-level JMS connections from the same process to the same queue manager, if the channel definitions match
sparseSubscriptions boolean false Controls the message retrieval policy of a TopicSubscriber object.
sslCertStores string   The Lightweight Directory Access Protocol (LDAP) servers that hold certificate revocation lists (CRLs) for use on an SSL connection.
sslCipherSuite string   The CipherSuite to use for an SSL connection.
sslFipsRequired boolean   Whether an SSL connection must use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS).
sslPeerName string   For an SSL connection, a template that is used to check the distinguished name in the digital certificate provided by the queue manager.
sslResetCount int

Minimum: 0

Maximum: 999999999

0 The total number of bytes sent and received by an SSL connection before the secret keys used by SSL are renegotiated.
statusRefreshInterval A period of time with millisecond precision 1m The interval, in milliseconds, between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subscription store has the value QUEUE. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
subscriptionStore
  • MIGRATE
  • BROKER
  • QUEUE
BROKER Determines where WebSphere MQ classes for JMS stores persistent data about active subscriptions.
MIGRATE
MIGRATE
BROKER
BROKER
QUEUE
QUEUE
targetClientMatching boolean true Whether a reply message, sent to the queue identified by the JMSReplyTo header field of an incoming message, has an MQRFH2 header only if the incoming message has an MQRFH2 header.
tempQPrefix string   The prefix that is used to form the name of a WebSphere MQ dynamic queue.
tempTopicPrefix string   When creating temporary topics, JMS generates a topic string of the form TEMP/TEMPTOPICPREFIX/unique_id, or if this property is left with the default value, just TEMP/unique_id. Specifying a non-empty TEMPTOPICPREFIX allows specific model queues to be defined for creating the managed queues for subscribers to temporary topics created under this connection.
temporaryModel string   The name of the model queue from which JMS temporary queues are created. SYSTEM.JMS.TEMPQ.MODEL can be used by the JMS Layer to create queues which accept persistent messages, as the default value cannot. SYSTEM.DEFAULT.MODEL.QUEUE can be opened only once. SYSTEM.JMS.TEMPQ.MODEL can be opened more than once. SYSTEM.DEFAULT.MODEL.QUEUE is deprecated.
transportType
  • CLIENT
  • BINDINGS
CLIENT Whether a connection to a queue manager uses client mode or bindings mode.
CLIENT
CLIENT
BINDINGS
BINDINGS
userName string   The default user name to use when creating a connection to a queue manager. (It is recommended to use a container managed authentication alias instead of configuring this property)
wildcardFormat
  • CHAR
  • TOPIC
TOPIC Which version of wildcard syntax is to be used.
CHAR
CHAR
TOPIC
TOPIC
connectionFactory > recoveryAuthData
Description: Authentication data for transaction recovery.
Required: false
Data type:
Attribute name Data type Default value Description
password Reversably encoded password (string)   Password of the user to use when connecting to the EIS. The value can be stored in clear text or encoded form. It is recommended that you encode the password. To do so, use the securityUtility tool with the encode option.
user string   Name of the user to use when connecting to the EIS.
queue
Description: The identifier of the JMS queue that the Batch JMS dispatcher uses to send JMS messages.
Required: false
Data type:
Attribute name Data type Default value Description
jndiName string   JNDI name for a resource.
queue > properties.wasJms
Description: The name of the queue that this JMS queue is assigned to.
Required: false
Data type:
Attribute name Data type Default value Description
deliveryMode
  • NonPersistent
  • Application
  • Persistent
Application The delivery mode for messages sent to this destination. This controls the persistence of messages on this destination.
NonPersistent
NonPersistent
Application
Application
Persistent
Persistent
priority int

Minimum: 0

Maximum: 9

  The relative priority for messages sent to this destination, in the range 0 to 9, with 0 as the lowest priority and 9 as the highest priority.
queueName string Default.Queue The name of the associated Queue
readAhead
  • AlwaysOff
  • AsConnection
  • AlwaysOn
AsConnection Read ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.
AlwaysOff
AlwaysOff
AsConnection
AsConnection
AlwaysOn
AlwaysOn
timeToLive A period of time with second precision 0s The default time in milliseconds from its dispatch time that the system must keep the messages live in the destination. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
queue > properties.wmqJms
Description: WebSphere MQ JMS Queue
Required: false
Data type:
Attribute name Data type Default value Description
CCSID int

Minimum: 1

1208 The coded character set ID to be used for a connection or destination
arbitraryProperties string   Ability to specify properties not defined elsewhere
baseQueueManagerName string   Queue Manager name that has this queue defined on it
baseQueueName string   Name of the Queue on the Queue Manager
encoding string NATIVE How numeric data in the body of a message is represented when the message is sent to this destination. The property specifies the representation of binary integers, packed decimal integers, and floating point numbers.
expiry string APP The period after which messages at a destination expire
failIfQuiesce boolean true Whether calls to certain methods fail if the queue manager is in a quiescing state
persistence
  • APP
  • QDEF
  • HIGH
  • NON
  • PERS
APP The persistence of messages sent to a destination
APP
APP
QDEF
QDEF
HIGH
HIGH
NON
NON
PERS
PERS
priority
  • 3
  • 2
  • 1
  • APP
  • 0
  • 7
  • 6
  • 5
  • QDEF
  • 4
  • 9
  • 8
APP The priority for messages sent to a destination
3
3
2
2
1
1
APP
APP
0
0
7
7
6
6
5
5
QDEF
QDEF
4
4
9
9
8
8
putAsyncAllowed
  • ENABLED
  • DESTINATION
  • DISABLED
DESTINATION Whether message producers are allowed to use asynchronous puts to send messages to this destination
ENABLED
ENABLED
DESTINATION
DESTINATION
DISABLED
DISABLED
readAheadAllowed
  • ENABLED
  • DESTINATION
  • DISABLED
DESTINATION Whether the MDB is allowed to use read ahead to get nonpersistent messages from the destination into an internal buffer before receiving them
ENABLED
ENABLED
DESTINATION
DESTINATION
DISABLED
DISABLED
readAheadClosePolicy
  • CURRENT
  • ALL
ALL What happens to messages in the internal read ahead buffer when the MDB is stopped by the administrator.
CURRENT
CURRENT
ALL
ALL
receiveCCSID int

Minimum: 0

  Destination property that sets the target Coded character set identifier for queue manager message conversion. The value is ignored unless receive conversion is set to WMQ_RECEIVE_CONVERSION_QMG
receiveConversion
  • QMGR
  • CLIENT_MSG
CLIENT_MSG Destination property that determines if data conversion is going to be performed by the queue manager.
QMGR
QMGR
CLIENT_MSG
CLIENT_MSG
targetClient
  • JMS
  • MQ
JMS Whether the WebSphere MQ RFH2 format is used to exchange information with target applications
JMS
JMS
MQ
MQ

Icon that indicates the type of topic Reference topic



Timestamp icon Last updated: Monday, 5 December 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rwlp_config_batchJmsDispatcher
File name: rwlp_config_batchJmsDispatcher.html