- Index

< Previous |  | Next >

# TIBCO FTL Adapter Sample

This sample demonstrates the use of the TIBCO StreamBase® Adapters for TIBCO FTL®, as well as the use of map-related operations using the FTL Map Adapters.

### Note

Before running this sample, be sure to configure the TIBCO FTL `tibftl.jar` file and make the FTL middleware libraries available to the system, as described in TIBCO Middleware Dependencies in the TIBCO FTL Subscribing Input Adapter or TIBCO FTL Publishing Output Adapter pages of the Adapters Guide.

## Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

- From the top-level menu, click File → Load StreamBase Sample.

- Enter `ftl` to narrow the list of options.

- Select TIBCO FTL input/output adapters from the Other TIBCO Product Connectivity category.

- Click OK.

StreamBase Studio creates a project for this sample.

## Running The Publish-Subscribe Sample in StreamBase Studio

You must edit the project's `src/main/configurations/engine.conf` file to edit the `externalNativeLibraryPath` and `externalClassPath` entries to reflect your FTL installation's path.

The sample also requires a FTL maven artifact be installed, the sample comes with a launch config which will install the `tibftl.jar` into your local maven repository with the correct group and artifact name. To use this please place your installed copy of `tibftl.jar` into the root of the sample workspace and run the `ftl-4.3 maven install.launch`

1. Start the TIBCO FTL realm server. The sample assumes it is running on localhost, port 8080.

2. In the Project Explorer view, open the sample you just loaded.

   If you see red marks on a project folder, wait a moment for the project to load its features.

   If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven → Update Project from the context menu.

3. Open the `src/main/eventflow/`packageName`` folder.

4. Select the Subscribe adapter icon to open the Properties view for the adapter.

5. Adjust the Realm Server URL, Application Name, and Endpoint Name properties to match the realm server configuration.

6. Repeat the previous step for the Publisher adapter.

7. Open the `tibco-ftl.sbapp` file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

8. In the Test/Debug Perspective, open the Output Streams view. If the adapter is able to connect to the realm server, two `Connected` status tuples appear, one from each TIBCO FTL adapter instance.

9. In the Manual Input view, select the `PublishIn` stream and click Send Data. Additional tuples appear in the Output Streams view from the `SubscribeOut` and `SubscribeStatus` streams indicating the following:

   - The message published by the FTL output adapter was received by the FTL input adapter.

   - The received message was acknowledged (assuming the subscribe adapter's Explict ACK property remains enabled).

10. When done, press F9 or click the Terminate EventFlow Fragment button.

## Running The FTL Map Sample in StreamBase Studio

You must edit the project's `src/main/configurations/engine.conf` file to edit the `externalNativeLibraryPath` and `externalClassPath` entries to reflect your FTL installation's path.

The sample also requires a FTL maven artifact be installed, the sample comes with a launch config which will install the `tibftl.jar` into your local maven repository with the correct group and artifact name. To use this please place your installed copy of `tibftl.jar` into the root of the sample workspace and run the `ftl-4.3 maven install.launch`

1. Start the TIBCO FTL realm server. The sample assumes it is running on localhost, port 8080.

2. In the Project Explorer view, open the sample you just loaded.

   If you see red marks on a project folder, wait a moment for the project to load its features.

   If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven → Update Project from the context menu.

3. Open the `src/main/eventflow/`packageName`` folder.

4. Select the Map Get adapter icon to open the Properties view for the adapter.

5. Adjust the Realm Server URL, Application Name, and Endpoint Name properties to match the realm server configuration.

6. Repeat the previous step for the Map Set, Map Iterate and Map Remove adapters.

7. Open the `tibco-ftl-maps.sbapp` file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

8. In the Test/Debug Perspective, open the Output Streams view. If the adapters are able to connect to the realm server, four `Connected` status tuples appear, one from each TIBCO FTL Map adapter instance.

9. In the Manual Input view, select the `MapSetIn` stream and click Send Data. An additional tuple appears in the Output Streams view from the `MapSetStatus` stream indicating the message was successfully set in the map.

10. In the Manual Input view, select the `MapGetCommands` stream and set the following values:

    - Command: `Get`

    - FTLMapName: `tibmap`

    - FTLKeyName: `Key1`

    Click Send Data. A tuple appears in the Output Streams view from the `MapGetResult` stream describing the message that was successfully retrieved from the map.

11. In the Manual Input view, select the `MapIterateCommands` stream and set the following values:

    - Command: `Iterate`

    - FTLMapName: `tibmap`

    Click Send Data. Two tuples appear in the Output Streams view from the `MapIterateResult`s stream: one describing the message that previously added to the map, and one with all fields including FTLMapName and FTLKeyName set to null to indicate the end of the list.

12. In the Manual Input view, select the `MapSetIn` stream and click Send Data. An additional tuple appears in the Output Streams view from the `MapSetStatus` stream indicating the message was successfully set in the map.

13. In the Manual Input view, select the `MapRemoveCommands` stream and set the following values:

    - Command: `Remove`

    - FTLMapName: `tibmap`

    - FTLKeyName: `Key1`

    Click Send Data. A tuple appears in the Output Streams view from the `MapRemoveStatus` stream to indicate that the message was successfully removed from the map.

14. When done, press F9 or click the Terminate EventFlow Fragment button.

## Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

### Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

    studio-workspace/sample_adapter_embedded_tibco-ftl

See Default Installation Directories for the default location of `studio-workspace` on your system.