Download as pdf or txt
Download as pdf or txt
You are on page 1of 55

TIBCO ActiveMatrix BusinessWorks™ Plug-in

for TIBCO FTL®


User Guide
Version 6.7.1 | June 2024

Copyright © 2014-2024. Cloud Software Group, Inc. All Rights Reserved.


2 | Contents

Contents
Contents 2

Overview 4

Getting Started 5
Overview of TIBCO Business Studio for BusinessWorks 5
Creating a Project 7
Creating an FTL Connection 9
Configuring a Process 9
Testing a Process 10
Deploying an Application 11

FTL Palette 12
FTL Publisher 12
FTL Reply 15
FTL Request Reply 18
FTL Subscriber 24
FTL GetMessage 30

Enabling FTL Logging for FTL Palette 35

OpenTelemetry Tags for FTL Palette 36

Pushing an Application Using TIBCO Platform 39

Shared Resources 41
FTL Realm Server Connection 41

Error Codes 44

TIBCO Documentation and Support Services 52

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


3 | Contents

Legal and Third-Party Notices 54

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


4 | Overview

Overview
TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® provides a way for external
applications to connect to the TIBCO FTL® system.
TIBCO FTL transfers messages from publishers to subscribers over transports and also
offers different types of transports. It uses the concept of an endpoint to abstract the
transports details, thereby insulating the application program from the complexity of
transport details.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


5 | Getting Started

Getting Started
This tutorial is designed to get users started with TIBCO ActiveMatrix BusinessWorks™ Plug-
in for TIBCO FTL® in TIBCO Business Studio™ for BusinessWorks™.
All the operations are performed in TIBCO Business Studio for BusinessWorks. Refer to
TIBCO ActiveMatrix BusinessWorks™ Concepts to get familiar with TIBCO Business Studio
for BusinessWorks.
The basic steps to create and deploy an application using TIBCO ActiveMatrix
BusinessWorks™ Plug-in for TIBCO FTL® are:

1. Creating a Project
2. Creating an FTL Connection
3. Configuring a Process
4. Testing a Process
5. Deploying an Application

Overview of TIBCO Business Studio for


BusinessWorks
TIBCO Business Studio for BusinessWorks is an Eclipse-based integration development
environment that is used to design, develop, and test ActiveMatrix BusinessWorks
applications. The studio provides a workbench in which you can create, manage, and
navigate resources in your workspace. A workspace is the central location on your
computer where all data files are stored.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


6 | Getting Started

The following table introduces the workbench UI elements highlighted in the image:

UI Element Description

Menu Contains menu items such as File, Edit, Navigate, Search, Project, Run,
Window, and Help.

Toolbar Contains buttons for frequently used commands such as:


l New

l Save

l Enable/Disable Business Studio Capabilities

l Create a new BusinessWorks Application Module

l Debug

l Run

Perspectives Contains an initial set and layout of views that are required to perform a
certain task. TIBCO Business Studio for BusinessWorks launches the Design
perspective by default. Use the Design perspective when designing a process
and the Debug perspective when testing and debugging a process. To
change the perspective, select Window > Open Perspective > perspective_
name from the main menu. Or, you can click the icon at the top right-hand
side of the workbench and select the perspective to open.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


7 | Getting Started

UI Element Description

Views Lists the resources and helps you navigate within the workbench. For
example, the Project Explorer view displays the ActiveMatrix BusinessWorks
applications, modules, and other resources in your workspace, and the
Properties view displays the properties for the selected resource. To open a
view, select Window > Show View > view_nameview_name from the main
menu.

Editors Provides a canvas to configure, edit, or browse a resource. Double-click a


resource in a view to open the appropriate editor for the selected resource.
For example, double-click on a process (MortgageAppConsumer.bwp) in the
Project Explorer view to open the process in the editor.

Palette Contains a set of widgets and a palette library. A palette groups activities
that perform similar tasks, and provides quick access to activities when
configuring a process.

Creating a Project
The first task for using a plug-in is creating a project. You can add resources and processes
after creating a project.
An Eclipse project is an application module configured for TIBCO ActiveMatrix
BusinessWorks. An application module is a resource unit that is named, versioned, and
packaged as part of an application.

Procedure
1. Depending on the platform applicable to your plug-in, start TIBCO Business Studio
for BusinessWorks:

Platform Step

Microsoft Click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO Business
Windows Studio <version> > Studio for Designers

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


8 | Getting Started

Platform Step

Linux or Run the TIBCO Business Studio for BusinessWorks executable file located
macOS in the TIBCO_HOME/studio/<version>/eclipse directory.

For the list of platforms supported by your plug-in, see the Readme file.
2. From the menu, click File > New > BusinessWorks Resources to open the
BusinessWorks Resource wizard.
3. In the "Select a wizard" dialog box, click BusinessWorks Application Module and click
Next to open the New BusinessWorks Application Module wizard.
4. In the Project dialog box, configure the project that you want to create:
a. In the Project name field, enter a project name.
b. By default, the created project is located in the workspace currently in use. If
you do not want to use the default location for the project, clear the Use
default location check box and click Browse to select a new location.
c. Use the default version of the application module, or enter a new version in the
Version field.
d. Keep the Create empty process and Create Application check boxes selected to
automatically create an empty process and an application when creating the
project.
e. Select the Use Java configuration check box if you want to create a Java
module.
A Java module provides Java tooling capabilities.
f. Click Finish to create the project.

Result
A project and an application are created and displayed in the Project Explorer view. The
Process editor opens automatically.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


9 | Getting Started

Creating an FTL Connection


After creating a project, you have to create an FTL Connection shared resource to connect
to an FTL server instance.

Before you begin


FTL Connection shared resource is available at the Resources level. Create the project as
described in Creating a Project.

Procedure
1. Expand the created project in the Project Explorer view.
2. Right-click the Resources folder and click New > FTL Connection to open the FTL
Connection wizard. The resource folder, package name, and resource name of the
FTL connection are provided by default, which can be customized.
3. Click Finish to open the FTL Connection editor.
4. Configure the FTL Connection shared resource in the FTL Connection editor.
5. Click Test Connection to validate the connection.

Configuring a Process
An empty process is created by default when creating a project. You can add activities to
the empty process.

Before you begin


Ensure that you have created an empty process when creating a project. See Creating a
Project for more information.

Procedure
1. In the Project Explorer view, click the created project and open the empty process
from the Processes folder.
2. Select activities from the Palette view and drop them in the Process editor.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


10 | Getting Started

For example, select and drop the Timer activity from the General Activities palette,
and the FTLSendMessage activity from the FTL palette library.

3. Click an activity in the Process editor and drag the icon to create a transition
between the added activities.
4. Configure the added FTL activities, as described in FTL Palette.
5. Click File > Save to save the process.

Testing a Process
After configuring, you might debug or test a process.

Before you begin


Ensure that you have configured a process, as described in Configuring a Process.

Procedure
1. Open the process you have configured in the TIBCO Business Studio for
BusinessWorks.

2. On the toolbar, click Debug > Debug Configurations.


3. Click BusinessWorks Application > BWApplication in the left panel.
By default, all the applications in the current workspace are selected in the
Applications tab. Ensure that only the application you want to debug is selected in
the Applications tab in the right panel.
4. Click Debug to test the process in the selected application.
TIBCO Business Studio for BusinessWorks changes to the Debug perspective. The
debug information is displayed in the Console view.
5. In the Debug tab, expand the debugged process and click an activity such as the
FTLReceiveMessage process.
6. In the upper-right panel, click the Job Data view and then click the Output tab to
check the activity output.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


11 | Getting Started

Deploying an Application
After testing, you can deploy the application that contains the configured process into a
runtime environment, and then use the bwadmin utility to manage the deployed
application.

Before you begin


Before deploying an application, generate an application archive, which is an enterprise
archive (EAR) file created in TIBCO Business Studio for BusinessWorks.
Deploying an application involves:

Procedure
1. Uploading an application archive.
2. Deploying an application archive.
3. Starting an application.

See TIBCO ActiveMatrix BusinessWorks™ Administration guide for more details on how to
deploy an application.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


12 | FTL Palette

FTL Palette
TIBCO ActiveMatrix BusinessWorks™ applications can use the FTL palette to send and
receive messages. TIBCO FTL transfers messages from publishers to subscribers over
transports. TIBCO FTL offers different types of transports. TIBCO FTL uses the concept of an
endpoint to abstract the transports details, thereby insulating the application program
from the complexity of transport details.

FTL Publisher
FTL Publisher is a synchronous activity that publishes (sends) a message over a transport
that is abstracted through a TIBCO FTL application endpoint. The transport details are not
configured in the FTL Publisher activity, instead, it is configured in TIBCO FTL Realm
Server.

General
The General tab has the following fields.

Field Literal Value/Module Description


Property

Name No The name to be displayed as label of the


activity in the application.

FTL Realm Server Yes The shared resource containing information


Connection for connecting to TIBCO FTL Realm Server.
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

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


13 | FTL Palette

Field Literal Value/Module Description


Property

one transport.

Click the Browse button to locate the


endpoints defined on the TIBCO FTL Realm
Server.

Format No Defines the set of fields in the message that is


sent by the FTL Publisher activity. The form
of each FTL message (its field names and
their value datatypes) is governed by a
format. The supported formats are:
l Custom: can be defined by using the
Input Editor. The Input Editor is
enabled only for the Custom format
option.
l Keyed Opaque: is a built-in format that
contains a text key field and a binary
(opaque) data field.
l Opaque: is a built-in format that
contains a binary (opaque) data field.
l 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 Predefined or Custom


format.

This field is displayed when the Custom or


Predefined format is selected.

In addition, selecting the Predefined format


enables the Browse button. Click the Browse
button to obtain the predefined formats from
the TIBCO FTL Realm Server.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


14 | FTL Palette

Description
Provide a short description of the activity here.

Advanced
The Advanced tab has the following fields.

Field Literal Value/Process Description


Property/Module Property

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:
l 0: No retry. This call raises an
exception. This is the default
behavior.
l 1: Synchronously retry the interaction
until it succeeds. This call returns
only upon success.
l n (Any positive double value): Retry
the interaction for n seconds. Return
upon success or raise an exception
after the timeout.

Input Editor
The Input Editor gets enabled only when Custom format is chosen on the General tab. The
schema must match the schema of the input for the activity shown on the Input tab.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


15 | FTL Palette

Input Item Datatype Description

MessageType complex The message type used in the application.

From the Schemas folder, drag the


Message : MessageType element on to the
process editor.

Note: Input Schema does not support


anyType element.

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

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

Fault Thrown when...

FTLPublisherActivityFault FTL Publisher fails to publish a message due to


a runtime error.

FTLCreateMessageFault The FTL message could not be created.

FTLSendMessageFault The FTL message could not be published.

FTL Reply
FTL Reply is a synchronous activity that can send reply to message received through the
FTL Subscriber activity.

General
The General tab has the following fields.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


16 | FTL Palette

Field Description

Name The name to be displayed as the label of the activity in the


application.

Reply For Specifies the FTL Reply message for FTL Subscriber.

Format Defines the set of fields in the message that is sent by the FTL
Reply activity. The form of each FTL message (its field names and
their value datatypes) is governed by a format. The supported
formats are:
l Custom: can be defined by using the Input Editor. The Input
Editor is enabled only for the Custom format option.
l Keyed Opaque: a built-in format that contains a text key
field and a binary (opaque) data field.
l Opaque: a built-in format that contains a binary (opaque)
data field.
l 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 The name of the Predefined or Custom format.

This field is displayed when the Custom or Predefined format is


selected.

In addition, selecting the Predefined format enables the Browse


button. Click the Browse button to obtain the predefined formats
from the TIBCO FTL Realm Server.

Endpoint This additional endpoint is provided to support cases where one


might need separate request and reply paths on to different
endpoints/transports.

If request and reply paths don't need to be separate, then the


endpoint in the reply activity can be left empty and the endpoint
configured in the subscriber activity will be used to send the reply
or reply endpoint should be configured to the same endpoint as
subscriber endpoint.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


17 | FTL Palette

Description
Provide a short description of the activity here.

Advanced
The Advanced tab has the following fields.

Field Literal Value/Process Description


Property/Module Property

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:
l 0: No retry. This call raises an
exception. This is the default
behavior.
l 1: Synchronously retry the interaction
until it succeeds. This call returns
only upon success.
l n (Any positive double value): Retry
the interaction for n seconds. Return
upon success or raise an exception
after the timeout.

Input Editor
The Input Editor gets enabled only when you select the Custom format on the General tab.
The schema must match the schema of the input for the activity shown on the Input tab.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


18 | FTL Palette

Input Item Datatype Description

MessageType complex The message type used in the application.

From the Schemas folder, drag the


Message: MessageType element on to the
process editor.

Note: Input Schema does not support


anyType element.

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

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

Fault Thrown when...

FTLReplyActivityFault The FTL Reply activity fails to reply due to a runtime error.

FTLCreateReplyMessageFault The FTL reply message could not be created.

FTLSendReplyMessageFault The FTL reply message is not published.

FTL Request Reply


FTL Request Reply is an asynchronous activity that is used to send a request to an FTL
application endpoint and wait for a response.

General
The General tab has the following fields.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


19 | FTL Palette

Field Literal Value/Module Description


Property

Name No The name to be displayed as label of the


activity in the application.

FTL Realm Server Yes The shared resource containing information for
Connection connecting to TIBCO FTL Realm Server. 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 Request Reply activity sends
messages. The FTL Request Reply activity has
two endpoints:
l Request Endpoint - This is used to send
the request message and is a required
field.
l Reply Endpoint - This is used to receive
the reply message and is an optional
field.

Note: These additional endpoints are


provided to support cases where one might
need separate request and reply paths on to
different endpoints/transports. If the request
and reply paths don't need to be separate,
then request endpoint will be used to send
request and receive reply or reply endpoint
should be configured to the same endpoint
as request endpoint.

The endpoint can have more than one


transport.

Click the Browse button to locate the endpoints


defined on the TIBCO FTL Realm Server.

Request Format No Defines the set of fields in the message that is

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


20 | FTL Palette

Field Literal Value/Module Description


Property

sent by the FTL Request Reply activity. The


form of each FTL message (its field names and
their value datatypes) is governed by a format.
The supported formats are:
l Custom: can be defined by using the
Input Editor. The Input Editor is enabled
only for the Custom format option.
l 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.

Selecting the Custom field enables the Input


Editor.

Request Format Yes The name of the Predefined or Custom format.


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

Reply Format Yes Defines the set of fields in the message that is
sent by the FTL Request Reply activity. The
form of each FTL message (its field names and
their value datatypes) is governed by a format.
The supported formats are:
l Custom: can be defined by using the
Input Editor. The Input Editor is enabled
only for the Custom format option.
l Keyed Opaque: is a built-in format that
contains a text key field and a binary
(opaque) data field.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


21 | FTL Palette

Field Literal Value/Module Description


Property

l Opaque: is a built-in format that contains


a binary (opaque) data field.
l 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.

Reply Format Yes The name of the Predefined or Custom format.


Name
This field is displayed when the Custom or
Predefined format is selected.

In addition, selecting the Predefined format


enables the Browse button. Click the Browse
button to obtain the predefined formats from
TIBCO FTL Realm Server.

Description
Provide a short description of the activity here.

Advanced
The Advanced tab has the following field.

Field Literal Value/Process Description


Property/Module
Property

Activity Yes It is the amount of time FTL Request Reply


Timeout (msec) activity waits to get the reply from the FTL
Subscriber.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


22 | FTL Palette

Field Literal Value/Process Description


Property/Module
Property

Important: If the FTL Request Reply activity is


configured to be Default Timeout, then the
timeout value equates to "3" minutes by
default. However this default value (3
minutes) can be modified to be a different
value by setting the AppSpace config.ini
property bw.engine.activity.async.waitTime.

Note: When the FTL Request Reply activity


timesout, the in-line subprocess instance
called by the FTL Request Reply activity can
be canceled before the subprocess instance
completes. Hence, the business logic in the
canceled process instance may not be
executed to its entirety.

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:
l 0: No retry. This call raises an exception.
This is the default behavior.
l 1: Synchronously retry the interaction
until it succeeds. This call returns only
upon success.
l n (Any positive double value): Retry the
interaction for n seconds. Return upon
success or raise an exception after the
timeout.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


23 | FTL Palette

Input Editor
The Input Editor gets enabled only when the Custom format is chosen on the General tab.
The schema must match the schema of the input for the activity shown on the Input tab.

Note: Input Schema does not support anyType element.

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

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

Output
Shows the output reply message. For example, if you select Predefined as a Reply Format,
the output shows the Predefined message with the message metadata and reply message.

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

Fault Thrown When...

FTLRequestReplyActivityFault The FTL Request Reply activity fails due to


a runtime error.

FTLCreateRequestMessageFault The FTL request message could not be


created.

FTLSendRequestMessageFault The FTL request message could not be


published.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


24 | FTL Palette

Fault Thrown When...

FTLProcessReplyMessageFault The FTL reply message could not be


processed.

ActivityTimedOutException The timeout is reached.

FTL Subscriber
The FTL Subscriber is a process starter activity that starts the process based on the receipt
of a message over a transport that is abstracted through a TIBCO FTL application endpoint.
The transport details are not configured in the FTL Subscriber activity, instead it is
configured in TIBCO FTL Realm Server.

General
The General tab has the following fields.

Field Literal Value/Process Description


Property/Module Property

Name No The name to be displayed as the label of


the activity in the application.

FTL Realm Server Yes The shared resource containing


Connection information for connecting to an 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 Subscriber
activity receives messages. The endpoint
can have more than one transport.

Click the Browse button to locate the

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


25 | FTL Palette

Field Literal Value/Process Description


Property/Module Property

endpoints defined on the TIBCO FTL


Realm Server.

Content Matcher Yes Specifies FTL Subscriber 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.

Format No Defines the set of fields in the message


that is sent by the FTL Publisher activity.
The form of each FTL message (its field
names and their value datatypes) is
governed by a format. The supported
formats are:
l Custom: can be defined by using
the Input Editor. The Input Editor
is enabled only for the Custom
format option.
l Keyed Opaque: is a built-in format
that contains a text key field and a
binary (opaque) data field.
l Opaque: is a built-in format that
contains a binary (opaque) data
field.
l 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

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


26 | FTL Palette

Field Literal Value/Process Description


Property/Module Property

Browse button.

Format Name Yes The name of the format of the FTL


Subscriber message.

In addition, selecting the Predefined


format enables the Browse button. Click
the Browse button to obtain the
predefined formats from the TIBCO FTL
Realm Server.

Description
Provide a short description of the activity here.

Advanced
The Advanced tab has the following fields.

Field Literal Value/Process Description


Property/Module
Property

Subscriber Name Yes Specify the name of the subscriber on the


TIBCO FTL Realm Server.

Durable Name Yes Specify the durable name that will enable
the FTL Subscriber to dynamically create
a durable listener.

Acknowledge Mode Yes The acknowledge mode for subscriber


messages. It can be one of the following:
l Auto: When this mode is used, the
FTL library automatically
acknowledges the message when

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


27 | FTL Palette

Field Literal Value/Process Description


Property/Module
Property

the application callback returns.


l Explicit: When this mode is used,
the user needs to use a Confirm
activity in the ActiveMatrix
BusinessWorks™ process to
explicitly acknowledge the
message.

FTL Queue Yes Specifies the number of threads to use for


Dispatcher Threads dispatching events from the FTL event
queue.

FTL Queue Size Yes Size of FTL event queue.

The default value of queue size is -1 in


the subscriber configuration and the
default discard policy set is Discard None.
This setting creates a default FTL event
queue without any size mentioned. This
means no upper limit for the queue size is
set and no messages will be discarded.

Even with the value of queue size set to 0,


the behavior is similar to the above case.

If the queue size is greater than 0, then


the discard policy can be either Discard
New, which means discard new messages
instead of adding them to the queue; or
Discard Old, which means discard old
messages from the head of the queue.

If the flow limit is set to 100, and if


currently there are 100 jobs, then the
101st message will be in the queue but
won't be dispatched. If the flow limit is

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


28 | FTL Palette

Field Literal Value/Process Description


Property/Module
Property

hit, the dispatcher threads are paused


and will resume dispatching the messages
from the queue only when the number of
jobs become less than the flow limit set.

During the time the dispatcher is paused,


the messages in the event queue won't be
dispatched and processed but any new
message arriving during this time would
be stored or discarded by the queue,
according to the queue size and the
discard policy.

Flow limit is not linked with queue size or


activity worker threads. When the flow
limit is hit, dispatcher threads are paused
which will also halt the creation of any
new worker threads.

FTL Queue Overflow Yes This field is enabled when the queue size
Policy is greater than zero. Select any one from
the following available options:
l Discard None
l Discard New
l Discard Old

Activity Worker Yes Must be greater than zero. By default, the


Threads equivalent of half of the ActiveMatrix
BusinessWorks™ engine thread pool is
created.

For example, if the ActiveMatrix


BusinessWorks™ engine thread pool is set
to eight, then the FTL Subscriber activity
creates four threads for processing the

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


29 | FTL Palette

Field Literal Value/Process Description


Property/Module
Property

incoming FTL message.

Sequence Key No This field can contain an XPath expression


that specifies which processes should run
in sequence. Process instances with
sequencing keys that evaluate to the
same value are executed sequentially as
the process instance was created.

Custom Job Id No This field can contain an XPath expression


that specifies a custom ID for the process
instance.

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:
l 0: No retry. This call raises an
exception. This is the default
behavior.
l 1: Synchronously retry the
interaction until it succeeds. This
call returns only upon success.
l n (Any positive double value): Retry
the interaction for n seconds.
Return upon success or raise an
exception after the timeout.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


30 | FTL Palette

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.

Conversations

You can initiate the conversation here. Click the Add New Conversation button to
initiate multiple conversations. Refer to Application Development guide for more
information on conversations.

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

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 with a store and should make
use of shared durables. More information about using durables in FTL is
available in the FTL documentation.

Important:
l This activity only works with shared durables. Do not use other durables.
l Prefetch count for shared durables should be set to 1 in the prefetch settings for
shared durables. Failure to do so results in the loss of some messages.

General
The General tab has the following fields.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


31 | FTL Palette

Field Literal Value/Module Description


Property

Name No The name to be displayed as the label of the


activity in the application.

FTL Realm Server Yes The shared resource containing information


Connection 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:

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


32 | FTL Palette

Field Literal Value/Module Description


Property

l Custom: can be defined by using the


Input Editor. The Input Editor is
enabled only for the Custom format
option.
l Keyed Opaque: is a built-in format that
contains a text key field and a binary
(opaque) data field.
l Opaque: is a built-in format that
contains a binary (opaque) data field.
l 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 Description


Property

Subscriber Name Yes Specify the name of the subscriber on the

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


33 | FTL Palette

Field Literal Value/Module Description


Property

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:
l 0: No retry. This call raises an
exception. This is the default behavior.
l 1: Synchronously retry the interaction
until it succeeds. This call returns only
upon success.
l n (Any positive double value): Retry
the interaction for n seconds. Return
upon success or raise an exception
after the timeout.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


34 | FTL Palette

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 on the Advanced tab or the input
section. The value set on Input tab will override
any value set on 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 on the General tab. If you
select the Custom format, the input is a data element defined on 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.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


35 | Enabling FTL Logging for FTL Palette

Enabling FTL Logging for FTL Palette


FTL logging for FTL Palette is supported on TIBCO ActiveMatrix BusinessWorks™ Plug-in for
TIBCO FTL.
To enable FTL logging, the following logger should be added to logback.xml:

<logger name="com.tibco.bw.ftl"> <level value="DEBUG"/> </logger>

The log levels can be set from the TIBCO FTL Realm Server or by using the
bw.ftl.client.log.level property or the BW_FTL_CLIENT_LOG_LEVEL environment variable.
By default, the log level for all clients is set to default in the TIBCO FTL Realm Server.
For the meaning of log level values, refer to the FTL documentation.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


36 | OpenTelemetry Tags for FTL Palette

OpenTelemetry Tags for FTL Palette


OpenTelemetry is an open-source and vendor-neutral standard for distributed systems.
OpenTelemetry can be used to keep track of the current state of the job. For more
information, you can see the OpenTelemetry section of the TIBCO ActiveMatrix
BusinessWorks™ Administration Guide.
The sender and receiver process instances are shown in one trace. This includes process
instances containing the Publisher, Subscriber, RequestReply, and Reply activities. For the
GetMessage activity, the process instance appears as a separate trace. This is only
applicable to Opaque, Keyed Opaque, and Custom message formats.

Note: For predefined message format, you can see the sender and receiver
process instance in one trace by adding _traceparent field of type String to the
predefined message format.

The list of predefined tags supported for each activity are as follows:

Activity Supported Tags

FTL Publisher l FTL Application Name


l Endpoint
l Format
l Format Name
l Publisher Retry Duration
l Realm Server URL

FTL Subscriber l FTL Application Name


l Endpoint
l Format
l Format Name

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


37 | OpenTelemetry Tags for FTL Palette

Activity Supported Tags

l Retry Duration
l Realm Server URL
l Acknowledgement Mode
l Durable Name
l Queue Overflow Discard Policy
l Queue Size
l Realm Server Connection
l Content Matcher
l Subscriber Name
l Sequence Key

FTL Request Reply l FTL Application Name


l Reply Endpoint
l Reply Format
l Reply Format Name
l Request Format
l Request Endpoint
l Request Format Name
l Retry Duration
l Realm Server URL
l Content Matcher
l Timeout

FTL GetMessage l Durable Name


l Endpoint

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


38 | OpenTelemetry Tags for FTL Palette

Activity Supported Tags

l Format
l FTL Application Name
l Realm Server URL
l Timeout
l Content Matcher
l Subscriber Name

FTL Reply l Format


l Format Name
l FTL Application Name
l Reply Endpoint
l Retry Duration

Custom Tags
For OpenTelemetry tags, you can add custom tags. To add custom tags, you must use the
Tags tab of each activity in TIBCO Business Studio for BusinessWorks. You can add
expression such as hard-coded values or XPath expressions for custom tags. At run time, an
asterisk (*) prefix is added to the names of the custom tags to avoid overriding of
predefined engine tags.
For more information, you can see the Custom Tags for OpenTelemetry section of the
TIBCO ActiveMatrix BusinessWorks™ Administration Guide.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


39 | Pushing an Application Using TIBCO Platform

Pushing an Application Using


TIBCO Platform
This section describes how to push an application containing ActiveMatrix BusinessWorks
Plug-in for TIBCO FTL using TIBCO® Platform.

Before you begin


l Adding the plug-in supplements is mandatory to push any application.
l Before pushing the application to TIBCO Platform, you must provide the TIBCO FTL
OSGi Linux client libraries file. To add the TIBCO FTL OSGi Linux client libraries file,
perform the following steps.

Adding Plug-in Supplements

Procedure
1. Copy the TIBCO FTL OSGi Linux client libraries (<com.tibco.ftl_x.x.x>) file from the FTL-
HOME/components/shared/1.0.0/plugins folder.

2. Compress the copied folder (<com.tibco.ftl_x.x.x>) and rename it to ftl.zip. Compressed


ftl.zip folder contains com.tibco.ftl.x.x.x folder that has all the other folders in it.

3. Log in to TIBCO® Control Plane.


4. Navigate to the DataPlane where you want to add the supplement. Click the TIBCO
BusinessWorks™ Container Edition capability details page and click Upload
Supplement.
5. In the Upload Supplement window, select a plug-in or driver from the dropdown list.
6. Drag your supplement archive onto the window. You can also click browse to find the
files on your system and click Upload to upload the selected file.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


40 | Pushing an Application Using TIBCO Platform

Note: Adding plug-in supplement is necessary only once for a DataPlane.


Subsequent application pushes in that DataPlane automatically use the
supplemented plug-in.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


41 | Shared Resources

Shared Resources
Shared resources are used to define a resource that contains configuration data that can
be referenced from multiple processes.

FTL Realm Server Connection


The FTL Realm Server Connection shared resource describes the connection parameters for
connecting to a Realm server and creation of the Realm object to be used by the FTL
palette activities. Use this shared resource when configuring activities in the FTL palette.

Note: Ensure that you have installed FTL client libraries. Refer to "Integrating
with TIBCO FTL" in the TIBCO ActiveMatrix BusinessWorks™ Installation guide for
additional details.

General
The General section has the following fields.

Field Description

Package The name to be displayed as the label of the resource package.

Name The name to be displayed as the label for the resource.

Description A short description of the resource.

FTL Realm Server Connection Configuration


This section has the following fields.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


42 | Shared Resources

Field Literal Description


Value/Module
Property

FTL Realm Yes The URL list of the FTL realm server.
Server URL
Note: If the FTL version used is 6.x and above, in the FTL
Realm Server URL field provide all the URLs as a pipe
separated list.
For example,
http://localhost:8585|http://localhost:8685|http://localhost:
8785

FTL Yes The URL of the backup FTL realm server.


Secondary
Realm
Server URL

FTL Yes The name of the FTL application, which includes a set of
Application endpoints and formats as configured in the realm server.
Name
The Browse button can be used to browse the FTL
applications defined on the Realm server.

FTL Yes The ID of the FTL application instance.


Application
Instance ID

Username Yes The username of the FTL realm server.

Password Yes The password of the FTL realm server.

Client Label Yes A string describing the functional role of the client process.
For background information, see Client Label.

Realm Yes Select the ftl-trust.pem file for authentication by using


Server Trust Resource Picker. For more information about the trust file
File that is generated, see Trust File topic in the TIBCO FTL®
Administration guide.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


43 | Shared Resources

Test Connection
When you click the Test Connection button, the activity connects to the remote FTL Realm
server on the specified port using the specified username and password. You can use this
button to determine whether the specified connection configuration is correct.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


44 | Error Codes

Error Codes
The following table lists error codes, detailed explanation of each error, where applicable,
and ways to solve different errors.

Error Codes Error Message Error Resolution

TIBCO-BW- {0} This is an internal error. Contact


PALETTE-FTL- TIBCO Support.
000001

TIBCO-BW- {0} This is a trace message and


PALETTE-FTL- resolution is not applicable.
100001

TIBCO-BW- {0} This is a debug message and


PALETTE-FTL- resolution is not applicable.
200001

TIBCO-BW- Configuration details of publisher This is a debug message and


PALETTE-FTL- activity [{0}] is [{1}]. resolution is not applicable.
200102 FTLRealmServerURL=[{2}],
FTLAppName=[{3}],
FTLAppInstanceID=[{4}]. Process=
[{5}], Module=[{6}], DeploymentUnit=
[{7}:{8}].

TIBCO-BW- FTL message successfully published This is a debug message and


PALETTE-FTL- by activity [{0}]. FTLRealmServerURL= resolution is not applicable.
200104 [{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}]. Process=[{5}],
Module=[{6}], DeploymentUnit=[{7}:
{8}].

TIBCO-BW- Configuration details of subscriber This is a debug message and

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


45 | Error Codes

Error Codes Error Message Error Resolution

PALETTE-FTL- activity [{0}] is [{1}]. resolution is not applicable.


200202 FTLRealmServerURL=[{2}],
FTLAppName=[{3}],
FTLAppInstanceID=[{4}]. Process=
[{5}], Module=[{6}], DeploymentUnit=
[{7}:{8}].

TIBCO-BW- Thread Pool size for subscriber This is a debug message and
PALETTE-FTL- activity [{0}] is set to [{1}]. resolution is not applicable.
200204 FTLRealmServerURL=[{2}],
FTLAppName=[{3}],
FTLAppInstanceID=[{4}],
FTLEndpoint=[{5}]. Process=[{6}],
Module=[{7}], DeploymentUnit=[{8}:
{9}].

TIBCO-BW- FTL Event Queue dispatcher has This is a debug message and
PALETTE-FTL- dispatched [{0}] message(s) to resolution is not applicable.
200206 subscriber activity [{1}].
FTLRealmServerURL=[{2}],
FTLAppName=[{3}],
FTLAppInstanceID=[{4}],
FTLEndpoint=[{5}]. Process=[{6}],
Module=[{7}], DeploymentUnit=[{8}:
{9}].

TIBCO-BW- Subscriber activity [{0}] has This is a debug message and


PALETTE-FTL- successfully notified a new event to resolution is not applicable.
200208 the BW engine. FTLRealmServerURL=
[{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}]. Process[{5}],
Module [{6}], DeploymentUnit [{7}:
{8}].

TIBCO-BW- FTL message acknowledged This is a debug message and


PALETTE-FTL- successfully. {0} resolution is not applicable.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


46 | Error Codes

Error Codes Error Message Error Resolution

200210

TIBCO-BW- Subscriber activity [{0}] thread pool This is a debug message and
PALETTE-FTL- unavailable for message processing. resolution is not applicable.
200212 Waiting until executor thread from
the pool is available.
FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}]. Process=[{5}],
Module=[{6}], DeploymentUnit=[{7}:
{8}].

TIBCO-BW- Configuration details of reply activity This is a debug message and


PALETTE-FTL- [{0}] is [{1}]. FTLRealmServerURL= resolution is not applicable.
200302 [{2}], FTLAppName=[{3}],
FTLAppInstanceID=[{4}],
FTLEndpoint=[{5}]. Process=[{6}],
Module=[{7}], DeploymentUnit=[{8}:
{9}].

TIBCO-BW- FTL reply message successfully sent This is a debug message and
PALETTE-FTL- to Inbox by activity [{0}]. resolution is not applicable.
200304 FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}]. Process=[{5}],
Module=[{6}], DeploymentUnit=[{7}:
{8}].

TIBCO-BW- Configuration details of request-reply This is a debug message and


PALETTE-FTL- activity [{0}] is [{1}]. resolution is not applicable.
200402 FTLRealmServerURL=[{2}],
FTLAppName=[{3}],
FTLAppInstanceID=[{4}]. Process=
[{5}], Module=[{6}], DeploymentUnit=
[{7}:{8}].

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


47 | Error Codes

Error Codes Error Message Error Resolution

TIBCO-BW- FTL request message successfully This is a debug message and


PALETTE-FTL- published by activity [{0}]. resolution is not applicable.
200404 FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}]. Process=[{5}],
Module=[{6}], DeploymentUnit=[{7}:
{8}].

TIBCO-BW- {0} This is a general informational


PALETTE-FTL- message.
300001

TIBCO-BW- {0} This is an internal warning.


PALETTE-FTL- Contact TIBCO Support.
400001

TIBCO-BW- Failed to clear message fields. {0} This is an internal warning.


PALETTE-FTL- Contact TIBCO Support.
400002

TIBCO-BW- For the Request-Reply scenario, FTL Ensure the Endpoint is properly
PALETTE-FTL- Subscriber failed to create publisher configured for Inbox
400202 object for sending reply messages to communication.
Inbox due to exception [{0}].
FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{5}].

TIBCO-BW- FTL Error due to exception [{0}]. This is an internal error. Contact
PALETTE-FTL- FTLRealmServerURL=[{1}], TIBCO Support.
500002 FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


48 | Error Codes

Error Codes Error Message Error Resolution

TIBCO-BW- Failed to destroy message due to This is an internal error. Contact


PALETTE-FTL- exception [{0}]. FTLRealmServerURL= TIBCO Support.
500004 [{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to create FTL Publisher due to Ensure the Endpoint is properly
PALETTE-FTL- exception [{0}]. FTLRealmServerURL= configured on the Realm server.
500102 [{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to create FTL message due to In case of predefined format,


PALETTE-FTL- exception [{0}]. FTLRealmServerURL= ensure activity input schema
500104 [{1}], FTLAppName=[{2}], matches the format defined on
FTLAppInstanceID=[{3}], the Realm server.
FTLEndpoint=[{4}].

TIBCO-BW- Failed to send FTL message due to Ensure the transport(s) defined
PALETTE-FTL- exception [{0}]. FTLRealmServerURL= under the Endpoint are properly
500106 [{1}], FTLAppName=[{2}], configured.
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to create FTL Subscriber Ensure the Endpoint is properly


PALETTE-FTL- object due to exception [{0}]. configured on the Realm server.
500202 FTLRealmServerURL=[{1}], Check content matcher. Check
FTLAppName=[{2}], queue overflow discard policy.
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to process FTL message due to This is an internal error. Contact
PALETTE-FTL- exception [{0}]. FTLRealmServerURL= TIBCO Support.
500204 [{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


49 | Error Codes

Error Codes Error Message Error Resolution

TIBCO-BW- Error acknowledging FTL message This is an internal error. Contact


PALETTE-FTL- due to exception [{0}]. TIBCO Support.
500206 FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to dispatch FTL messages This is an internal error. Contact


PALETTE-FTL- from event queue [{0}] due to TIBCO Support.
500208 exception [{1}].

TIBCO-BW- Subscriber activity [{0}] failed to This is an internal error. Contact


PALETTE-FTL- destroy FTL event queue [{1}] due to TIBCO Support.
500210 exception [{2}]. Process=[{3}],
Module=[{4}], DeploymentUnit=[{5}:
{6}].

TIBCO-BW- Unable to get FTL Realm object from FTL Realm object is not
PALETTE-FTL- receiver EventContext. This error can available if the job is recovered
500302 occur if the FTLReply activity is from a checkpoint.
executed after recovering from a
check-pointed BusinessWorks
process instance. FTLAppName=[{0}],
FTLEndpoint=[{1}].

TIBCO-BW- Unable to get Inbox Publisher from Inbox publisher object is not
PALETTE-FTL- receiver EventContext. available if the job is recovered
500304 FTLRealmServerURL=[{0}], from a checkpoint.
FTLAppName=[{1}],
FTLAppInstanceID=[{2}],
FTLEndpoint=[{3}].

TIBCO-BW- Inbox not available to send reply Ensure that inbox information is
PALETTE-FTL- message. FTLRealmServerURL=[{0}], set on the incoming request
500306 FTLAppName=[{1}], message.
FTLAppInstanceID=[{2}],
FTLEndpoint=[{3}].

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


50 | Error Codes

Error Codes Error Message Error Resolution

TIBCO-BW- Failed to create FTL reply message In case of predefined format,


PALETTE-FTL- due to exception [{0}]. ensure activity input schema
500308 FTLRealmServerURL=[{1}], matches the format defined on
FTLAppName=[{2}], the Realm server.
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to send FTL reply message to Ensure the transport(s) defined
PALETTE-FTL- Inbox due to exception [{0}]. under the Endpoint are properly
500310 FTLRealmServerURL=[{1}], configured.
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to create FTL Publisher for Ensure the Endpoint is properly
PALETTE-FTL- sending request messages due to configured on the Realm server.
500402 exception [{0}]. FTLRealmServerURL=
[{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Unable to find Inbox field in request Ensure the Message Format
PALETTE-FTL- message format[{0}] due to exception defined on the realm server has
500404 [{1}]. FTLRealmServerURL=[{2}], a field of type Inbox.
FTLAppName=[{3}],
FTLAppInstanceID=[{4}],
FTLEndpoint=[{5}].

TIBCO-BW- Failed to create FTL Inbox Subscriber Ensure the Transport defined
PALETTE-FTL- for receiving reply message due to under the Endpoint is
500406 exception [{0}]. FTLRealmServerURL= configured for 'Receive Inbox'.
[{1}], FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to create listener for reply Ensure the Endpoint and
PALETTE-FTL- Transport is properly configured

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


51 | Error Codes

Error Codes Error Message Error Resolution

500408 message due to exception [{0}]. on the Realm server.


FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to create FTL request message In case of predefined format,


PALETTE-FTL- due to exception [{0}]. ensure activity input schema
500410 FTLRealmServerURL=[{1}], matches the format defined on
FTLAppName=[{2}], the Realm server.
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to send FTL request message Ensure the transport(s) defined
PALETTE-FTL- due to exception [{0}]. under the Endpoint are properly
500412 FTLRealmServerURL=[{1}], configured.
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO-BW- Failed to process reply message due This is an internal error. Contact
PALETTE-FTL- to exception [{0}]. TIBCO Support.
500414 FTLRealmServerURL=[{1}],
FTLAppName=[{2}],
FTLAppInstanceID=[{3}],
FTLEndpoint=[{4}].

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


52 | TIBCO Documentation and Support Services

TIBCO Documentation and Support Services


For information about this product, you can read the documentation, contact TIBCO
Support, and join TIBCO Community.

How to Access TIBCO Documentation


Documentation for TIBCO products is available on the Product Documentation website,
mainly in HTML and PDF formats.
The Product Documentation website is updated frequently and is more current than any
other documentation included with the product.

Product-Specific Documentation
The documentation for this product is available on the TIBCO ActiveMatrix BusinessWorks™
Plug-in for TIBCO FTL® Product Documentation page.

How to Contact Support for TIBCO Products


You can contact the Support team in the following ways:
l To access the Support Knowledge Base and getting personalized content about
products you are interested in, visit our product Support website.
l To create a Support case, you must have a valid maintenance or support contract
with a Cloud Software Group entity. You also need a username and password to log
in to the product Support website. If you do not have a username, you can request
one by clicking Register on the website.

How to Join TIBCO Community


TIBCO Community is the official channel for TIBCO customers, partners, and employee
subject matter experts to share and access their collective experience. TIBCO Community
offers access to Q&A forums, product wikis, and best practices. It also offers access to
extensions, adapters, solution accelerators, and tools that extend and enable customers to
gain full value from TIBCO products. In addition, users can submit and vote on feature

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


53 | TIBCO Documentation and Support Services

requests from within the TIBCO Ideas Portal. For a free registration, go to
TIBCO Community.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


54 | Legal and Third-Party Notices

Legal and Third-Party Notices


SOME CLOUD SOFTWARE GROUP, INC. (“CLOUD SG”) SOFTWARE AND CLOUD SERVICES EMBED,
BUNDLE, OR OTHERWISE INCLUDE OTHER SOFTWARE, INCLUDING OTHER CLOUD SG SOFTWARE
(COLLECTIVELY, “INCLUDED SOFTWARE”). USE OF INCLUDED SOFTWARE IS SOLELY TO ENABLE THE
FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED CLOUD SG
SOFTWARE AND/OR CLOUD SERVICES. THE INCLUDED SOFTWARE IS NOT LICENSED TO BE USED OR
ACCESSED BY ANY OTHER CLOUD SG SOFTWARE AND/OR CLOUD SERVICES OR FOR ANY OTHER
PURPOSE.

USE OF CLOUD SG SOFTWARE AND CLOUD SERVICES IS SUBJECT TO THE TERMS AND CONDITIONS
OF AN AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED AGREEMENT, OR, IF THERE IS NO
SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER AGREEMENT WHICH IS DISPLAYED WHEN
ACCESSING, DOWNLOADING, OR INSTALLING THE SOFTWARE OR CLOUD SERVICES (AND WHICH IS
DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH LICENSE AGREEMENT OR CLICKWRAP
END USER AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE
OF THIS DOCUMENT IS SUBJECT TO THOSE SAME TERMS AND CONDITIONS, AND YOUR USE HEREOF
SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document is subject to U.S. and international copyright laws and treaties. No part of this
document may be reproduced in any form without the written authorization of Cloud Software
Group, Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, ActiveMatrix BusinessWorks, Business Studio, and TIBCO
Business Studio are either registered trademarks or trademarks of Cloud Software Group, Inc. in the
United States and/or other countries.

All other product and company names and marks mentioned in this document are the property of
their respective owners and are mentioned for identification purposes only. You acknowledge that all
rights to these third party marks are the exclusive property of their respective owners. Please refer to
Cloud SG’s Third Party Trademark Notices (https://www.cloud.com/legal) for more information.

This document includes fonts that are licensed under the SIL Open Font License, Version 1.1, which is
available at: https://scripts.sil.org/OFL

Copyright (c) Paul D. Hunt, with Reserved Font Name Source Sans Pro and Source Code Pro.

Cloud SG software may be available on multiple operating systems. However, not all operating
system platforms for a specific software version are released at the same time. See the “readme” file
for the availability of a specific version of Cloud SG software on a specific operating system platform.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide


55 | Legal and Third-Party Notices

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES


ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED
IN NEW EDITIONS OF THIS DOCUMENT. CLOUD SG MAY MAKE IMPROVEMENTS AND/OR CHANGES IN
THE PRODUCT(S), THE PROGRAM(S), AND/OR THE SERVICES DESCRIBED IN THIS DOCUMENT AT ANY
TIME WITHOUT NOTICE.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR


INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT
NOT LIMITED TO ANY RELEASE NOTES AND "README" FILES.

This and other products of Cloud SG may be covered by registered patents. For details, please refer
to the Virtual Patent Marking document located at https://www.cloud.com/legal.

Copyright © 2014-2024. Cloud Software Group, Inc. All Rights Reserved.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for TIBCO FTL® User Guide

You might also like