FTL GetMessage

FTL GetMesage is a synchronous activity that gets a message from the persistent store through a TIBCO FTL application endpoint. The transport details are not configured in the FTL GetMessage activity, instead it is configured in TIBCO FTL Realm Server.

Note: This activity requires the use of shared durables (static or dynamic). Application endpoints used should be associated to a store and should make use of shared durables. More information about using durables in FTL is available in the FTL documentation.
Important:
  • This activity only works with shared durables. Do not use other kind of durables.
  • Prefetch count for shared durables should be set to 1 in the prefetch settings for shared durables. Failure to do so results in loss of some messages.

General

The General tab has the following fields.

Field Literal Value/Module Property Description
Name No The name to be displayed as label of the activity in the application.
FTL Realm Server Connection Yes The shared resource containing information for connecting to TIBCO FTL Realm Server and creating a Realm object. See FTL Realm Server Connection for more details.
Endpoint Yes TIBCO FTL application endpoint which is an abstraction for the underlying transports on which the FTL Publisher activity sends messages. The endpoint can have more than one transport.

Click the Browse button to locate the endpoints defined on the TIBCO FTL Realm Server.

Content Matcher Yes

Specifies FTL GetMessage activity's interest in messages based on their content. The syntax for example is, {"My-Long":123} . A content matcher selects a subset of messages from a message stream according to the fields and values in those messages.

Durable Name Yes Specifies the existing durable name for static shared durables or new name that will enable the FTL GetMessage to dynamically create a durable listener.
Format No Defines the set of fields in the message that is sent by the FTL GetMessage activity. The form of each FTL message (its field names and their value datatypes) is governed by a format. The supported formats are:
  • Custom: can be defined by using the Input Editor. The Input Editor is enabled only for the Custom format option.
  • Keyed Opaque: is a built-in format that contains a text key field and a binary (opaque) data field.
  • Opaque: is a built-in format that contains a binary (opaque) data field.
  • Predefined: is already defined in the TIBCO FTL Realm Server for the FTL application. The Predefined format requires a format name and this can be obtained from the TIBCO FTL Realm Server using the Browse button.
Format Name Yes The name of the format of the FTL GetMessage.

In addition, selecting the Predefined format enables the Browse button. Click Browse to obtain the predefined formats from the TIBCO FTL Realm Server.

Description

Provide a short description of the activity here.

Advanced

Field Literal Value/Module Property Description
Subscriber Name Yes
Specify the name of the subscriber on the TIBCO FTL Realm Server.
Note:

Optional for dynamic durables.

Required for static durables- mapping from each subscriber name to a durable name should be configured on the realm server.

Timeout (msec) Yes The amount of time FTL Get Message activity waits to get the message from the persistent store. Default value is set to 100 msec.
Retry Duration Yes This field specifies the retry duration for reconnecting to a persistent server.

The value is in seconds.

When the persistent server does not get accessed (because of network failure or quorum unavailability), retrying to connect to the server can be configured with this field. The value of this property determines the retry behavior. The supported values are:
  • 0: No retry. This call raises an exception. This is the default behavior.
  • 1: Synchronously retry the interaction until it succeeds. This call returns only upon success.
  • n (Any positive double value): Retry the interaction for n seconds. Return upon success or raise an exception after timeout.

Input

Field Type Description
Timeout String The amount of time FTL Get Message activity waits to get the message from the persistent store. Default value is set to 100 msec. This value can be configured either in the Advanced tab or the input section. The value set in Input tab will override any value set in Advanced tab for timeout.

Output Editor

The Output Editor tab defines the schema to use for incoming messages. This tab gets enabled only when you select the Custom format.

Output

The output for the activity depends on the Format you select in the General tab. If you select the Custom format, the input is a data element defined in the Input Editor tab.

Fault

The Fault tab lists the possible exceptions thrown by this activity.

Fault Thrown when...
FTLGetMessageActivityFault The FTL GetMessage activity fails to receive a message in the given time.