Destination Resource Reference
Within each channel, destinations direct the incoming and outgoing information. A channel resource is not ready for use until it has at least one destination.
- Destination Resource Common Properties
- HTTP Destination Configuration Properties
- ActiveSpaces 3.x Destination Configuration Properties
- TIBCO FTL Destination Configuration Properties
- JMS Destination Configuration Properties
- Kafka Destination Configuration Properties
- Kafka Streams Destination Configuration Properties
- Kinesis Destination Configuration Properties
- Local Destination Configuration Properties
- MQTT Destination Configuration Properties
- TIBCO Rendezvous Destination Configuration Properties
- StreamBase Destination Configuration Properties
- Destination Resource Common Properties
Destination Resource Common Properties
The Destinations section of a channel has the following fields.
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.
This field is optional if you specify an event type in the incoming message. The property is not used for the local channel. |
Serializer/ Deserializer | No | Specify a serializer class to convert messages to simple events and simple events to messages. |
Include Event Type | Yes |
(Only for HTTP, JMS, Kafka, Kafka Streams, and Rendezvous channels) 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:
|
HTTP Destination Configuration Properties
ActiveSpaces 3.x Destination Configuration Properties
Field | Global Var? | Description |
---|---|---|
Table Name | Yes | Name of the table to which the ActiveSpaces 3.x channel connects to |
Filter | Yes | String specified to evaluate rows and refine the set of rows to work. A filter string can be seen as what would follow the
where clause in a
select * from where statement.
See Filters for more information. |
Consumption Mode | No | Specifies the consumption mode for the ActiveSpaces event as one of: |
PutEvent | No | When selected, the Event Listener listens for any Put events on the table and invokes a callback function when such an event occurs. |
DeleteEvent | No | When selected, the Event Listener listens for any Delete events on the table and invokes a callback function when such an event occurs |
ExpireEvent | No | When selected, the Event Listener listens for any Expire events on the table and invokes a callback function when such an event occurs. |
TIBCO FTL Destination 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 } |
Durable Name | Yes | Durable name of the FTL subscriber |
JMS Destination Configuration Properties
See TIBCO Enterprise Message Service documentation for more detail on these settings.
Field | Global Var? | Description |
---|---|---|
Is JSON Payload | No | Specifies whether payload is JSON |
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:
You can also set a delivery mode in an event. |
AckMode | Yes | The acknowledgement mode. See
JMS Message Acknowledgement Modes for more details about 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. |
DurableSubscriberName | 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%%. |
SharedSubscriptionName | Yes | Specify the shared subscription name for the consumers. Among the consumers having the same
SharedSubscriptionName only one receive the message. Thus, an application can have multiple consumers performing a job, and these consumers can share the subscription without each one receiving the same copy of the message.
The shareable and durable nature of a subscription can be used in different combinations. The following are the possible combinations:
|
Kafka Destination Configuration Properties
Kafka Streams Destination Configuration Properties
The following table explains the Kafka Streams destination properties. For more conceptual information about each property, see the Kafka Streams documentation.
Field | Global Variable? | Description |
---|---|---|
Topic Name | Yes | Required. Name of the Kafka topic. |
Is Regex Pattern | No | A toggle to denote if the Topic Name is a regex pattern. |
Application ID | Yes | Required. A unique ID for the stream processing application. The same ID must be given to all instances of the application. Each destination must have a unique ID which is used by Kafka Streams to create internal topics. |
Key Serde | Yes | Specify the SerDes (Serializer/Deserializer) for the data types of record keys.
Accepted Values: |
Value Serde | Yes | Specify the SerDes (Serializer/Deserializer) for the data types of record values. You can select either of the following SerDes for record values of the destination:
Accepted Values: |
Auto Offset Reset | Yes | Specify the strategy for resetting the offset of the topic in Kafka in case the current offset does not exist anymore on the server. The values are: |
Processing Guarantee | Yes | Specify the processing guarantee strategy to be used for processing each record of the Kafka Stream. The following processing guarantee strategies are available: |
Processor Topology | No | Define the processor topology for the stream coming to the destination. Add the transformations (stream processors) in the same sequence as you want to process the stream. So, the output of the transformation of a row is input to the row below it. The output of the last row transformation is sent to a TIBCO BusinessEvents Foreach processor which creates an event by using the provided serializer. The top row transformation is the source processor and the Foreach processor is the sink processor of Kafka Streams. For more information on stream processor topology and stream processors, see the
Kafka Streams documentation.
Click Add to view the list of transformations that you can add to your processor topology. Select the transformation and provide input to it as required and click OK. You can provide rule functions as input to the transformations where the rule functions contains the stream processor code for the transformation. The Add Transformation window lists only eligible transformations that can be added in the processor topology based on the existing transformations. For example, if you have added a GroupByKey transformation, the Add Transformation window lists only Aggregate, Count, and Reduce transformations. For list of available transformations for the Kafka Streams channel, see Kafka Streams Transformations in TIBCO BusinessEvents. |
Transformation | Required Input | TIBCO BusinessEvents Resource |
---|---|---|
Filter, FilterNot | Predicate | boolean rulefunction(Object, Object) |
MapValues, FlatMapValues | ValueMapper | Object rulefunction(Object, Object) |
ValueMapperWithKey | Object rulefunction(Object) | |
GroupByKey | None | |
SelectKey | KeyValueMapper | Object rulefunction(Object, Object) |
Aggregate | Initializer | Object rulefunction() |
Aggregator | Object rulefunction(Object, Object, Object) | |
Count | None | |
Reduce | Reducer | Object rulefunction(Object, Object) |
ToStream | None | |
Join, LeftJoin, OuterJoin | Topic | String Literal or Global Variable(String) |
ValueJoiner | Object rulefunction(Object, Object) | |
JoinWindows(Time Difference, After, Before, Grace) Durations | Positive Number or Global Variable(Integer) |
Kinesis Destination Configuration Properties
Field | Global Variable? | Description |
---|---|---|
Stream Name | Yes | Name of the stream to which the producer sends data and from which the consumer consumes data. |
Application Name | Yes | Name of the Amazon Kinesis Data Stream application. |
Max Records | Yes | The maximum number of records to be returned from the stream when processing the records from the Kinesis consumer. |
Region Name | Yes |
Name of the region where the Amazon Kinesis data stream application is deployed. For example, us-west-2 |
Event Property | No | Select an event property that BusinessEvents uses as a partition key for Kinesis. |
Local Destination Configuration Properties
Local destinations do not use serializers, deserializers, or default events.
MQTT Destination Configuration Properties
TIBCO Rendezvous Destination Configuration Properties
See the TIBCO Rendezvous documentation for more details about these settings.
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. |