Creating a Universal Messaging Connection Alias
A Universal Messaging connection alias is a webMethods messaging connection alias that contains the configuration information for establishing a connection to a Universal Messaging server. Each Integration Server can have multiple Universal Messaging connection aliases.
To create a Universal Messaging connection alias
1. Open the Integration Server Administrator.
2. In the Settings menu of the Navigation panel, click Messaging.
3. Under webMethods Messaging Configuration, click webMethods Messaging Settings.
4. Click Create Universal Messaging connection alias.
5. Under General Settings, specify the following:
For this parameter... | Specify... |
Connection Alias Name | A unique name for the messaging connection alias. |
Description | A description of the messaging connection alias. |
Client Prefix | A string that identifies the Integration Server to Universal Messaging. If your Integration Server belongs to a cluster, make sure all servers in the cluster use the same client prefix. |
Share Client Prefix | Whether Integration Server shares the client prefix with multiple Integration Servers and you want to prevent automatic updates, including deletions, to shared objects associated with this alias on Universal Messaging server. Leave the check box cleared if you do not want to prevent automatic updates to shared objects on the Universal Messaging server. When the Share Client Prefix check box is selected, you must update objects on Universal Messaging manually. For example, if you delete a trigger on Integration Server you need to manually delete the associated channel on Universal Messaging. You must select Share Client Prefix if the Integration Server:  Belongs to a cluster and you want to prevent automatic updates to shared objects associated with this alias on the Universal Messaging server. Belongs to a non-clustered group of Integration Servers that operate in a load-balanced fashion and you want to prevent automatic updates to shared objects associated with this alias on the Universal Messaging server. The Universal Messaging connection alias is used by loggers on multiple Integration Servers in a cluster or non-clustered group to write or read logs from a Universal Messaging queue. Selecting the Share Client Prefix check box ensures that Universal Messaging queue name includes the client prefix which allows Integration Servers to write to and read from the same logging queue across a Universal Messaging realm. For more information about using a Universal Messaging queue as the logging queue, see the webMethods Audit Logging Guide. |
6. Under Connection Settings, specify the following:
For this parameter... | Specify... |
Realm URL | The URL for the Universal Messaging server in the format protocol:// UM_host: UM_port where protocol is the protocol for the port, such as nsp, nsps, or nhps. For example, nsp://127.0.0.1:9000 or nsps://localhost:9000). If the protocol for connecting to Universal Messaging server is nsps or nhps, you must configure the connection alias to enable Integration Server to connect to an SSL-enabled port on Universal Messaging. If you are using a cluster of servers, supply the list of URLs to each server in the cluster using a comma-separated or a semicolon-separated list. By default, Integration Server is configured to follow the master realm server in a cluster, which indicates that Integration Server always connects to the master realm server in the cluster. Consequently, it does not matter if you separate the URLs using a comma or a semicolon though a comma-separated list is more common. If you disabled the follow the master behavior for Integration Server whether you separate the realm servers in a cluster with a comma or a semicolon determines the Universal Messaging realm server to which Integration Server connects. Separate the URLs using a comma if Integration Server always attempts to connect to the first Universal Messaging server in the list, only trying the second Universal Messaging server in the list if the first server becomes unavailable. Separate the URLs using a semicolon if Integration Server connects to a randomly chosen URL from the list. This may result in better distribution of clients across the servers in the cluster. For more information about the follow the master behavior for Universal Messaging clients, see About Follow the Master. Note: | You must specify a URL for every Universal Messaging server in the cluster. Integration Server connects only to the Universal Messaging servers for which you specify a URL. Consequently, Integration Server creates resources such as channels and named objects only on the specified Universal Messaging servers. If you specify only one Universal Messaging server in a cluster, the resources will be local to that server only. |
|
Maximum Reconnection Attempts | Specify the maximum number of reconnection attempts that Integration Server makes if the connection to Universal Messaging fails. If the connection cannot be re-established, Integration Server writes messages to the error log and the connection created by this messaging connection alias will be stopped. The default is 5 attempts. Note: | The Maximum Reconnection Attempts value is a factor only when an existing connection fails. The Maximum Reconnection Attempts value is not a factor that Integration Server considers when starting a messaging connection alias. |
|
7. Under Producer Settings, specify the following:
For this parameter... | Specify... |
Enable CSQ | Whether a client side queue is used with this Universal Messaging connection alias. Do one of the following: Select the Enable CSQ check box if you want to use a client side queue with this Universal Messaging connection alias. When a client side queue is in use, if the Universal Messaging server is not available when Integration Server publishes documents using this Universal Messaging connection alias Integration Server writes the documents to the client side queue. Clear the Enable CSQ check box if you do not want to use a client side queue with this Universal Messaging connection alias. When a client side queue is not in use, if the Universal Messaging server is not available when Integration Server publishes documents using this Universal Messaging connection alias, the publishing service ends with an ISRuntimeException. |
Maximum CSQ Size (messages) | The maximum number of documents (messages) that can exist in the client side queue for this Universal Messaging connection alias. If the client side queue is at capacity, publishing services that use this connection alias will end with an ISRuntimeException. Specify -1 if you want the client side queue to be able to contain an unlimited number of messages. |
Drain CSQ in Order | Whether Integration Server drains the client side queue for this alias by sending the messages to the Universal Messaging server in the same order in which Integration Server placed the messages in the client side queue. Select the check box if you want Integration Server to send messages from the client side queue in the same order in which Integration Server originally placed the messages in the client side queue. When the Drain CSQ in Order check box is selected, after the connection to the Universal Messaging server s re-established, Integration Server continues to write new messages to the client side queue until the client side queue is completely drained. If the Drain CSQ in Order check box is not selected, after the connection to the Universal Messaging server re-established, Integration Server sends new messages directly to the Universal Messaging server while it drains the client side queue. |
Publish Wait Time While Reconnecting | The number of milliseconds that a publishing service using this Universal Messaging connection alias will wait for a connection to the Universal Messaging server to be re-established after the connection fails. If Integration Server re-establishes the connection before the Publish Wait Time While Reconnecting elapses, the publishing service continues executing. If the specified time elapses before a connection is re-established, the publishing service ends with an ISRuntimeException. The default is 0 milliseconds, which means that publishing services will not wait for Integration Server to re-establish the connection. Note: | When a Universal Messaging connection alias is configured to connect to a Universal Messaging cluster, make sure the Publish Wait Time While Reconnecting value is long enough to accommodate the time the Universal Messaging cluster takes to establish a quorum after one of the member servers fails. |
|
8. Under Client Authentication Settings, specify the following:
For this parameter... | Specify... |
Client Authentication | The type of authentication an Integration Server client will use to connect to the Universal Messaging server. Choose one of the following options: None. Select this option if no authentication should be performed. This is the default. Username/Password. Select this option if the Universal Messaging server performs basic client authentication using user name/password combinations. If you select this option, specify the user name and password the client will use in the Username and Password fields. SSL. Select this option if Integration Server connects to a secure socket layer (SSL) port on Universal Messaging and you need to provide a certificate for one-way or two-way authentication. |
Truststore Alias | The alias for the truststore that contains the certificate authority (CA) certificates for the Universal Messaging server. You must select a truststore alias if the Universal Messaging port is configured for either one-way authentication or two-way authentication. |
Keystore Alias | The alias for the keystore that contains the client certificates that you want Integration Server to use when connecting to the Universal Messaging port. You must select a keystore alias if the Universal Messaging port is configured for two-way authentication. Note: | A Universal Messaging port is configured for two-way authentication if the port specifies nsps or nhps and the Enable Client Cert Validation option is selected for the port. Use Universal Messaging Enterprise Manager to view the Enable Client Cert Validation option specified for a port. |
|
Key Alias | The alias to the key that contains the private key for connecting to the Universal Messaging port securely. The key alias must be in the keystore specified in Keystore Alias. You must specify a Key Alias if you specify a Keystore Alias. |
9. Under Consumer Settings, do one of the following for the Enable Request/Reply Channel and Listener check box.
If you intend to use this
Universal Messaging connection alias to send request documents, send reply documents, or receive reply documents as part of a request/reply or publish-and-wait scenario, select the
Enable Request/Reply Channel and Listener check box. When this check box is selected,
Integration Server will do the following when the
Universal Messaging connection alias starts:
Create a request/reply channel for this
Universal Messaging connection alias if one does not yet exist. The request/reply channel name includes a string identifying the
Integration Server, the client prefix, and the text “RequestReply”.
Start a listener on
Integration Server that subscribes to the alias-specific request/reply channel.
If you do not intend to use this
Universal Messaging connection alias as part of a request/reply or publish-and-wait scenario, to conserve resources on
Integration Server and
Universal Messaging, clear the
Enable Request/Reply Channel and Listener check box.
10. Click Save Changes.
11. Enable the Universal Messaging connection alias.
