Integration Server 11.1 | Integration Server Administrator's Guide | Configuring Integration Server for Streaming | Streaming Connection Aliases | Creating a Streaming Connection Alias
 
Creating a Streaming Connection Alias
 
Monitoring the Connection to the Streaming Provider
A streaming connection alias contains the information that Integration Server needs to establish a connection to the streaming provider. Each Integration Server can have multiple streaming connection aliases.
Keep the following information in mind when creating a streaming connection alias:
*The WmStreaming package must be installed and enabled before you can create a streaming connection alias.
*The streaming provider must be installed and running before you can enable a streaming connection alias.
*The third party client libraries for the streaming provider must be installed on Integration Server before you can create a streaming connection alias. For more information, see Adding Apache Kafka Client Libraries to the Integration Server Classpath .
*The package in which you want to save the alias must already loaded and enabled on Integration Server.
*You can use a variable substitution for all or portions of the Provider URL, Client ID, and Configuration Properties where the variable can be a global variable or a system variable. For more information see Using Variable Substitution in Streaming Connection Alias Parameters.
*If you intend to use SASL to secure connections to the provider, SASL must be configured on the streaming provider.
*If you intend to use SSL to secure connections to the provider (either SSL or SASL_SSL), you must configure SSL capabilities on Integration Server and the streaming provider, specifically:
*Create a truststore that contains the trusted certificates for the Certificate Authority (CA) to use for communication with the streaming provider. Then create a truststore alias for the truststore. A truststore is required for one-way SSL as well as two-way (mutual) SSL.
*If the streaming provider requires two-way SSL, do the following:
*Create a keystore that contains the client certificates Integration Server provides to connect with the streaming provider server.
*Create a keystore alias for the keystore, making sure to specify a key alias for the private key and associated certificate used for connecting to the streaming provider securely.
*To create a streaming connection alias
1. Open Integration Server Administrator.
2. Go to Streaming > Provider settings.
3. Click Create Connection Alias.
4. Set the following General Settings for the streaming connection alias:
Field
Description
Connection Alias Base Name
Unique name for the streaming connection alias.
You cannot change the connection alias name after the alias is created.
To prevent naming conflicts when deploying configuration to other environments, Integration Server builds the Connection Alias Name by prefixing the provided base name with the selected package name. The streaming connection alias name must be a unique combination of the package name and the connection alias base name. The watt.server.streaming.connection.usePackagePrefix server configuration parameter controls whether the package name is included in the alias name.
Description
Description of the streaming connection alias.
Client Prefix
A string that identifies this Integration Serverfor the event triggers that use this streaming connection alias. Integration Server generates a connection client prefix automatically, but you can supply your own.
Integration Server uses the client prefix along with the event trigger name to form the client ID for the consumers created for a trigger. Integration Server creates a client ID for event triggers by appending the event trigger name to the client prefix. In Kafka, the client ID is known as the group ID.
Provider Type
The event streaming provider.
You cannot change the provider type after the alias is created.
Package
Package in which to save the streaming connection alias. Integration Server saves the connection alias configuration in this package. When you assign a streaming connection alias to a package, Integration Server enables and disables the alias in conjunction with the package. If you disable the package, Integration Server disables the connection alias automatically. A package retains its streaming connection alias when the package is published to other servers. If a subscriber installs the package, the streaming connection alias is created automatically on the subscriber's Integration Server.
Avoid saving the alias in a Wm* package because these are system packages. This avoids creating unnecessary dependencies among packages. Preferably, save streaming connection aliases in a custom package and create a package dependency from the custom package to the WmStreaming package.
You cannot change the package assigned to the alias after the alias is created.
5. Set the following provider configuration information in Connection Settings:
Field
Description
Provider URI
URL containing the protocol, domain, and port of the streaming provider.
Configuration Parameters
Key-value pairs for runtime configuration parameters. Place each pair on its own line. These parameters can be provider-specific or unique to Integration Server. For more information about configuration settings, see Streaming Configuration Parameters.
After saving a streaming connection alias, Integration Server Administrator displays the runtime configuration on the alias details page.
An event trigger passes any properties set in the Configuration Parameters field to the consumer. This means that event triggers using the same connection alias receive the property and value.
Note:
Integration Server automatically masks the value of a key-value pair if the key contains the word "password". When displayed, the value will show as [*****]. To update the protected value, simply overwrite the [*****] string with the new value. You can also use a global variable in place of the value. For more information about using global variables when defining a streaming connection alias, see Using Variable Substitution in Streaming Connection Alias Parameters
6. To configure security and authentication for the streaming connection, specify the following information under Security Settings:
Field
Description
Security Protocol
The security protocol and authentication protocol for the streaming connection. Select one of the following:
Option
Description
None
The connection will be unsecured. Authentication will not be required.
SSL
The connection will be secured with SSL. Authentication will not be required. The streaming provider must have SSL enabled.
SASL_SSL
The connection will be secured with SSL and authenticated with SASL. The streaming provider must have SASL authentication and SSL enabled.
Based on the SASL method configured on the streaming provider, you may need to pass in configuration information in the Configuration Parameters field.
SASL_PLAINTEXT
The connection will be unsecured and authenticated with SASL. The streaming provider must have SASL authentication enabled.
Based on the SASL method configured on the streaming provider, you may need to pass in configuration information in the Configuration Parameters field.
Truststore Alias
The alias for the truststore that contains the Certificate Authority (CA) certificate for the streaming provider. You must select a truststore alias when Security Protocol is set to SSL or SASL_SSL.
Keystore Alias
The alias for the keystore that contains the client certificate that Integration Server sends to the streaming provider during the mutual (two-way) SSL handshake. You need to select a keystore alias only when the port on the streaming provider is configured to use mutual (two-way) SSL.
Key Alias
The alias of the Integration Server private key and associated certificate that Integration Server sends to the streaming provider during the mutual (two-way) SSL handshake. The key alias must be in the keystore specified in Keystore Alias. You must specify a Key Alias if you specify a Keystore Alias.
7. Click Save Changes.
Integration Server Administrator displays an error if the streaming connection alias specifies a global variable that cannot be found.
8. After creating the connection, test it by clicking Right facing triangle on the Streaming > Provider settings page.
9. Enable the connection on the Streaming > Provider settings page.