WebSphere MQ messaging provider topic connection factory settings

Network Deployment (All operating systems), v8.5 > Reference > Settings
WebSphere MQ messaging provider topic connection factory settings page

Use this panel to view or change the configuration properties of the selected topic connection factory for use with the WebSphere MQ messaging provider. These configuration properties control how connections are created to the associated JMS topic destination.
A WebSphere MQ topic connection factory is used to create JMS connections to topic destinations provided by WebSphere MQ for publish/subscribe messaging.
To view WebSphere MQ topic connection factory settings, use the administrative console to complete the following steps:

In the navigation pane, click Resources > JMS->Topic connection factories to display existing topic connection factories.
If appropriate, in the content pane, change the Scope setting to the level at which the topic connection factories are defined. This restricts the set of topic connection factories displayed.
Select the name of the topic connection factory you want to work with.

Under General Properties there are four groups of properties:

Administration
Connection
Advanced
Security settings

Make any required changes to the Administration, Connection, Advanced and Security settings groups of properties, and then click Apply to save the configuration before, in the content pane under Additional Properties, you click any of the following links:

Advanced properties to display the advanced properties of your WebSphere MQ topic connection factory.
Broker properties to display the broker properties of your WebSphere MQ topic connection factory.
Custom properties to display the custom properties of your WebSphere MQ topic connection factory.
Client transport properties to display or change the client transport properties of your WebSphere MQ topic connection factory. If the selected topic connection factory was not created using a Client Channel Definition Table (CCDT), follow this link to enter all the information required to connect to WebSphere MQ. If the selected topic connection factory was created using a CCDT, we do not need to supply the client transport properties, and so the link is absent.
Connection pools to display the connection pools detail of your WebSphere MQ topic connection factory
Session pools to display the session pools detail of your WebSphere MQ topic connection factory.

Under Related Items, you can click JAAS - J2C authentication data to configure authentication information for use with the topic connection factory.
We can specify the following additional properties by using WebSphere MQ administrative commands:

-localAddress
-clonedSubs
-componentAuthAlias

For more information about these properties, refer to the createWMQConnectionFactory command.
When specifying WebSphere MQ properties, the following restrictions apply:

Names can have a maximum of 48 characters, with the exception of channels, which have a maximum of 20 characters.
The property values specified must match the values that you specified when we configured the JMS resources in WebSphere MQ. For more information about configuring JMS resources in WebSphere MQ, see the Using Java section of the WebSphere MQ information center.

A WebSphere MQ topic connection factory has the following properties.

Administration

Scope

The level to which this resource definition is visible to applications.
Resources such as messaging providers, namespace bindings, or shared libraries can be defined at multiple scopes, with resources defined at more specific scopes overriding duplicates that are defined at more general scopes.
The scope displayed is for information only, and cannot be changed on this panel. If to browse or change this resource at a different scope, change the scope on the WebSphere MQ topic connection factory collection panel, then click Apply, before clicking the link for the type of resource.

Information Value
Data type String

Provider

The JMS provider assigned when the topic connection factory is created.
For all topic connection factories created using this panel, the provider is the WebSphere MQ messaging provider.
The provider is displayed for information only.

Information Value
Data type String

Name

The name by which this topic connection factory is known for administrative purposes within WAS.

Information Value
Data type String
Range The name must be unique within the set of JMS topic connection factories defined to the cell.

JNDI name

The JNDI name used to bind the topic connection factory into the JNDI namespace.
As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource.

Information Value
Data type String

Description

A description of this topic connection factory for administrative purposes within WAS.

Information Value
Data type String
Default Null

Connection

The information required to configure a connection depends on whether the selected topic connection factory was created using a Client Channel Definition Table (CCDT).
If the selected topic connection factory was created using a CCDT, only the following properties are displayed:

Client channel definition table URL
Queue manager
SSL configuration

If the selected topic connection factory was not created using a CCDT, the following properties are displayed:

Queue manager
Transport
If Enter host and port information in the form of separate host and port values is selected, the connection name list property cannot be used and the following properties can be used:

Host name
Port

If Enter host and port information in the form of a connection name list is selected, the connection name list property can be used and the following properties cannot be used:

Host name
Port

Server connection channel
If you clear the check box for the Use SSL to secure communication with Websphere MQ property, the following properties cannot be used:

Centrally managed
Specific configuration
SSL configuration

For more information about setting the SSL properties for WebSphere MQ, see SSL properties in the Using Java section of the WebSphere MQ information center.

Client channel definition table URL

A URL that specifies the location of a WebSphere MQ CCDT.

Information Value
Data type String

Queue manager

If the specified topic connection factory is based on a CCDT, this property is used to select an entry in the CCDT. Otherwise, it is the name of the queue manager or queue-sharing group to connect to. A connection is established to this WebSphere MQ resource to send or receive messages.

Information Value
Data type String
Range If this topic connection factory is not based on a CCDT, the value must be a valid queue manager name.
If this topic connection factory is based on a CCDT, the value must be one of the following:

A valid queue manager name
An asterisk (*) followed by the name of a queue manager group¹
An asterisk (*)
Blank¹
¹When we specify the value of the Queue manager property in this form in combination with a CCDT, individual connections established by using the topic connection factory might connect to different queue managers. Selection from multiple queue managers occurs when the CCDT contains multiple client connection channel definitions with a matching queue manager name (QMNAME) parameter, and these connection channel definitions define the network connection details of different queue managers.
If the specified connection factory is based on a CCDT, and the CCDT can select from more than one queue manager, you might not be able to recover global transactions. Therefore, for connection factories that specify a CCDT, we have two alternatives:

Avoid any ambiguity about the target queue manager when specifying the Queue manager property, which means the specified value of this property must not include an asterisk (*).
Avoid using the resources with applications that enlist in global transactions.

Transport

The WebSphere MQ transport type for the connection. The transport type is used to determine the exact mechanisms used to connect to WebSphere MQ.

Information Value
Data type Drop-down list
Default Bindings, then client
Range

Client

Use a TCP/IP-based network connection to communicate with the WebSphere MQ queue manager

Bindings, then client

Attempt a bindings mode connection to the queue manager. If this is not possible, revert to the client transport.

Bindings

Establish a cross-memory connection to a queue manager running on the same node. The following Client Transport Mode properties are disabled:

Hostname
Port
Connection name list
Server connection channel

For more information about configuring a transport type of Bindings, then client or Bindings, refer to Configuring the WebSphere MQ messaging provider with native libraries information.

Enter host and port information in the form of separate host and port values

If this radio button is selected, this means the connection to the WebSphere MQ queue manager is made using the information supplied by the host name and port properties.
Selecting this option enables the host name and port properties, and disables the connection name list property. To enter connection name list information, click Enter host and port information in the form of a connection name list.
This radio button is only available if the scope property specifies a cell or cluster, or if the scope property specifies a node or server and that node or server is running WAS Version 8.0 or later.

Information Value
Data type Radio button

Hostname

The host name, IPv4, or IPv6 address of the WebSphere MQ queue manager to connect to.

Information Value
Data type String

Port

The port number on which WebSphere MQ is listening.

Information Value
Data type Integer
Default 1414
Range The value must be in the range 1 to 65536 (inclusive).

Enter host and port information in the form of a connection name list

If this radio button is selected, this means the connection to the WebSphere MQ queue manager is made using the information supplied by the connection name list property.
Connection name lists can be used to connect to a single queue manager or to a multi-instance queue manager. For more information on using a multi-instance queue manager, see the WebSphere MQ information centre. Selecting this option enables the connection name list property and disables the host name and port properties. To enter separate host and port information, click Enter host and port information in the form of separate host and port values.
This radio button is only available if the scope property specifies a cell or cluster, or if the scope property specifies a node or server and that node or server is running WAS Version 8.0 or later.

Information Value
Data type Radio button

Connection name list

The connection name list specifying the host name and port details to use when we want the connection factory to connect to a multi-instance queue manager.
This property must only be used to allow connection to a multi-instance queue manager. It must not be used to allow connections to non-multi-instance queue managers as that can result in transaction integrity issues.

Information Value
Data type String
Default Unset
Range This field must be set to a string in the following form:
host[(port)][,host(port)]
The port information is optional, and if not specified, defaults to 1414.
host must be a valid TCP/IP host name or IPv4 or IPv6 address.
port must be an integer value in the range 1 to 65536 (inclusive).
For example: localhost(1234),remotehost1(1234),remotehost2

When the connection name list property is specified, the host name or port properties are automatically set to the host name and port number of the first entry in the connection name list. So if you specified localhost(1234),remotehost1(1234),remotehost2, the host name would be set to localhost and port would be set to 1234.
This property is only available if the scope property specifies a cell or cluster, or if the scope property specifies a node or server and that node or server is running WAS or later.
When used in a mixed cell environment, the information in the connection name list property is not available to versions of WAS earlier than Version 8.0. In this case, the information in the host name and port name fields, based on the first element in the connection name list, is used instead.

Server connection channel

The WebSphere MQ server connection channel name used when connecting to WebSphere MQ.

Information Value
Data type String
Default SYSTEM.DEF.SVRCONN
Range The value must be a server connection channel defined to the WebSphere MQ queue manager that is being connected to.

Use SSL to secure communications with WebSphere MQ

This option determines whether the SSL (Secure Sockets Layer) protocol is used to secure network communications with the WebSphere MQ queue manager or queue-sharing group.
When using a WebSphere MQ messaging provider topic connection factory in the application server environment, the application server manages SSL configuration. To change SSL configuration parameters, use the administrative console to navigate to the Security > SSL certificate and key management panel.
When using a WebSphere MQ messaging provider topic connection factory in the client environment, the client takes SSL configuration information from the ssl.client.props file. Use of this file is detailed in the related reference information for this topic.
We can only use one cipher suite in the SSL configuration for a WebSphere MQ messaging provider topic connection factory. If we specify more than one cipher suite, only the first one is used.

Information Value
Data type Check box. If this check box is cleared, the following SSL properties are disabled:

Centrally managed
Specific configuration
SSL configuration

Centrally managed

When the SSL protocol is used to communicate with WebSphere MQ, select this radio button to specify the SSL configuration is taken from the centrally managed WebSphere Application Server SSL configuration.
When you select this radio button, the host name and port attributes from the WebSphere MQ messaging provider connection factory are used to select an appropriate SSL configuration. If host and port information has been supplied by a connection name list this means the host name and port information of the first element in the list are used to select an appropriate SSL configuration. To provide the SSL configuration which will be matched to the connection factory, see the Dynamic outbound endpoint SSL configuration settings topic listed under related reference.

Information Value
Data type Radio button

Specific configuration

Select this radio button when we want to specify a particular SSL configuration for use when SSL is to be used to secure network communications with the WebSphere MQ queue manager or queue-sharing group.

Information Value
Data type Radio button

SSL configuration

The SSL configuration to use when SSL is to be used to secure network communications with the WebSphere MQ queue manager or queue sharing group.
This property is disabled if the Centrally managed radio button is selected and the WebSphere MQ messaging provider resource has been explicitly defined.
This property is always enabled if the WebSphere MQ messaging provider resource is based on a CCDT.
If this WebSphere MQ messaging provider resource is based on a CCDT, this parameter is only used if the relevant entries in the CCDT have been configured to use SSL.
Additionally, if an SSL configuration of none is selected, the default centrally managed WAS SSL configuration for the WebSphere MQ messaging provider is used.

Information Value
Data type Drop-down list

Advanced

Client ID

The client identifier to specify when connecting to WebSphere MQ messaging provider.

Information Value
Data type String

Allow cloned durable subscriptions

An option that determines whether multiple instances of a durable subscription can be accessed concurrently by different servers.

Information Value
Data type Check box
Default Cleared
Range

Selected

Multiple instances of a durable subscription can be accessed concurrently by different servers.

Cleared

Multiple instances of a durable subscription cannot be accessed concurrently by different servers.

Provider version

The WebSphere MQ messaging provider version. This is used to determine whether to connect to a particular version of a queue manager. It is also used to determine the type of functions required by the client.

Information Value
Data type String
Range The value entered must either be the empty string or be in one of the following formats:

n.n.n.n
n.n.n
n.n
n
where n is a numeric value greater than or equal to zero.
For example 6.0.0.0.

Support distributed two-phase commit protocol

An option that specifies whether the topic connection factory supports XA coordination of messaging transactions. Enable this option if multiple resources, including this topic connection factory, are to be used in the same transaction.
If you clear this property, you disable support for distributed two-phase commit protocol. The JMS session can still be enlisted in a transaction, but it uses the resource manager local transaction calls session.commit and session.rollback, instead of XA calls. This can lead to an improvement in performance. However, only a single resource can be enlisted in a transaction in WAS.
Last participant support enables you to enlist one non-XA resource with other XA-capable resources.

Information Value
Data type Check box
Default Selected
Range

Selected

The connection factory supports the use of distributed two-phase commit protocols for the coordination of transacted work.

Cleared

The connection factory does not support the use of distributed two-phase commit protocols for the coordination of transacted work.

Do not enable XA when the queue manager specified by the topic connection factory is the only resource in the transaction. Enable XA if transactions involve other resources, including other queues or topics.

Security settings

Authentication alias for XA recovery

The user name and password to use when connecting to WebSphere MQ during XA recovery.

Information Value
Data type Drop-down list
Default (none)
Range All authentication aliases defined to the cell and the value "(none)", which specifies that no credentials are passed to WebSphere MQ during XA recovery.

Mapping-configuration alias

This field is used only in the absence of a login configuration on the component resource reference.
When the resource authority value is "container", the preferred way to define the authentication strategy is by specifying a login configuration and associated properties on the component resource reference.
If the DefaultPrincipalMapping login configuration is specified, the associated property will be a JAAS - J2C authentication data entry alias. To configure authentication information for use with the topic connection factory, under Related Items, click JAAS - J2C authentication data .

Information Value
Data type Drop-down list
Default (none)
Range The following options are available:

ClientContainer
WSLogin
WSKRB5Login
DefaultPrincipalMapping
TrustedConnectionMapping
KerberosMapping

Container-managed authentication alias

The authentication alias which specifies the user name and password to use when connecting to the WebSphere MQ messaging provider.

Information Value
Data type Drop-down list
Default (none)
Range All authentication aliases defined to the cell and the value "(none)", which specifies that no credentials are passed to WebSphere MQ.

Related concepts:

JMS interfaces - explicit polling for messages

Related tasks:

Managing Java 2 Connector Architecture authentication data entries for JAAS
Secure messaging
Configuring a unified connection factory for the WebSphere MQ messaging provider
Configuring the WebSphere MQ messaging provider with native libraries information

Related reference:

Topic connection factory page
WebSphere MQ messaging provider topic connection factory advanced properties
WebSphere MQ messaging provider connection factory broker properties
WebSphere MQ messaging provider connection factory client transport settings
Connection pool properties
Session pool settings
Mapping of administrative console panel names to command names and WebSphere MQ names
WebSphere MQ resource custom properties settings
ssl.client.props client configuration file
Dynamic outbound endpoint SSL configuration settings
WebSphere MQ library Web page at http://www.ibm.com/software/ts/mqseries/library

Information	Value
Data type	String
Range	The name must be unique within the set of JMS topic connection factories defined to the cell.

Information	Value
Data type	Integer
Default	1414
Range	The value must be in the range 1 to 65536 (inclusive).

Information	Value
Data type	Drop-down list
Default	(none)
Range	All authentication aliases defined to the cell and the value "(none)", which specifies that no credentials are passed to WebSphere MQ during XA recovery.