Basic settings

After you create a transport for WebSphere® MQ, you must configure a few basic settings associated with it.

To configure basic transport settings, you must click the Settings tab. You can connect to WebSphere® MQ by using a specific channel or a Client Channel Definition Table (CCDT).

Connection by using a specified channel

The following settings apply when you choose to connect by using a specific channel. This is the default way to connect.

Field Description
Host The hostname or IP address of the server for WebSphere® MQ. When using a queue sharing group, this must be the hostname or IP address of a QMGR within the group.
Queue Manager The name of the queue manager for WebSphere® MQ queue manager to use. On z/OS systems, this can also be the name of a queue sharing group.
Note:
This field is case-sensitive.
Port The port number where WebSphere® MQ is listening (the default is 1414).
Channel The name of the communication channel for WebSphere® MQ that is used for sending and receiving messages.
Note:
  • This name must be a Server Connection type because HCL DevOps Test Integrations and APIs (Test Integrations and APIs) is a client application.
  • This field is case-sensitive.
Username The ID of the user who is sending or receiving messages from Test Integrations and APIs.
Important:
It is your discretion to use credentials in Test Integrations and APIs. Whether you are using credentials depends on the version of WebSphere® MQ that you are using and how you configured the queue manager for WebSphere® MQ. For more information about queue manager authentication, see the related links.
Password The password (if required) associated with the user name specified.
Application Name The value that is used to set the Put application name attribute on messages sent by Test Integrations and APIs.
Note:
The value that is entered in this field is ignored unless the transport's Write Options include the following details:
  • The MQOO_SET_ALL_CONTEXT flag for Queue Open.
  • The MQPMO_SET_ALL_CONTEXT flag for Put Message.
For more information about queue settings and configuring WebSphere® MQ transports, see the related links.
The maximum length of the name is 28 characters. Any additional characters that you enter are truncated. The default value is Test Integrations and APIs.
Application Type The type of connection to the queue manager.
Connection Management To control how Test Integrations and APIs manages the connections to WebSphere® MQ resources, you must select any of the following options by using the slider:
  • Minimize Resources: Use this option if you run sequential tests. This option maintains a few core connections, creates more connections when required, and closes them as soon as they are used.
  • Balanced: Use this option if you run a few stubs or parallel tests. This option maintains a slightly larger number of core connections, creates more connections when required, and closes them after a short period of inactivity. The queue handles are held for a short period and reused, if possible. This option is the default and all the transports that were created in Test Integrations and APIs earlier than version 8.7.1 are set to use this option.
  • Maximize Performance: Use this option if you virtualize many services. This option is similar to the Balanced settings but the connections and the queue handles are held for a longer duration before closing.
Properties A collection of properties to use when you define the connection. For each property, you must specify the property name, type, and value.
Important:
  • Property names are case-sensitive. For example, CCSID works, but ccsid does not.
  • The property type must match that of the property selected. If you are unsure as to which property type to select, use String.
  • To authenticate from a Java client to the queue manager for WebSphere® MQ where you want to specify a password length that is greater than 12 characters, you must add the Use MQCSP authentication property and set its value to true. For more information about this property, see the related links.

    If you fail to use this property when a password length is greater than 12 characters, authentication from a Java client to the queue manager for WebSphere® MQ fails.

Connection by using CCDT

The following settings apply when you choose to connect by using CCDT.

Note:
You must configure Library Manager to use WebSphere® MQ 9.2.1 JAR files to connect to WebSphere® MQ by using a Client Channel Definition Table (CCDT).
Field Description
File or URL The name of the CCDT file or URL, which contains the connection details. You must browse to locate and select a local CCDT file or enter the URL of a remote file. The connection details can be in JSON or binary form. For more information about client channel definition tables, see the related links.
Queue Manager Pattern The name of the queue manager pattern to use. On z/OS systems, this can also be the name of a queue sharing group.
Note:
This field is case-sensitive.
Username The ID of the user who is sending or receiving messages from Test Integrations and APIs.
Important:
It is your discretion to use credentials in Test Integrations and APIs. Whether you are using credentials depends on the version of WebSphere® MQ that you are using and how you configured the queue manager for WebSphere® MQ. For more information about queue manager authentication, see the related links.
Password The password (if required) associated with the user name specified.
Application Name The value that is used to set the Put application name attribute on messages sent by Test Integrations and APIs.
Note:
The value that is entered in this field is ignored unless the transport's Write Options include the following details:
  • The MQOO_SET_ALL_CONTEXT flag for Queue Open.
  • The MQPMO_SET_ALL_CONTEXT flag for Put Message.
For more information about queue settings and configuring WebSphere® MQ transports, see the related links.
The maximum length of the name is 28 characters. Any additional characters that you enter are truncated. The default value is Test Integrations and APIs.
Application Type The type of connection to the queue manager.
Connection Management To control how Test Integrations and APIs manages the connections to WebSphere® MQ resources, you must select any of the following options by using the slider:
  • Minimize Resources: Use this option if you run sequential tests. This option maintains a few core connections, creates more connections when required, and closes them as soon as they are used.
  • Balanced: Use this option if you run a few stubs or parallel tests. This option maintains a slightly larger number of core connections, creates more connections when required, and closes them after a short period of inactivity. The queue handles are held for a short period and reused, if possible. This option is the default and all the transports that were created in Test Integrations and APIs earlier than version 8.7.1 are set to use this option.
  • Maximize Performance: Use this option if you virtualize many services. This option is similar to the Balanced settings but the connections and the queue handles are held for a longer duration before closing.
Properties A collection of properties to use when you define the connection. For each property, you must specify the property name, type, and value.
Important:
  • Property names are case-sensitive. For example, CCSID works, but ccsid does not.
  • The property type must match that of the property selected. If you are unsure as to which property type to select, use String.
  • To authenticate from a Java client to the queue manager for WebSphere® MQ where you want to specify a password length that is greater than 12 characters, you must add the Use MQCSP authentication property and set its value to true. For more information about this property, see the related links.

    If you fail to use this property when a password length is greater than 12 characters, authentication from a Java client to the WebSphere® MQ queue manager fails.