Channel Resource Reference

Channels allow TIBCO BusinessEvents to listen to and send out messages. Channels contain destinations.

You can configure channels of different types, using the appropriate driver. See TIBCO BusinessEvents Architect’s Guide.

To configure an HTTP channel resource, select an HTTP connection resource. No other channel resource fields require configuration.

Note: Local channels are in memory; information in a local channel could be lost if the TIBCO BusinessEvents engine fails.

Channel Configuration Reference
Field	Global Var?	Description
Name	No	(Shown in the Wizard and then in the editor title only.) The name to appear as the label for the resource. Names follow Java variable naming restrictions. Do not use any reserved words.
Description	No	Short description of the resource.
Driver	No	Displays the type of the channel you are configuring. You can change the channel type only if there are no destinations defined in the channel. The following are the available channel types: Legacy ActiveSpaces ActiveSpaces FTL Hawk HTTP JMS Kafka Kafka Streams Kinesis Local MQTT Rendezvous StreamBase
Method of Configuration	No	Select the method that you want to use for channel configuration. You can either configure the channel properties directly or use a shared resource. Properties - Select Properties to configure the channel resource using properties. Based on the Driver value, the configuration properties are displayed. See the following sections for the configuration of different channel types: Legacy ActiveSpaces Channel Configuration Properties ActiveSpaces Channel Configuration Properties FTL Channel Configuration Properties JMS Channel Configuration Properties Kafka and Kafka Streams Channel Configuration Properties Kinesis Channel Configuration Properties MQTT Channel Configuration Properties TIBCO Rendezvous Channel Configuration Properties StreamBase Channel Configuration Properties Resource - Select Resource if you have a shared resource in your project whose properties you want to reuse for this channel. See Adding a Shared Resource.
Resource	No	If you choose Resource as the method of configuration, the Resource field appears. Browse to and select the resource you want to use. For convenience, you can open the selected resource by clicking the underlined label. Note: The path to the resource and the resource name cannot contain any of the words listed in Keywords and Other Reserved Words.

Legacy ActiveSpaces Channel Configuration Properties

Legacy ActiveSpaces Channel Properties
Field	Global Var?	Description
Metaspace Name	No	The name of a particular metaspace instance in Legacy ActiveSpaces that the channel must connect to. The metaspace must be created and initialized before the channel can use it at run time.
Discovery URL	No	Specifies how a metaspace instance discovers the current metaspace members. Multicast discovery can use either PGM - Pragmatic General Multicast or RV - TIBCO Rendezvous protocol. If using PGM protocol, the multicast URL is expressed in the following format: `tibpgm://``destination port``/``interface``;``discovery group address``/``optional transport arguments`, where `destination port` specifies the destination port used by the PGM transport. If not specified, the default value of 7888 is used. `interface``;``discovery group address` specifies the address of the interface to be used for sending discovery packets, and the discovery group address to be used. If not specified, it defaults to the default interface and discovery address, 0.0.0.0;239.8.8.8. `optional transport arguments` specifies a semicolon-separated list of optional PGM transport arguments. By default, the PGM transport is tuned to provide the best performance according to the most common deployment architectures. The values of those optional arguments should be changed only when necessary and with care, since any inappropriate values could easily result in degraded performance of the product. If using TIBCO Rendezvous, the multicast URL is expressed in the following format: `tibrv://``service``/``network``/``daemon`, where `service` specifies the TIBCO Rendezvous service number (UDP port) that will be used. If not specified, the value defaults to 7889. `network` specifies the interface and discovery group address that will be used to send Rendezvous discovery packets. The format is: interface; discovery_group_address If not specified, the default interface and discovery group address will be used. (`tibrv://7889/;239.8.8.9/`). `daemon` specifies where to find the Rendezvous daemon. If not specified, it will try to connect to a local daemon on port 7500.
ListenUrl	No	The discovery mechanism is based on pure TCP. All the designated well-known metaspace members are identified by an IP address and a port number. This address and port are specified by the member’s Listen URL. If not specified, the discovery process uses the default IP address and the first free TCP port that can be acquired from the operating system (starting 5000 and above).
RemoteListenUrl	No	This field is used to configure Legacy ActiveSpaces Channel as a remote-discovery proxy. In this case, any remote client can connect to an Legacy ActiveSpaces metaspace through the Legacy ActiveSpaces Channel node.
EnableSecurity	No	Enables security for the Legacy ActiveSpaces channel when selected. Note: Some fields are activated only for the specific security role or authorization policy.
SecurityRole	No	Security role of a node for the secure Legacy ActiveSpaces channel in the metaspace. The values are: Controller is dedicated to enforcing a security domain's defined security behavior for a metaspace associated with the security domain. Security domain controllers are the only discovery nodes in a metaspace. Requestor just requires access to the data in the data grid, such as a seeder or a leech, and which need to be authorized by a controller. Requesters can never be used a discovery nodes. The controller nodes are configured with a security policy file. The requester nodes provide a token file and additional credentials to the controller for authentication. The controller performs authentication as defined in its policy file and using the credentials provided by the requester. If the Controller option is selected, then the following fields become active: Identity Password PolicyFile If the Requestor option is selected, then the following fields become active: Identity Password TokenFile Credential
Identity Password	No	The password for the identity key in the security policy file.
PolicyFile	No	Absolute path to the policy file which contains the security settings that the controller node enforces. It is generated using the as-admin utility.
TokenFile	No	Absolute path to the token file which is used by requestor to connect to a metaspace whose security is defined in the policy file.
Credential	No	Authentication policy to be used for authentication as specified in the policy file. The values are: USERPWD - A user name and password based authentication is used. It activates the following fields: Domain Username Password X509V3 - The authentication source is an LDAP configured with certificate based authentication. It activates the following fields: KeyFile PrivateKey
Domain	No	Domain name for system based user authentication.
Username	No	User name for LDAP and system based authentication.
Password	No	Password for LDAP and system based authentication.
KeyFile	No	The absolute path for a file containing the key to use for LDAP with the certificate based authentication.
PrivateKey	No	The password for the identity key in the LDAP identity file specified in KeyFile

ActiveSpaces Channel Configuration Properties

ActiveSpaces Channel Properties
Field	Global Var?	Description
Realm Server URL	Yes	The URL at which the TIBCO BusinessEvents can connect to the TIBCO FTL realm server. Default URL: http://localhost:8080
Grid Name	Yes	Name of the data grid to which the ActiveSpaces channel connects
User Name	Yes	A valid user name for the TIBCO FTL realm server
Password	Yes	The password assigned to the user name specified in UserName, for accessing the TIBCO FTL realm server
Use SSL	No	Check this box if you want to use secure socket layer (SSL) protocol while connecting to the TIBCO FTL realm server. If checked, the Trust Type and Identity fields are activated
Trust Type	Yes	Specifies whether you want to use a trust file for SSL authentication
Identity	No	The Identity field is activated if you have selected the Trust File option in the Trust Type dropdown. Browse to select the trust file from your system.

FTL Channel Configuration Properties

FTL Channel Properties
Field	Global Var?	Description
RealmServer	Yes	The URL at which BusinessEvents can connect to the FTL realm server. The default value is: http://localhost:8080
UserName	Yes	A valid user name for the FTL realm server. Note: This field is required only when the basic authentication is enabled at the realm server.
Password	Yes	The password assigned to the user name specified in UserName, for accessing the FTL realm server. Note: This field is required only when the basic authentication is enabled at the realm server.

JMS Channel Configuration Properties

JMS Channel Properties
Field	Global Var?	Description
ProviderURL	Yes	The URL at which TIBCO BusinessEvents can contact the Enterprise Message Service server. Example: `tcp://localhost:7222`
UserName	Yes	A valid user name for the Enterprise Message Service server.
Password	Yes	The password assigned to the user name specified in UserName, for accessing the Enterprise Message Service server.
IsTransacted	Yes	Accepts `true` or `false`. Specify `true` if the session has transaction semantics. Specify `false` if it has non-transaction semantics. For more information about the `IsTransacted` property, see TIBCO Enterprise Message Service documentation.
ClientID	Yes	The unique client ID of the connection.

Kafka and Kafka Streams Channel Configuration Properties

Kafka Channel Properties
Field	Global Variable?	Description
Kafka Broker URLs	Yes	List of URLs (host and port pairs) that are used for establishing the initial connection to the Kafka cluster. The format of the URL is `host1:port1,host:port2,...`. For more details refer to the setting bootstrap servers topic in the Kafka Documentation (https://kafka.apache.org/documentation/).
Security Protocol	Yes	The security protocol is implemented in the Kafka broker. This protocol must match with security protocol configured in the Kafka broker. For more details about how to configure security for Kafka broker, refer to the Kafka Documentation at https://kafka.apache.org/documentation/#security. You can select the following security protocol values: `PLAINTEXT` - No authentication or encryption mechanism is implemented for Kafka communication. `SASL_PLAINTEXT` - SASL authentication is implemented without SSL for Kafka communication. `SSL` - SSL based connection between Kafka clients and brokers. `SASL_SSL` - SASL authentication is implemented with SSL for Kafka communication. The default value is `PLAINTEXT`.
SASL Mechanism	Yes	Type of SASL mechanism is implemented on Kafka broker. This field is active only for `SASL_PLAINTEXT` and `SASL_SSL` security protocol. The following SASL mechanisms are supported for the Kafka channel: `GSSAPI` (Kerberos) `PLAIN` `SCRAM-SHA-256` `SCRAM-SHA-512`
Configure SSL	N/A	Click the Configure SSL button to open the SSL configuration window and configure SSL details. This button is active only for `SSL` and `SASL_SSL` security protocol. The following fields are available on the SSL configuration window: Trusted Certificates Folder Location of the trusted certificates on client machine. The trusted certificates are a collection of certificates from servers with whom you establish connections. If the server you wish to establish a connection with, presents a certificate that does not match one of your trusted certificates, the connection is refused. Trusted certificates must be imported into a folder, and then you can select the folder in this field. Identity The location of the identity shared resource file that contains the information to authenticate BusinessEvents client identity. For more information on identity resource, see Identity Resource Reference. Trust Store Password Password to access the trust store file.

Kinesis Channel Configuration Properties

Kinesis Channel Properties
Field	Global Variable?	Description
Access Key	No	Key used in combination with the Secret Key to make programmatic requests to AWS. For example, AKIAIOSFODNN7EXAMPLE The access key is similar to a user name used in a username-password pair.
Secret Key	No	Key used in combination with the access key to make programmatic requests to AWS. For example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY The access key is similar to the user name used in a user name-password pair.
Profile Name	No	You can store frequently used credentials and configuration settings in files. These files are divided into sections that are referenced by name. These sections are called profiles. Enter the profile name that contains the credentials and configuration settings that you want to use.

MQTT Channel Configuration Properties

MQTT Channel Properties
Field	Global Var?	Description
MQTT Broker URLs	Yes	Address of the broker that the clients connect to. Supported connection types: TCP connection (tcp://), for example, tcp://localhost:1883 TCP connection secured by SSL/TLS (ssl://), for example, ssl://localhost:8883.
UserName	Yes	Used as the client user name for the connection.
Password	Yes	Used as the client password for the connection.

TIBCO Rendezvous Channel Configuration Properties

TIBCO Rendezvous channel has been deprecated and might be removed in the future release.

TIBCO Rendezvous Channel Properties
Field	Global Var?	Description
Service	Yes	The name of the service or port number through which Rendezvous sends messages. In most cases you can leave this field empty, accepting the default value. For more information about the Rendezvous service parameter, see TIBCO Rendezvous Concepts or TIBCO Rendezvous Administration. Default is 7500 (defined in Global Variables).
Network	Yes	The network over which Rendezvous sends messages. In most cases you can leave this field empty. For more information about the network parameter, see TIBCO Rendezvous Administration. Default is an empty string (defined in Global Variables).
Daemon	Yes	The location of the Rendezvous daemon, which is usually expressed as a client socket number, for example 6555. In most cases, you can leave this field empty, accepting the default value. For more information about the daemon parameter, see TIBCO Rendezvous Concepts. Default is `tcp:7500` (defined in Global Variables).

StreamBase Channel Configuration Properties

StreamBase Channel Properties
Field	Global Var?	Description
StreamBase Server URI	Yes	The URI at which TIBCO BusinessEvents can contact the StreamBase server Example: `sb://localhost:10000/`
UserName	Yes	A valid user name for the StreamBase server. Note: This field is required only when the basic authentication is enabled at the StreamBase server.
Password	Yes	The password assigned to the user name specified in UserName, for accessing the StreamBase server. Note: This field is required only when the basic authentication is enabled at the StreamBase server.
SSL Trust Store File	Yes	Location of the truststore file.
SSL Trust Store Password	Yes	Password to access the truststore file.
SSL Key Store File	Yes	Location of the keystore file.
SSL Key Store Password	Yes	Password to access the keystore file.
SSL Key Password	Yes	Password to access the key in the keystore file.