Parameter | Description |
Package | The package in which to create 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. Create the connection in a user-defined package rather than in the adapter's package. For other important considerations when creating packages for the WebSphere MQ Adapter, see
Package Management. Default: Package |
Folder Name | The folder in which to create 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 and 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. |
Parameter | Action/Description |
CCDT File Path (Absolute path) | Optional. The Queue Manager/@ipcc/AMQCLCHL.TAB file is generated on the WebSphere MQ server whenever you create or update the required CCDT configuration. Copy this file from the WebSphere MQ server to your local machine where Integration Server is installed and specify the absolute path of the file in this field. Note: If you are using CCDT, then it is not mandatory to provide values for the fields TCP/IP Port and Server Connection Channel. If you update the configurations at the Queue Manager level, copy the updated Queue Manager/@ipcc/AMQCLCHL.TAB file from WebSphere MQ server. |
Queue Manager Name | Required for a remote connection and for a local connection to non-default Queue Managers. The name of the Queue Manager to which you want to connect. The name you type must match the name of the Queue Manager on the WebSphere MQ Queue Manager. This name is case-sensitive. If you do not specify a Queue Manager Name, the WebSphere MQ Adapter uses the default local queue manager on the same machine the adapter is installed. |
Host Name | Required for remote connection. The name of the machine on which the WebSphere MQ Queue Manager is installed. You can specify the IP address instead of the Host Name in this field. If you do not specify a Host Name or an IP address, the WebSphere MQ Adapter does the following: Uses the local Queue Manager binding mode, which improves performance because the adapter is executing on the same machine as the Queue Manager Ignores the TCP/IP Port and Server Connection Channel |
TCP/IP Port | Optional. The port number where the WebSphere MQ Queue Manager listens for client requests. If you do not specify a port number, the default value is 1414 . If you are using CCDT and have specified the absolute path in CCDT File Path (Absolute path), then this field is optional. If you do not specify a Host Name, the WebSphere MQ Adapter ignores the TCP/IP Port. |
Server Connection Channel | Required for remote connection. The name of the Server Connection Channel assigned to a connection to the Server from the client. If you do not specify a Host Name, the WebSphere MQ Adapter ignores the Server Connection Channel. If you are using CCDT and have specified the absolute path in CCDT File Path (Absolute path), then this field is optional. Note: This value is case sensitive. Maximum characters: 20. |
CCSID | Required. IBM's Coded Character Set Identifiers (CCSID) used by the Integration Server. This numeric value specifies the code page of the character-encoding scheme that the webMethods machine is requesting to use. For valid CCSID values, see IBM's WebSphere MQ documentation. The CCSID specified for a remote connection is used only when establishing the connection to the remote Queue Manager. |
User Id | The user ID to connect to the Queue Manager, if the Queue Manager is secured. |
Password | The password used with the user ID to connect to the Queue Manager, if the Queue Manager is secured. |
Retype Password | Retype the password that you just entered. |
Queue Name(s) | The name of the Queue from which you want to send and receive messages. To select the queue names, perform one of the following tasks: Click the Find Queues button, and select one or more queues from the drop-down menu. Make sure that you specify the Queue Manager field before selecting the Find Queues button. The WebSphere MQ Adapter generates an error message if you have not specified a value for the Queue Manager parameter. Type one or more queue names in the Queue Name(s) field. You can specify more than one Queue Name in this field separated by a space. Specifying multiple queues allows the Put service to broadcast a message to every queue in the list. However, the list of queue names cannot contain the name of a model queue. The Get, Peek, and Request/Reply services only use the first queue name in the list. |
Dynamic Queue Prefix | The prefix used when dynamically creating queues from a model queue. If the queue specified in the Queue Name field refers to a model queue, then WebSphere MQ will dynamically create a new queue when the WebSphere MQ Adapter initializes the connection. The name of the new queue will begin with this prefix, and will be globally unique. Note: If the specified value does not end in an asterisk (*), the name of the dynamically created queue is the value that you specified in the Dynamic Queue Prefix field. |
Encoding | Required. Numeric encoding used by Integration Server. This value specifies the numeric-encoding scheme that Integration Server is requesting to use. The Encoding specified for a remote connection is used only when establishing the connection to the remote Queue Manager. Default: 00273 - Native |
Send Exit Name | The Java Class Name that contains the code the WebSphere MQ Server will execute. A Send Exit executes during the Put and Request/Reply operations, before the message is placed on the queue. For example, you could use this exit to encrypt or change the message, based on information in the message header. |
Send Exit Init Parms | The initialization parameters that are the data values the WebSphere MQ Server will pass to the Java class. |
Receive Exit Name | The Java Class Name that contains the code the WebSphere MQ Server will execute. A Receive Exit executes during the Get, Peek, and Request/Reply operations. You can exit to filter or to change messages based on information in the message header. |
Receive Exit Init Parms | Initialization parameters that are the data values the WebSphere MQ Server will pass to the Java class. |
Security Exit Name | The Java Class Name that contains the code the WebSphere MQ Server will execute. A Security Exit allows you to customize the security flows that occur when an attempt is made to connect to a queue manager. |
Security Exit Init Parms | Initialization parameters that are the data values the WebSphere MQ Server will pass to the Java class. |
Cache Overridden Connections | When you override a WebSphere MQ Adapter services' connection parameters at run time, the WebSphere MQ Adapter creates a new connection with the new parameters and internally caches these connections to improve the performance. However, in some cases the internal caching can lead to large number of open connections. To avoid large number of open connections, set this parameter to false. Select how the connection is managed: true Enables internal caching of overridden connections. false Disables internal caching of overridden connections. Default: true Note: If you are using a connection configured using WebSphere MQ Adapter 6.0, the connection refers to the watt property watt.WmMQAdapter.Cache.Overridden.Connections. If this watt property is not set, then WebSphere MQ Adapter sets Cache Overridden Connection parameter to the default value true. |
Action before Disconnecting an in-transaction Connection | This parameter is available only for transactional connections. Select how the adapter must handle the transaction before disconnecting: COMMIT Commits the transaction before disconnecting. ROLLBACK Rolls back the transaction before disconnecting. Default: COMMIT Note: If you are using a connection configured using WebSphere MQ Adapter 6.0, the connection refers to the watt property watt.WmMQAdapter.actionBeforeDisconnect. If this watt property is not set, then WebSphere MQ Adapter sets Action before Disconnecting an in-transaction Connection to the default value COMMIT. |
SSL Option | This parameter is visible only when using Integration Server 8.0 and higher, and when you set the watt.WmMQAdapter.SSL.Support property to true. keystore file Select this option to configure SSL connections using a Keystore file. keystore alias Select this option to configure SSL connections using keystore and truststore aliases. For information about how to configure SSL connections, see
Configuring SSL Connections. |
SSL Keystore File | This parameter is visible only when you set the watt.WmMQAdapter.SSL.Support property to true. The fully qualified file name of the SSL Keystore. |
SSL Keystore Password | This parameter is visible only when you set the watt.WmMQAdapter.SSL.Support property to true. The password associated with the SSL KeyStore. |
Retype SSL Keystore Password | This parameter is visible only when you set the watt.WmMQAdapter.SSL.Support property to true. Retype the password that you just entered. |
SSL Keystore Alias | This parameter is visible only when using Integration Server 8.0 and higher, and when you set the watt.WmMQAdapter.SSL.Support property to true. The alias for the keystore file. |
SSL Truststore Alias | This parameter is visible only when using Integration Server 8.0 and higher, and when you set the watt.WmMQAdapter.SSL.Support property to true. The alias for the truststore file. |
SSL Cipher Spec | This parameter is visible only when you set the watt.WmMQAdapter.SSL.Support property to true. SSL and TLS CipherSpec listings are introduced in the watt property watt.WmMQAdapter.Connection.CiphersList. It takes priority over existing watt property. You can set watt.WmMQAdapter.Connection.CiphersList=SSL, where this watt property takes priority over watt.WmMQAdapter.SSL.Support. Note: You can configure either SSL Cipher Spec or TLS Cipher Spec when configuring SSL connections. For information about how to configure SSL connections, see Configuring SSL Connections. Select any one of the following SSL: DES_SHA_EXPORT NULL_MD5 NULL_SHA RC2_MD5_EXPORT RC4_MD5_US RC4_MD5_EXPORT RC4_SHA_US TRIPLE_DES_SHA_US Default: DES_SHA_EXPORT |
Additionally, perform the following steps to enable TLS Cipher Spec: a. On your WebSphereMQ server, install the iFix provided by IBM that supports TLS Ciphers with Java clients running on a non-IBM JDK. b. Replace the com.ibm.mq.jmqi.jar file at the location, packages_directory \WmMQAdapter\code\jars directory with the .jar file provided by IBM through the iFix. c. Set the JVM property, -Dcom.ibm.mq.cfg.useIBMCipherMappings = false in either, Integration Server’s server.bat file located in the Integration Server_directory \bin directory. The wrapper.conf file located in the SoftwareAG\profiles\IS_default\configuration directory. Note: Enabling TLS Cipher Spec will disable SSL Cipher Spec. You can configure either SSL Cipher Spec or TLS Cipher Spec when configuring SSL connections. For information about how to configure SSL connections, see Configuring SSL Connections. | |
watt.WmMQAdapter.Connection.CiphersList=TLS takes priority over watt.WmMQAdapter.SSL.Support. Select any one of the following TLS: TLS_RSA_WITH_DES_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_NULL_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 Default: TLS_RSA_WITH_DES_CBC_SHA Note: If you want to run TLS Cipher Spec properties that use 256-bit algorithms, your JVM must replace the JCE Limited Strength Jurisdiction Policy Files with JCE Unlimited Strength Jurisdiction Policy Files. For information about how to replace the JCE Limited Strength Jurisdiction Policy Files, see Using Software AG Installer guide. | |
You can set the watt.WmMQAdapter.Connection.CiphersList property to: AllCipherSpec where, watt.WmMQAdapter.Connection.CiphersList=AllCipherSpec contains the cipherspecs of both SSL and TLS. Select any one of the following AllCipherSpec: DES_SHA_EXPORT NULL_MD5 NULL_SHA RC2_MD5_EXPORT RC4_MD5_US RC4_MD5_EXPORT RC4_SHA_US TRIPLE_DES_SHA_US TLS_RSA_WITH_DES_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_NULL_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_RC4_128_SHA256 TLS_RSA_WITH_AES_128_GCM_SHA256 Note: The connection remains enabled when you change the parameters from SSL or TLS to AllCipherSpec, only if the selected CipherSpec is supported by underlying JVM and MQ server. AllCipherSuite where, The watt property is visible only when you set the watt.WmMQAdapter.Connection.CiphersList=AllCipherSuite. Select any one of the following AllCipherSuite: SSL_RSA_WITH_DES_CBC_SHA SSL_RSA_WITH_NULL_MD5 SSL_RSA_WITH_NULL_SHA SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5 SSL_RSA_WITH_RC4_128_MD5 SSL_RSA_EXPORT_WITH_RC4_40_MD5 SSL_RSA_WITH_RC4_128_SHA SSL_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_NULL_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA256 Note: The existing connection is disabled when you change the current watt property to watt.WmMQAdapter.Connection.CiphersList=AllCipherSuite or when you change from the watt property watt.WmMQAdapter.Connection.CiphersList=AllCipherSuite to any other watt property. |
Parameter | Description/Action |
Enable Connection Pooling | Enables the connection to use connection pooling. For more information about connection pooling, see
Adapter Connections. Default: true 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 the Integration Server will wait to obtain a connection with the WebSphere MQ 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 | The number of times that the system should attempt to initialize the connection pool at startup if the initial attempt fails. Default: 0 |
Startup Backoff Timeout (sec) | The number of seconds that the system should wait between attempts to initialize the connection pool. Default: 10 |
Heart Beat Interval | If the connection pooling is enabled and the minimum pool size is more than zero, the Heart Beat Interval is applicable. The connection pool checks the connectivity of the connections that are idle for the value of Heart Beat Interval. The default value for Heart Beat Interval is zero and it is mentioned in seconds. For example, if the value of Heart Beat Interval is 25 seconds, connection pool looks for connection that are idle for 25 seconds. If the connection is broken then the connection pool is reset. The feature is applicable for Integration Server 10.5 and all subsequent versions. |