Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# 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 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 Variable | 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 that 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 Local
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. The configuration properties are displayed based on the Driver value. 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 Channel Configuration Properties Pulsar 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 Variable | 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 the PGM - Pragmatic General Multicast protocol. If using the 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. Any inappropriate values in the optional arguments could easily result in degraded performance of the product. So, the values of those optional arguments should be changed only when it is necessary and with care.
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 a Legacy ActiveSpaces Channel as a remote-discovery proxy. In this case, any remote client can connect to a 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: It 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: It 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 by a discovery node. 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 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 is in the security policy file.
PolicyFile | No | Absolute path to the policy file that 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 that is used by the 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 username 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 | Username 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 is specified in KeyFile.

## ActiveSpaces Channel Configuration Properties

ActiveSpaces Channel Properties
Field | Global Variable | 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 | The name of the data grid to which the ActiveSpaces channel connects.
Username | Yes | A valid username for the TIBCO FTL realm server.
Password | Yes | The password is assigned to the username specified in UserName, for accessing the TIBCO FTL realm server.
Use SSL | No | Check this box to use a 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 Variable | 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 username 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 is assigned to the username 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 Variable | Description
--- | --- | ---
ProviderURL | Yes | The URL at which TIBCO BusinessEvents can contact the Enterprise Message Service server. Example: `tcp://localhost:7222`
Username | Yes | A valid username for the Enterprise Message Service server.
Password | Yes | The password is assigned to the username 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. See TIBCO Enterprise Message Service documentation for more information about the `IsTransacted` property.
ClientID | Yes | The unique client ID of the connection.

## Kafka 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/).
Poll Previous Messages | Yes | Enables to consume the messages based on the value in `Polling Timestamp` when the checkbox is selected. The checkbox is not selected by default.
Polling Timestamp | Yes | The messages are consumed from the specified timestamp. The format of the timestamp is `YYYY-MM-DD HH:MM:SS`. The `Polling Timestamp` is editable when the `Poll Previous Messages` checkbox is selected.
Security Protocol | Yes | The security protocol is implemented in the Kafka broker. This protocol must match with the security protocol configured in the Kafka broker. For more details about how to configure security for a 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 a 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 the 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 resources, see Identity Resource Reference. Trust Store Password Password to access the trust store file.

## Pulsar Channel Configuration Properties

Pulsar Channel Properties
Field | Global Variable | Description
--- | --- | ---
Pulsar URL | Yes | The URL of the Pulsar broker service. The format of the URL is `pulsar://host:port` If there are multiple hosts, the URL format must be: `pulsar://host1:port,host2:port`
Pulsar Namespace | Yes | The namespace to be used with all destinations of this channel.
Connection Timeout (ms) | Yes | Duration to wait for a connection to a Pulsar broker to be established
Security Protocol | Yes | The security protocol is implemented in the Pulsar broker. This protocol must match with the security protocol configured in the Pulsar broker. For more details about how to configure security for Pulsar broker, refer to the Pulsar Documentation at https://pulsar.apache.org/docs/. You can select one of the following security protocol values: `PLAINTEXT`: No authentication or encryption mechanism is implemented for Pulsar communication. `mTLS:` For mTLS authentication, the server uses the trust certificate to verify that the client has a key pair that the certificate authority signed. `JWT`: Pulsar supports authenticating clients using security tokens based on JSON Web Tokens. `OAuth` 2: Pulsar supports authenticating clients using OAuth 2 access tokens. HTTP basic: Basic authentication is a simple authentication scheme built into the HTTP protocol, which uses base64-encoded username and password pairs as credentials. The default value is `PLAINTEXT`. See Setting Up Authentication for Pulsar for more information about setting up authentication.
Configure | NA | Click the Configure button to open the authentication configuration dialog. The following fields are available on the configuration window: If you select the mTLS protocol, the following fields are displayed: File Type Select the keystore format: PEM or JKS. Keystore File Location of the keystore file for the BusinessEvents application. Create Identity Resource for KeyStore file. For PEM extension, the file must be `client.cert.pem` and for a JKS file must be `client`.`keystore.jks`. Trust Store File Browse and select the Identity Resource that contains the information to authenticate BusinessEvents client identity. If not already present, first create an Identity Resource. In the Identity Resource, the Identity file must be `client.truststore.jks`. Client Key Certificate Location of the client certificate file in the `.pem` format. This is applicable for PEM file format. Create Identity Resource for key file. The file extension must be `client.key-pk8.pem`. CA Certificate Browse the CA certificate. A CA certificate is a digital certificate issued by a certificate authority (CA). A CA certificate is required if the File Type is PEM. If you select the JWT protocol, the following field is displayed: Authentication Token Specify the JSON Web Token for authentication. If you select the OAUTH 2 protocol, the following fields are available: Authentication Config File Provide a JSON configuration file path that includes type, client_id, client_secret, client_email, issuer_url parameter details, Issuer, and Audience URL. Issuer URL The URL of the authentication provider. An OAuth provider validates the request for a token for the given client ID and returns JWT as a response. Audience URL URL of the Resource server. Resource server is the server that hosts the protected resources. If you select the HTTP_BASIC protocol, the following fields are available: Authentication Identity The location of the identity shared resource file that contains the information to authenticate BusinessEvents client identity. For more information on identity resources, see Identity Resource Reference.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.