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. |
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 |
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. |