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, and HTTP only) Specifies when to suppress the original behaviour of including _ns_ and _nm_ fields during serialization and deserialization. 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.

Configuration for TIBCO Rendezvous Destinations

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.

Configuration for JMS Destinations

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 No The acknowledgement mode. See JMS Message Acknowledgement Mode for a table explaining the various modes.

You can also set an acknowledgement mode in a node’s engine properties. The setting in the destination overrides the engine property setting.

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

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

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

Default is: %%EngineName%%:%%SessionName%%:%%ChannelURI%%:%%DestinationName%%

Configuration for Local Destinations

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:

-1  Waits indefinitely
 0  Does not wait
>0  Waits for the number of milliseconds specified

Default is -1.

Configuration for HTTP Destinations

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.

Configuration for StreamBase Destinations

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.