Contents
The Spotfire Streaming Acknowledge Operator for TIBCO FTL® allows a Streaming application to explicitly acknowledge received FTL messages. The operator is embedded in the Streaming application and has one input port and one output port. The input port is used to receive the message ID of the message to acknowledge. The output port emits status tuples.
The operator is configured through properties set in its Operator Properties view in StreamBase Studio, described below.
This operator requires access to the JAR file that implements the TIBCO FTL Java API
on your system, and any files referenced by that JAR file. The FTL adapter was tested
with FTL version 6.0, and is compatible with higher versions as well. To make the
TIBCO FTL Java API available to the adapter, you must supply a maven dependency for
it -- specifically, to FTL's ${FTL_HOME}/lib/tibftl.jar.
The tibftl.jar file, in turn, relies on various native
libraries such as tibftljni.dll on Windows and
tibftljni.so on Linux. As with tibftl.jar, these native libraries are supplied as part of your
TIBCO FTL installation and are not included in TIBCO Streaming. Make sure to edit
your src/main/configurations/engine.conf and make
changes to reflect your current setup, to include an externalNativeLibraryPath directive that points to your FTL
installation's ${FTL_HOME}/bin directory. Please see
the FTL sample application for an example configuration.
This section describes the properties you can set for this operator, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.
Adapter: A read-only field that shows the formal name of the adapter.
Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.
Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.
Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.
Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Description |
|---|---|
| Log Level | Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
| FTL Library Log Level | The log level used by the FTL library. Multiple FTL input and output operator instances share the most verbose level configured in any operator. |
Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.
Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.
Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.
Caution
Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.
There are two ways to explicitly acknowledge a received message from FTL: Either use
the TIBCO FTL Subscribing Operator's acknowledge command
or use an instance of the Acknowledge operator. In either case, a string field named
MessageID is expected to contain a valid message ID
value. Upon receiving the command the message will be acknowledged and a status tuple
will be emitted to indicate success or failure.
The TIBCO FTL Acknowledge Operator's ports are used as follows:
-
Control: This input port receives tuples used to acknowledge a given message. The Control port is expected to contain one string field named
MessageID. -
AckStatus: This output port emits status, information, and error tuples. The Status port has the following schema:
-
Status, string: Describes the type of event that occurred.
-
Time, timestamp: The time at which this status occurred.
-
info, list<tuple>: A list of name / value pair tuples containing any additional information for the event.
-
Add an instance of the operator to a new Streaming application as follows:
-
In StreamBase Studio, create a project, and create an EventFlow application file to host the operator.
-
Drag an instance of the TIBCO FTL Acknowledge Operator from the Operators and Adapters drawer in the Palette view to the canvas.
-
Connect an input streams to the operator's input port and an output stream to its output port.
-
Configure the schema of Control input stream with a string field named
MessageID.
The TIBCO FTL Acknowledge operator uses typecheck messages to help you configure the operator in your Streaming application. In particular, the operator generates typecheck errors when a required property has not been specified or the control input schema is missing a required field or it has the wrong data type.
The operator generates messages on the status port during runtime under various conditions, including:
-
An FTL message is acknowledged or the operation has failed.
-
The operator is suspended or resumed.
When suspended, the TIBCO FTL Acknowledge Operator stops processing acknowledge commands.
When resumed, the operator resumes processing acknowledge commands.