Salesforce Streaming API Adapter Sample

About the Sample

This sample uses the TIBCO StreamBase® Input Adapter for Salesforce Streaming API to listen to streaming events from a Salesforce platform based on a given topic.

The two operators in this StreamBase sample are set up to work with Salesforce Streaming API developer samples.

  • The TopicStream operator listens for changes to the /topic/InvoiceStatementUpdates topic.

  • The GenericStream operator listens for changes to the /u/notifications/ExampleUserChannel notifications.

Topics, notifications, and Salesforce samples are described in the Force.com Streaming API Developer Guide. Refer to that third-party Guide to set up this StreamBase sample for your Salesforce instance.

Importing This Sample into StreamBase Studio

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

  • From the top menu, select FileLoad StreamBase Sample.

  • In the search field, enter sales to narrow the list of samples.

  • Select Salesforce Streaming API input adapter from the StreamBase Standard Adapters category.

  • Click OK.

StreamBase Studio creates a single project containing the sample files.

Sample Setup

Before running the sample, open the supplied engine.conf located in src/main/configurations and edit your applicable properties for your Salesforce account.

Running the Sample in StreamBase Studio

To run this sample:

  1. In the Project Explorer, open the sample you just loaded.

  2. Open the src/main/eventflow folder.

  3. Open the package folder (most samples contain a single package folder. Open the top-level package folder if your sample contains more than one folder).

  4. Open the named application file and click the Run button. This opens the SB Test/Debug perspective and starts the application.

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

    If red marks do not resolve themselves in a moment, select the project and right-click MavenUpdate Project from the context menu.

  5. In the Output Streams view, look for the status and data tuples for the selected operation.

  6. When done, press F9 or click the Stop Running Application 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_salesforce

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