Batch JMS Executor (batchJmsExecutor)

Configures the Batch JMS executor.

Name Type Default Description

activationSpecRef

A reference to top level jmsActivationSpec element (string).

batchActivationSpec

The identifier of the JMS activation specification that the Batch executor uses to create JMS listeners.

id

string

A unique configuration ID.

operationGroup

string

The name of the operation group

queueRef

A reference to top level jmsQueue element (string).

batchJobSubmissionQueue

The identifier of the JMS queue that the Batch activation specification uses to listen for batch JMS messages.

replyConnectionFactoryRef

A reference to top level jmsConnectionFactory element (string).

batchConnectionFactory

The identifier of the JMS connection factory that the Batch executor should user to obtain JMS connections.

activationSpec

The identifier of the JMS activation specification that the Batch executor uses to create JMS listeners.

Name Type Default Description

authDataRef

A reference to top level authData element (string).

Default authentication data for an activation specification.

autoStart

boolean

true

Configures whether the message endpoints associated with this activation specification start automatically or need to be manually started using the resume command.

maxEndpoints

int
Min: 0

500

The maximum number of endpoints to dispatch to.

activationSpec > authData

Default authentication data for an activation specification.

Name Type Default Description

password

Reversably encoded password (string)
Required

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
Required

Name of the user to use when connecting to the EIS.

activationSpec > properties.wasJms

A JMS activation specification is associated with one or more message-driven beans and provides the configuration necessary for them to receive messages.

Name Type Default Description

acknowledgeMode

  • Auto-acknowledge

  • Dups-ok-acknowledge

Auto-acknowledge

The acknowledge mode indicates how a message received by a message-driven bean should be acknowledged.

busName

string

defaultBus

The name of a bus when connecting to the service integration bus in WebSphere Application Server traditional.

clientId

string

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.

connectionFactoryLookup

string

This property can be used to specify the lookup name of an administratively-defined javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory or javax.jms.TopicConnectionFactory object that is used to connect to the JMS provider from which the endpoint (message-driven bean) can receive messages.

destination

string

Reference to a JMS destination

destinationLookup

string

This property can be used to specify the lookup name of the administratively-defined javax.jms.Queue or javax.jms.Topic objects that define the JMS queue or topic from which the endpoint (message-driven bean) can receive messages.

destinationRef

A reference to top level adminObject element (string).

Reference to a JMS destination

destinationType

  • javax.jms.Queue

  • javax.jms.Topic

javax.jms.Queue

The type of the destination, which is javax.jms.Queue or javax.jms.Topic.

maxBatchSize

int
Min: 1
Max: 2147483647

The maximum number of messages received from the messaging engine in a single batch.

maxConcurrency

int
Min: 1
Max: 2147483647

5

The maximum number of endpoints to which the messages are delivered concurrently. The increase in the number can improve the performance, but it also increases the number of threads that are in use at the specified time. If the message order must be retained for all the failed deliveries, set the maximum concurrent endpoints value to 1.

messageSelector

string

The JMS message selector used to determine which messages the message-driven bean receives. The value is a string that is used to select a subset of the available messages.

readAhead

  • AlwaysOff

  • AlwaysOn

  • Default

Default

Read ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.

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.

retryInterval

A period of time with second precision

30s

The delay (in seconds) between attempts to connect to a messaging engine, both for the initial connection, and any subsequent attempts to establish a better connection. 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.

shareDurableSubscription

string

Controls whether or not durable subscription can be shared across connections.

subscriptionDurability

  • Durable

  • DurableShared

  • NonDurable

  • NonDurableShared

NonDurable

Type of MS topic subscription. The value can be any of following values: Durable DurableShared NonDurable NonDurableShared

subscriptionName

string

The subscription name needed for durable(and for shared non-durable). Required field when using a durable(and for shared non-durable) topic subscription.This subscription name must be unique within a given client identifier.

targetTransportChain

  • InboundBasicMessaging

  • InboundSecureMessaging

InboundBasicMessaging

Transport chains specify the communication protocols that can be used to communicate with the service integration bus in WebSphere Application Server traditional.

queue

The identifier of the JMS queue that the Batch activation specification uses to listen for batch JMS messages.

Name Type Default Description

jndiName

string

JNDI name for a resource.

queue > properties.wasJms

The name of the queue that this JMS queue is assigned to.

Name Type Default Description

deliveryMode

  • Application

  • NonPersistent

  • Persistent

Application

The delivery mode for messages sent to this destination. This controls the persistence of messages on this destination.

priority

int
Min: 0
Max: 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

  • AlwaysOn

  • AsConnection

AsConnection

Read ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.

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.

replyConnectionFactory

The identifier of the JMS connection factory that the Batch executor should user to obtain JMS connections.

Name Type Default 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.

jaasLoginContextEntryRef

A reference to top level jaasLoginContextEntry element (string).

JAAS login context entry for authentication. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.

jndiName

string

JNDI name for a resource.

recoveryAuthDataRef

A reference to top level authData element (string).

Authentication data for transaction recovery.

replyConnectionFactory > connectionManager

Connection manager for a connection factory.

Name Type Default Description

agedTimeout

A period of time with second precision

-1

Amount of time before a connection can be discarded by pool maintenance. A value of -1 disables this timeout. A value of 0 discards every connection, which disables connection pooling. 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, meaning infinite wait. A value of 0 is immediate, meaning no wait. 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.

maxIdleTime

A period of time with second precision

30m

Amount of time a connection can be unused or idle until it 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
Min: 0

50

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

minPoolSize

int
Min: 0

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

purgePolicy

  • EntirePool

  • FailingConnectionOnly

  • ValidateAllConnections

EntirePool

Specifies which connections to destroy when a stale connection is detected in a pool.
EntirePool
When a stale connection is detected, all connections in the pool are marked stale, and when no longer in use, are closed.
FailingConnectionOnly
When a stale connection is detected, only the connection which was found to be bad is closed.
ValidateAllConnections
When a stale connection is detected, connections are tested and those found to be bad 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.

Advanced Properties

enableSharingForDirectLookups

boolean

true

If set to true, connections are shared. If set to false, connections are unshared.

maxConnectionsPerThread

int
Min: 0

Limits the number of open connections on each thread.

numConnectionsPerThreadLocal

int
Min: 0

Caches the specified number of connections for each thread.

replyConnectionFactory > containerAuthData

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.

Name Type Default Description

password

Reversably encoded password (string)
Required

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
Required

Name of the user to use when connecting to the EIS.

replyConnectionFactory > jaasLoginContextEntry

JAAS login context entry for authentication. If updated while the server is running, the update is applied with new connection requests; in-use connections are not impacted.

Name Type Default Description

loginModuleRef

List of references to top level jaasLoginModule elements (comma-separated string).

hashtable,userNameAndPassword,certificate,token

A reference to the ID of a JAAS login module.

name

string
Required

Name of a JAAS configuration entry.

replyConnectionFactory > properties.wasJms

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.

Name Type Default Description

busName

string

defaultBus

The name of a bus when connecting to the service integration bus in WebSphere Application Server traditional.

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

  • ExpressNonPersistent

  • ReliableNonPersistent

ExpressNonPersistent

The reliability applied to Non-persistent JMS messages sent using this connection factory.

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.

readAhead

  • AlwaysOff

  • AlwaysOn

  • Default

Default

Read ahead is an optimization that preemptively assigns messages to consumers. This processes the consumer requests faster.

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 WebSphere Application Server traditional.

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.

replyConnectionFactory > recoveryAuthData

Authentication data for transaction recovery.

Name Type Default Description

password

Reversably encoded password (string)
Required

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
Required

Name of the user to use when connecting to the EIS.