MSMQ Adapter 6.0 | webMethods MSMQ Adapter Documentation | webMethods MSMQ Adapter Installation and User’s Guide Documentation | Adapter Connections | Configuring Adapter Connections
 
Configuring Adapter Connections
When you configure MSMQ Adapter connections, you specify information that Integration Server uses to connect to a queue and a message queuing computer. Each connection is associated with one particular queue that has specific access and share modes. You configure MSMQ Adapter connections using Integration Server Administrator.
You can configure the following connection types with MSMQ Adapter:
*MSMQ Non Transactional Connection
*MSMQ Transactional Connection
At design time, you must decide what type of connections to associate with adapter services and adapter listeners to determine how you want them to process messages. For example, a Get service requires a transactional connection to allow MSMQ Adapter to roll back messages. The connection type that is associated with an adapter listener also influences a listener notification because notifications are associated with listeners. To review the dependancies between WmART, MSMQ Adapter, adapter connections, adapter services, adapter listeners, and listener notifications, see the figure in MSMQ Adapter Package Management.
Important:
If you are using the adapter with Integration Server 8.0 SP1 or earlier, listeners cannot share connections with adapter services. However, listeners can share connections with other listeners.
For more information on how each service processes a message, see appropriate run-time processing section for each service in About MSMQ Adapter . For more information on how listeners perform when they are associated with a non-transactional or transactional connection, see Listener Transactionality and Behavior.
Note:Software AG recommends that you create separate adapter connections for listeners and adapter services while working with non-transactional queues. That is, create one connection that is exclusive to listeners and another connection that is exclusive to adapter services.
*To configure a connection
1. In Integration Server Administrator in the Adapters menu, click MSMQ Adapter.
2. On the Connections screen, click Configure New Connection.
3. On the Connection Types screen, complete one of the following steps:
*To make a non-transactional connection, click MSMQ Non Transactional Connectionto display the Configure Connection Type screen.
*To make a transactional connection, click MSMQ Transactional Connection to display the Configure Connection Type screen.
4. In the MSMQ Adapter section, provide values for the following fields:
Parameter
Description
Package
The package in which to configure the connection.
You must create the package using Designer before you can specify it using this parameter. For general information about creating packages, see the webMethods Service Development Help for your release.
Configure the connection in a user-defined package rather than in the adapter's package. For other important considerations when creating packages for MSMQ Adapter, see Package Management.
Folder Name
The folder in which to configure the connection.
Connection Name
The name you want to give the connection. Connection names cannot have spaces or use special characters reserved by Integration Server, or Designer. For more information about the use of special characters in package, folder, and element names, see the webMethods Service Development Help for your release.
5. In the Connection Properties section, provide values for the following fields:
Parameter
Description
MSMQ Version
Version of the MSMQ Server.
Transaction Type
Type of connection.
Queue Path Name
The queue path name. For example, hostname\queuename.
Note:
For remote non-transactional private queues, leave this parameter blank and complete the Queue Format Nameparameter.
Queue Format Name
Optional. Unique queue name for the queue that is generated by Message Queuing.
Note:
If you do not specify a Queue Path Name, you must enter a Queue Format Name. An example of a queue format name for a remote private queue is DIRECT=OS:hostname\private$
Note:\queuename.
Queue Access Mode
The direction of the connection. Select one of the following:
*OUTBOUND. webMethods-to-MSMQ. (Put adapter service)
*INBOUND. MSMQ-to-webMethods. (Get or Peek adapter services or listener)
Queue Share Mode
Access to messages on the same queue. Select one of the following:
*MQ_DENY_NONE. User will have access when other users access a message from the same queue. (Get, Peek, or Put adapter services or listener.)
*MQ_DENY_RECEIVE_SHARE. User receives an error when other users get a message from the same queue. (Get adapter service or listener.)
Queue Type
The type of queue based on the transactional connection. Select one of the following:
*LOCAL_QUEUE. The transactional queue on the host machine.
*REMOTE_QUEUE. The transactional queue on a remote machine.
To enable your host Integration Server to read messages from remote queues, ensure the following:
*The message queuing service is running on the host machine.
*MSDTC is configured and running for the host machine to receive messages from remote MSMQ servers.
Note:
For information about configuring MSTDC for transactional remote receive on your host Integration Server, refer to the Microsoft documentation.
6. In the Connection Management Properties section, provide values for the following fields:
Parameter
Description/Action
Enable Connection Pooling
Enables the connection to use connection pooling.
For more information about connection pooling, see Adapter Connections.
Note:
If you plan to enable connection pooling in a clustered environment, consider the connection pool size. For details, see Considerations When Configuring Connections with Connection Pooling Enabled.
Minimum Pool Size
The minimum number of connection objects that remain in the connection pool at all times. When the adapter creates the pool, it creates this number of connections. Default: 1.
Maximum Pool Size
The maximum number of connection objects that can exist in the connection pool. When the connection pool has reached its maximum number of connections, the adapter will reuse any inactive connections in the pool or, if all connections are active, it will wait for a connection to become available. Default: 10.
Pool Size Increment
If connection pooling is enabled, this field specifies the number of connections by which the pool will be incremented if connections are needed, up to the maximum pool size. Default: 1.
Block Timeout (msec)
If connection pooling is enabled, this field specifies the number of milliseconds that Integration Server will wait to obtain a connection with the MSMQ Server before it times out and returns an error. Default: 1000.
Expire Timeout (msec)
If connection pooling is enabled, this field specifies the number of milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. For example, to specify 10 seconds, specify 10000. Enter 0 to specify no timeout. Default: 1000.
Note:
Note that the adapter will never violate the Minimum Connections parameter. These connections remain in the pool regardless of how long they are inactive.
Startup Retry Count
If connection pooling is enabled, this field specifies the number of times that the system should attempt to initialize the connection pool at startup if the initial attempt fails, before issuing an AdapterConnectionException.
Startup Backoff Timeout
If connection pooling is enabled, this field specifies the number of seconds to wait between each attempt to initialize the connection pool.
7. Click Save Connection.
The connection that you configured appears on the adapter's Connections screen and in Designer.
By default, when you configure a connection, it is not enabled. For more information about enabling connections, see Enabling Adapter Connections.