Creating a Broker Connection Alias
A Broker connection alias is a webMethods messaging connection alias that contains the configuration information for establishing a connection to the Broker. Each Integration Server can have only one Broker connection alias.
If Broker is installed in the same installation directory as Integration Server, Integration Server creates a Broker connection alias named IS_BROKER_CONNECTION. Or, if you migrated to Integration Server 9.5 SP1 or later from an earlier version of Integration Server, and the earlier Integration Server configured a connection to Broker, the existing Broker configuration information is used for the IS_BROKER_CONNECTION alias. If this alias exists, you must delete it before you create another Broker connection alias. Alternatively, you can edit IS_BROKER_CONNECTION to contain the configuration information that you want.
To create a Broker 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 Broker connection alias.
If a Broker connection alias already exists, Integration Server Administrator displays a message stating that only one Broker connection alias can exist at a time.
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 Broker. The Broker Manager displays this prefix for each client it creates for the server. (The Broker creates multiple clients for each server that connects to it.) |
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 the Broker. Leave the Client Prefix Is Shared check box cleared if you do not want to prevent automatic updates to shared objects on the Broker. When the Client Prefix Is Shared check box is selected, you must update objects on the Broker manually. For example, if you delete a trigger on Integration Server you need to manually delete the associated client queue on the Broker. You must select Client Prefix Is Shared if the Integration Server:  Belongs to a cluster and you want to prevent automatic updates to shared objects associated with this alias on the Broker. 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 Broker. |
6. Under Connection Settings, specify the following:
For this parameter... | Specify... |
Broker Host | Name (DNSname: port or ipaddress: port) of the machine on which the Broker Server resides. |
Broker Name | Name of the Broker as defined on the Broker Server. The default name is Broker #1. |
Client Group | Broker client group to which this Integration Server belongs. A client group defines a single set of properties and access permissions assigned to one or more clients (here, Integration Servers) on a single Broker. If the specified client group does not exist, the Integration Server creates it on the named Broker upon establishing its initial connection. Important: | Brokers do not share can-publish and can-subscribe permissions across client groups. If you switch an Integration Server from one client group to another, you must restart the Integration Server and synchronize all publishable document types with the Broker. Next, you must shut down the server and use My webMethods to delete all of the Broker clients created for the server with the changed client group. Restart the server with the changed client group. |
|
7. 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 Broker. Choose one of the following options: None. Select this option if the Broker is configured to accept anonymous connections. Username/Password. Select this option if the Broker uses basic client authentication. 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 the Broker using the SSL port. If you select this option, configure the SSL parameters by providing the following information. |
| Parameter... | Specify... |
| Keystore | The full path to the keystore file for this Integration Server. A keystore file contains the credentials (private key/signed certificate) that an entity needs for SSL authentication. If the Broker Server requires an SSL connection, then the information in this file is used to authenticate the Integration Server client to that Broker Server. The keystore file for an Integration Server is stored on the machine on which the Integration Server resides. |
| Keystore Type | The file type of the keystore file for Integration Server. The file type can be either PKCS12 or JKS. |
| Keystore Password | Password required to access the SSL certificate in the keystore file for Integration Server. |
8. Under Encryption Settings, specify the following:
For this parameter... | Specify... | |
Encryption | Specify whether or not to encrypt the connection between the Integration Server and the Broker. Note: | When you set Client Authentication to SSL, Encryption must be set to Yes. |
If you select Yes for the Encryption parameter, configure the following truststore parameters. |
| Parameter... | Specify... |
| Truststore | The full path to the truststore file for the Integration Server client. A truststore file contains trusted root certificates for the authorities responsible for signing SSL certificates. For an SSL connection to be made, a valid trusted root for the SSL certificate stored in the keystore must be accessible in a truststore file. The truststore file for Integration Server is stored on the machine on which the Integration Server resides. |
| Truststore Type | The file type of the truststore file for Integration Server. The file type is JKS. |
9. Click Save Changes.
Integration Server creates the Broker connection alias.
10. Click Return to webMethods Messaging Settings.
11. Enable the Broker connection alias.
12. Restart Integration Server.
For more information about Broker and configuring SSL for Broker, see Administering webMethods Broker.
Note: | You can configure the outbound document store, also known as the client side queue, to contain documents published when the Broker used by this connection alias is not available. For more information, see About the Outbound Document Store |
