Destination Resource Reference

Within each channel, destinations direct incoming and outgoing information. A channel resource is not ready to use until it has at least one destination.

The Destinations section of a channel has the following fields.

Destination Resource Common Properties
Field Global Var? Description
Name No 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.
Default Event No The event to be created from incoming messages unless otherwise specified. For convenience, you can open the selected event resource by clicking the underlined label.

Optional, but only if you always specify an event type in the incoming message.

Not used for local channel.

Serializer/
Deserializer No Specify a serializer class to convert messages to simple events and simple events to messages.
Include Event Type Yes (Rendezvous, JMS, Kafka, and HTTP only) Specifies when to suppress the original behavior of including _ns_ and _nm_ fields during serialization and deserialization. For more details on _ns_ and _nm_ fields, see Mapping Incoming Messages to Non-default Events.
The values are:
  • When Serializing and Deserializing: always include _ns_ and _nm_ fields.
  • Only when Serializing: for outgoing JMS messages _ns_ and _nm_ fields are set in the JMS message headers. For incoming JMS messages _ns_ and _nm_ fields are ignored.
  • Only when Deserializing: the _ns_ and _nm_ fields are suppressed in the outgoing message but are used in incoming messages.
  • Never: the _ns_ and _nm_ fields are suppressed in incoming as well as outgoing messages.

TIBCO Rendezvous Destinations Configuration Properties

See TIBCO Rendezvous documentation for more details on these settings.

TIBCO Rendezvous Destinations Configuration Properties
Field Global Var? Description
Subject Yes The TIBCO Rendezvous subject for incoming and outgoing messages.
RVCM Pre Registration Yes For TIBCO Rendezvous certified message publishers, specify pre-registered listener names as a comma separated list.
LimitPolicy Yes How you want the Rendezvous listener to behave when it receives more messages than the MaxEvents limit. Choose one of:

Discard_None (default)

Discard_First

Discard_Last

Discard_New

When MaxEvents or DiscardAmount are zero (unlimited), the LimitPolicy must be Discard_None.

MaxEvents No Maximum number of message events that the queue can hold.

The default value, zero (0), means an unlimited number of events.

DiscardAmount No The number of events to discard when the queue exceeds its maximum event limit.

The default value, zero (0) means events are never discarded.

JMS Destinations Configuration Properties

See TIBCO Enterprise Message Service documentation for more detail on these settings.

JMS Destinations Configuration Properties
Field Global Var? Description
Queue Yes Specifies whether the destination is a queue or a topic. Select the check box if the destination is a queue. If the destination is a topic, do not select it.
Name Yes Required. The name of the queue or topic.

TIBCO BusinessEvents ignores JMS destinations with null or empty-string queue or topic names. It logs an error message for the ignored destinations. If a JMS message is sent out through an ignored destination, TIBCO BusinessEvents throws an exception and the message is not sent out. TIBCO BusinessEvents also does not receive JMS messages (events) through these ignored destinations.

Selector Yes Specifies a filter to pick up messages from the destination. This is a standard JMS selector based on SQL92 semantics.
DeliveryMode No The delivery mode property instructs the server concerning persistent storage for the message. Select one of the following:
  • PERSISTENT (default) — In JMS message headers this is represented by the code 2.
  • NON-PERSISTENT — In JMS message headers this is represented by the code 1.
  • RELIABLE — This value is an extension to the standard, used in TIBCO Enterprise Message Service. In message headers this is represented by the code 22.

You can also set a delivery mode in an event.

AckMode Yes The acknowledgement mode. See JMS Message Acknowledgement Modes for more details on the various modes.

The default value is EXPLICIT_CLIENT_ACKNOWLEDGE.

Priority No The message priority. Takes a numerical value between 0 and 9. Larger numbers represent higher priority.

You can also set a priority in an event.

The default value is 4.

TTL Yes The length of time that the message will live (in milliseconds) before expiration. If set to 0, the message does not expire.

You can also set a TTL (JMSExpiration) in an event.

The default value is 0.

Durable Subscriber Name Yes For destinations that are JMS Topics, if you provide a DurableSubscriber Name, the destination becomes a JMS durable topic subscriber with the specified name. If you do not provide a value, the destination becomes a non-durable topic subscriber.

The value of this property can be any unique string and can include any global variables. TIBCO BusinessEvents provides a set of case-sensitive variables that produce a unique DurableSubscriberName string.

The default value is: %%EngineName%%:%%SessionName%%:%%ChannelURI%%:%%DestinationName%%.

Local Destinations Configuration Properties

Local destinations do not use serializers, deserializers, or default events.

Local Destinations Configuration Properties
Field Global Var? Description
Size No The maximum number of events to be held in the queue. The default is zero (0), which allows unlimited events in the queue.
TimeOut No Time to wait when sending an event to this local destination. The values are:
  • -1 - Waits indefinitely
  • 0 - Does not wait
  • >0 - Waits for the specified number of milliseconds





The default value is -1.

HTTP Destinations Configuration Properties

HTTP Destinations Configuration Properties
Field Global Var? Description
Is JSON Payload No Specifies whether payload is JSON
Is Page Flow No Enables Action Rule Function based approach. If selected, the system disables the Default Event and Serializer/Deserializer fields for input.
ContextPath No Context URI for the web application. The field is active for input if the Is Page Flow check box is selected.
Action Rule Function No The Action Rule function to be executed when an HTTP message arrives at the context URI for the web application. The field is active for input if the Is Page Flow check box is selected.

StreamBase Destinations Configuration Properties

StreamBase Destinations Configuration Properties
Field Global Var? Description
Stream Name No The name of the input or output stream from the StreamBase application
Client Type No Specifies whether the connection is used as an input (dequeue) client or an output (enqueue) client. The values are:
  • Dequeuer
  • Enqueuer
Filter Predicate No A StreamBase expression that is used to filter the incoming messages. For instance, BidPrice > 100.

This field is active only if Client Type is Dequeuer.

Enable Buffering No Specifies whether to activate buffering for an enqueue client. Activating buffering can improve performance when there are a large number of enqueue operations.

This field is active only ifClient Type is Enqueuer.

Buffer Size No The number of tuples to buffer before the enqueue operation.

This field is active only if Enable Buffering is selected.

Flush Interval (ms) No Time interval (in milliseconds) to wait before flushing the enqueue buffer.

This field is active only if Enable Buffering is selected.

Kafka Destinations Configuration Properties

Kafka Channel Destination Configuration Properties
Field Global Var? Description
Topic Name Yes Name of the Kafka topic.
Group ID Yes A unique ID that identifies the consumer group that this consumer belongs to. Assign the same Group ID to the consumers that you need to logically group in the same consumer group.
Client ID Yes A unique ID for the consumer to identify the source of request. If not specified, BusinessEvents auto generates an unique Client ID.

The best practice is to leave it blank, so that BusinessEvents generates the unique ID automatically.

Consumer Threads Yes Number of Kafka consumer threads that BusinessEvents creates for the destination.
Heartbeat Interval (msec) Yes Specifies the time interval in milliseconds in which destination sends heartbeat messages to broker. Heartbeats are used to ensure that the worker's session stays active and to facilitate re-balancing when new members join or leave the group. The value must be set lower than Session Timeout.

The best practice is to set it to one-third or lower of the Session Timeout value.

Session Timeout (msec) Yes Specifies the time interval in milliseconds which is used to detect worker failures. The worker sends the heartbeat messages in Heartbeat Interval to indicate their liveliness to the broker. If no heartbeat messages are received by the broker before the expiration of the Session Timeout, then the broker removes the worker from the group and initiate a re-balance.
Enable AutoCommit Yes Specifies if the offsets are auto committed or not.

If checked (default), the consumer's offset is committed automatically in the time interval specified in AutoCommit Interval.

If unchecked, the message is acknowledged when the RTC cycle completes or when Event.consumeEvent is called. This works only with "Caller's Thread" threading model type.

AutoCommit Interval (msec) Yes When Enable AutoCommit is checked, this field identifies the frequency in milliseconds that the consumer offsets are auto-acknowledged to Kafka.
Sync Sender Yes When checked, BusinessEvents waits for the message to be actually sent, instead of relying on the Kafka client library to send it asynchronously and assuming sent.
Sync Sender Max Wait (msec) Yes When Sync Sender is checked, this field identifies the maximum duration in milliseconds to wait for a send call to complete. If the client fails to send a message within this limit an exception is thrown and sendEvent() returns NULL.
Compression Type Yes Specifies the compression type for messages being sent for the destination. The valid values are:
  • GZIP
  • Snappy
  • LZ4
  • None (default)
Send Message Key (RuleFunction) Yes This determines the Kafka partition to which the message is routed. Messages with same keys will be routed to same partitions. Click Browse and select the RuleFunction that is used to compute the keys for the messages that are sent using this destination. The RuleFunction must have the expected Event in scope as the only parameter, and return a String value for the message key. When a RuleFunction URI is not specified, BusinessEvents sends message without key, in which case the message is routed to a partition as determined by Kafka.

Configuration for FTL Destinations

FTL Destinations Configuration Properties
Field Global Var? Description
Application Name Yes The name of the application that communicates using TIBCO FTL software.
Endpoint Name Yes Name of endpoint for the application.
Instance Name Yes Name of the application instance.

The default value is default.

Format Name Yes The format name defined in the TIBCO FTL software.
Content Matcher No The query clause to filter messages.
The syntax of the query is as follows:
{"FIELD_NAME1" : FIELD_VALUE1, "FIELD_NAME2" : FIELD_VALUE2 }