Configuring the Software AG Universal Messaging Broker transport

To test Software AG Universal Messaging Broker server resources with HCL OneTest™ API, you must configure the connection details for the Software AG Universal Messaging Broker in the Architecture School's Physical View.

About this task

To configure a Software AG Universal Messaging Broker transport:

Procedure

  1. In the Software AG UM Broker window, on the Config tab, enter a name for the transport in the Name field (to help identify the transport when multiple Software AG Universal Messaging Broker transports are available).

    The transport settings are managed on the Config tab and are broken into basic settings, SSL settings, and advanced settings.

    Note:
    • All of the configuration fields support the use of tags, which can be entered manually or by selecting them from the menu.
    • You can test the connection parameters at any time by clicking Test Transport
  2. Configure the basic Software AG Universal Messaging Broker settings on the Settings tab. The available configuration options are described in the following table:
    Table 1. Settings
    Protocol Description
    Host The hostname or IP address of the Software AG Universal Messaging server.
    Port The port number Software AG Universal Messaging server is listening.
    Timeout Enter a timeout value for the creation of the Software AG Universal Messaging session.
    User The ID of the user who is sending or receiving messages from HCL OneTest™ API.
    Password The password (if required) associated with the user name specified.
    Reply Correlation Settings To associate the reply message from Software AG Universal Messaging with the specific request message, you can specify any of the following settings for the message:
    • Use the destination to match responses to requests:

      This option indicates that when this transport receives a message, this is the first message available on the target destination (specified into the configuration of the operation that use the transport) that is used.

    • Use Correlation ID to match responses to requests: This option filters messages in the reply destination specified by the operation that is using the transport. The Correlation ID is used to correlate responses with requests. The Correlation ID is set as an extra message property.
    • Use Message ID mapped to Correlation ID to match responses to requests: This option uses a single temporary reply destination, mapping the Message ID to the Correlation ID to correlate responses with requests. The Message ID is set as an extra message property.
  3. Click Session and configure the session that is used to communicate with the Software AG Universal Messaging Broker transport. See Universal Messaging Session attributes references.
    Table 2. Session
    Follow the Master

    If this property is set to true, the session initially connects to the master realm of the cluster. If the master realm becomes unavailable and a new master is selected, the session automatically connects to it.
    Unthrottled Connection Sessions started with these session attributes request that the server does not throttle this connection when the available memory on the server is low. This is necessary only if the server has the EnableFlowControl config item set to true and if the session publishes to the server. Otherwise the connection is not throttled.

    Session Threads as daemons

    This thread is set as non-daemon thread by default. This is to ensure that on program exit, or on Main thread exit, call stacks are correctly unwound. Setting the read thread to a daemon thread might cause your program to prematurely exit when all other non-daemon threads exit. This method should be used with extreme care.
  4. Click Properties and update the Name, Type, and Value fields and click OK.

    You can send more properties in the header of the Software AG Universal Messaging messages. These properties can be used, for example, to let recipients decide which messages are presented to the receiving application.

  5. Configure the settings that are used to connect to the server by using SSL on the SSL tab. The available configuration options are described in the following table:
    Table 3. SSL
    Use Universal Messaging SSL Select this check box to use Universal Messaging SSL for the connection to the server.

    You can add trust stores and key stores requirement to connect to the server. They are pre-defined in HCL OneTest™ API.
    Trust Store Select an existing HCL OneTest™ API Identity store, which is required by Universal Messaging to be a JKS (JAVA Key Store) file. After the JKS is added as an Identity Store, it can be selected from the combination list. The trust store contains certificates that are trusted by the client.
    Key Store If you are using SSL, you must have valid certificate key store files in your workspace. Select the identity store to use.
    Override default protocols If you have to use a specific version of the SSL protocol, such as SSLv2 or TLSv1.2, enter that algorithm name here. For a complete list of algorithms, see Standard Algorithm Name Documentation.
  6. Configure the transport recording in the Recording tab. The available configuration options are described in the following table:
    Table 4. Recording
    Target Name Enter the target name to be used for the publication. This target corresponds to the Channel, Queue or Data Group that is used to receive the request or the publish event.
    Target Type Select the target type: Channel, Queue or Data Group.
    Suffix The suffix is automatically set but it can be modified.
    Generate Subject Allow creating a publisher name automatically to be used for the publish action, based on the client machine configuration.
    Publisher Name This option is enabled for Data Group target type only. Select the subject name to be used with the Data Group.
    Compress If you selected this option, the message published on to the Channel or Queue is compressed by using the packet size.
    Packet Size If you selected the compress option, enter the maximum packet size.