Salesforce Streaming API Adapter Sample

About the Sample

This sample uses the Spotfire Streaming 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 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-level menu, select File>Import Samples and Community Content.

  • Enter sales to narrow the list of options.

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

  • Click Import Now.

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 This Sample in StreamBase Studio

To run this sample:

  1. 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.

  2. Open the src/main/eventflow/packageName folder.

  3. Open the SalesForceStreaming.sbapp file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

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

  5. 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.


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:


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