Contents
The TIBCO StreamBase® Input Adapter for Salesforce Streaming API allows StreamBase to connect to the Salesforce Streaming API and subscribe to a specific topic to streaming the topic in real time.
Use the Force.com Streaming API Developer Guide to set up example streams; the adapter can be used for both subject streams as well as generic streams based on topic and schema.
The adapter is written based on the Salesforce Streaming API v41.
This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component, which must be unique in the current EventFlow module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.
Adapter: A read-only field that shows the formal name of the adapter.
Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.
Start with application: If this field is set to Yes (default) or to a module parameter that evaluates to true, this instance of this adapter starts as part of the JVM engine that runs this EventFlow module. If this field is set to
No or to a module parameter that evaluates to false, the adapter instance is loaded with the engine, but does not start until you send an sbadmin resume command, or until you start the component with StreamBase Manager.
Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.
Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Type | Description |
|---|---|---|
| Topic | string | The topic to listen to |
| Replay | drop-down list | Replay the topic from earliest, from tip, or from a specific index. If specific index is selected, then enter that index into the Replay Index field. |
| Replay Index | int | Replay the topic from the specific value |
| Timestamp Format | string | The timestamp format to use when converting date time objects to StreamBase timestamp data types |
| Log Level | INFO | Controls the level of verbosity the adapter uses to issue informational traces to the console. This setting is independent of the containing application's overall log level. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
| Property | Type | Description |
|---|---|---|
| Authentication Type | drop-down list | The authentication type to use, currently basic authentication is supported |
| Username | string | The username to be sent when logging in |
| Password | string | The password to be sent when logging in |
| Security Token | string | The security token to be sent when logging in |
| Login URL | string | The URL to access the Salesforce login |
| Max Buffer Size | int | The max buffer size to use while streaming |
| Max Network Delay | int | The max network delay to use while streaming |
| Keep Alive (Minutes) | int | The number of minutes between keep alive checks |
| Connection Timeout (Seconds) | int | The number of seconds before a timeout exception occurs during login |
| Proxy Host | string | The proxy host to use with this connection or blank to not use a proxy |
| Proxy Port | int | The proxy port to use with this connection which is used only when the proxy host has a value |
Use the Edit Schema tab to declare the schema to match against the data payload of the streaming information that is sent for the topic selected. The topics JSON payload is loosely parsed into this schema, meaning fields in the JSON payload which are not represented in the schema are ignored.
Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.
Caution
Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.