Field | Description |
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. |
Client Prefix Is Shared (prevents removal of shared messaging provider objects) | 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 Client Prefix Is Shared 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 Client Prefix Is Shared if the Integration Server: ![]() ![]() For more information about configuring Integration Servers to receive messages from Universal Messaging in a load-balanced fashion, see
Load Balancing with a Non-Clustered
Group of Integration Servers. ![]() |
Field | Description |
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 provide the appropriate certificates for use with the connection alias. You must provide a truststore alias or a truststore alias and keystore alias. 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. Software AG recommends using a comma-separated list of URLs if the alias uses 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 durable subscriptions 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. To use the Universal Messaging horizontal scalability feature with this messaging connection alias, enclose each realm URL or multiple realm URLs separated by commas in parenthesis. In a cluster, the realm URLs must be separated by a comma. ![]() ![]() ![]() ![]() |
If you disabled the follow the master behavior for producers and/or consumers using this alias, 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. ![]() ![]() For more information about the follow the master behavior including how to disable it, see
About Follow the Master for webMethods Messaging. | |
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. |
Field | Description |
Enable CSQ | Whether a client side queue is used with this Universal Messaging connection alias. Do one of the following: ![]() ![]() |
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. Do one of the following: ![]() ![]() |
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. |
Enable Follow the Master for Producers | Whether Integration Server always connects to the master realm server in a Universal Messaging cluster when Integration Server uses this Universal Messaging connection alias to publish messages. Do one of the following: ![]() ![]() When follow the master is disabled for producers, Integration Server connects to a server in a Universal Messaging cluster using the order dictated by the comma or semi-colon separated list of URLs in the Realm URL parameter. For more information about the follow the master behavior, see
About Follow the Master for webMethods Messaging. |
Field | Description |
Enable Request/Reply Channel and Listener | Whether 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. Do one of the following: ![]() ![]() When the Enable Request/Reply Channel and Listener check box is selected, Integration Server does the following when the Universal Messaging connection alias starts: ![]() ![]() |
Enable Follow the Master for Consumers | Whether Integration Server always connects to the master realm server in a Universal Messaging cluster when Integration Server uses this Universal Messaging connection alias to retrieve messages. Do one of the following: ![]() ![]() When follow the master is disabled for consumers that use this alias, Integration Server connects to a server in a Universal Messaging cluster using the order dictated by the comma or semi-colon separated list of URLs in the Realm URL parameter. For more information about the follow the master behavior, see
About Follow the Master for webMethods Messaging. |
Field | Description | |
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: ![]() Even if Universal Messaging does not perform client authentication, if the protocol specified for Realm URL is nsps or nhps, you must select a truststore alias in the Truststore Alias field. ![]() In addition to providing the username and password for client authentication, if the protocol specified for Realm URL is nsps or nhps, you must also select a truststore alias in the Truststore Alias field. ![]() Depending on how the Universal Messaging port is configured, you must specify a truststore alias and possibly a keystore alias and key alias for theUniversal Messaging connection alias. ![]() ![]() Note: Use Universal Messaging Enterprise Manager to view the protocol and Enable Client Cert Validation option specified for a port. | |
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 certificate-based authentication or if the protocol specified for Realm URL is nsps or nhps. | |
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 certificate based authentication. | |
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. |
Field | Description |
Logging Type | Specifies where Integration Server writes log messages when enhanced logging is enabled for the message producers and/or consumers that use this messaging connection alias to send and/or receive documents. ![]() ![]() You can select one of the options only. Integration Server cannot write enhanced logging messages to the server log and the messaging audit log. |
Enable Producer Message ID Tracking | Select to indicate that Integration Server writes additional log messages when a message producer uses this messaging connection alias to publish documents that are instances of the publishable document types listed in Producer Message ID Tracking: Include Channels. |
Producer Message ID Tracking: Include Channels | The name of each channel that corresponds to a publishable document type for which Integration Server performs additional logging during publication. Use a semicolon (;) to separate each channel name. Leave this field blank if you want Integration Server to perform enhanced logging for every channel to which this messaging connection alias sends messages |
Enable Consumer Message ID Tracking | Select to indicate that Integration Server writes additional log messages for messaging consumers (triggers) that use this messaging connection alias to receive messages. Integration Server writes additional log message for the triggers listed in Consumer Message ID Tracking: Include Triggers. |
Consumer Message ID Tracking: Include Triggers | The fully qualified name of the triggers for which Integration Server performs additional logging during trigger processing. Use a semicolon (;) to separate each trigger name. Leave this field blank if you want Integration Server to perform enhanced logging for every trigger that uses this messaging connection alias to receive messages. |