Salesforce Reader programmer's reference

API End Point

String

The endpoint for your Force.com REST API.

Auth Token

com.webaction. security.Password

See Configuring OAuth for Salesforce Reader.

When Auto Auth Token Renewal is True, this property is ignored and does not appear in Flow Designer.

If autoAuthTokenRenewal is set to false , specify your Salesforce access token (see Set Up Authorization on developer.salesforce.com: the first section, "Setting Up OAuth 2.0," explains how to create a "connected app"; the second section, "Session ID Authorization," explains how to get the token using curl).

Auto Auth Token Renewal

String

false

See Configuring OAuth for Salesforce Reader.

With the default value of False, when the specified Auth Token expires the application will halt and you will need to modify it to update the auth token before restarting. This setting is recommended only for development and testing, not in a production environment. When this property is False, you must specify Auth Token, Password, and Username.

Set to True to renew the auth token automatically. In this case, leave Auth Token blank and set the Consumer Key, Consumer Secret, Password, Security Token, and Username properties.

Connection Profile Name

String

Used when the Use connection profile property is set to True .

Select the name of the Salesforce Reader connection from the list.

Connection Retry Policy

String

retryInterval=30, maxRetries=3

With the default setting, if a connection attempt is unsuccessful, the adapter will try again in 30 seconds (retryInterval. If the second attempt is unsuccessful, in 30 seconds it will try a third time (maxRetries). If that is unsuccessful, the adapter will fail and log an exception. Negative values are not supported.

Consumer Key

String

When Auto Auth Token Renewal is False, this property is ignored and does not appear in Flow Designer.

If autoAuthTokenRenewal is set to true, specify the Consumer Key (see Set Up Authorization on developer.salesforce.com).

Consumer Secret

com.webaction. security.Password

When Auto Auth Token Renewal is False, this property is ignored and does not appear in Flow Designer.

If autoAuthTokenRenewal is set to true, specify the Consumer Secret (see Set Up Authorization on developer.salesforce.com).

Custom Objects Only

Boolean

False

By default, both standard and custom objects are included. Set to trueto include only custom objects and exclude standard objects.

JWT Keystore Path

String

When Auto Auth Token is False or OAuth Authorization Flows is PASSWORD, this property is ignored and not visible in the Flow Designer.

See Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration.

JWT Keystore Password

com.webaction. security.Password

When Auto Auth Token is False or OAuth Authorization Flows is PASSWORD, this property is ignored and not visible in the Flow Designer.

See Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration.

JWT Certificate Name

String

When Auto Auth Token is False or OAuth Authorization Flows is PASSWORD, this property is ignored and not visible in the Flow Designer.

See Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration.

Migrate Schema

Boolean

False

Do not change this setting. It is reserved for use by applications created using Auto Schema Conversion wizards (see Using Auto Schema Conversion).

Mode

Select list

Controls the basic behavior of the adapter. Use the default setting Initial load to load all existing data using force-rest-api 0.28 and stop.

Set to  Bulk load to load all existing data using the Salesforce  Bulk APIand stop. The bulk load currently loads all existing data synchronously, similar to the Initial Load process.

Set to Incrementalto read new data continuously using force-rest-api 0.28.

Set the value to Automated to perform both initial load and incremental load. See Salesforce Reader.

OAuth Authorization Flows

Enum

PASSWORD

When Auto Auth Token Renewal is False, this property is ignored and does not appear in Flow Designer.

With the default value of PASSWORD, Salesforce Writer will authorize using OAuth 2.0 username and password (see Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 Username-Password Flow for Special Scenarios). In this case, you must specify values for the Consumer Key, Consumer Secret, Password, Security Token, and Username properties.

Set to JWT_BEARER to authorize using OAuth 2.0 JWT bearer tokens instead (see Salesforce Help> Docs> Identify Your Users and Manage Access > OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration). In this case, you must specify the Consumer Key, JWT Certificate Name, JWT Keystore Password, JWT Keystore Path, and Username properties.

Objects

See sObjects.

Password

com.webaction. security.Password

When Auto Auth Token Renewal is False or OAuth Authorization Flows is JWT_BEARER, this property is ignored and not visible in the Flow Designer.

When Auto Auth Token Renewal is set to true, specify the password for the specified username.

Polling Interval

String

5 min

This property controls how often the adapter reads from the source. By default, it checks the source for new data every five minutes. If there is new data, the adapter reads it and sends it to the adapter's output stream. If you encounter Salesforce REQUEST_LIMIT_EXCEEDED errors, you may need to increase this value or contact Snowflake to raise your API limits (see Salesforce Developer Limits and Allocations Quick Reference). The maximum value is 120 min.

Return Picklist Data As

enum

api

Added in Striim 4.2.0.4.

With the default value of api, data from picklist fields will be returned as the API name. Set to valueto return the field value instead, or to apiAndValueAsJsonto return both the API name and field value as a JSON string.

Security Token

String

When Auto Auth Token Renewal is False or OAuth Authorization Flows is JWT_BEARER, this property is ignored and not visible in the Flow Designer.

When Auto Auth Token Renewal is set to true, specify the security token for the specified username (see Reset Your Security Tokenon help.salesforce.com).

SObjects

String

%

In the Flow Designer this property is shown as Objects.

Do not modify this property when recovery is enabled for the application.

With the default wildcard value %, all available objects associated with the specified API End Point will be read. To exclude standard objects, set Custom Objects Only to true.

Alternatively, specify one or more objects to read, separating multiple objects with semicolons, for example, Account; Business_C. Note that any child objects (see Object Relationships Overview) must be specified explicitly, they are not included automatically when you specify the parent.

The objects must be queryable. The account associated with the specified Auth Token must have View All Data permission for the objects.

Start Timestamp

String

By default, Salesforce Reader reads only new events. Optionally, specify the time (based on LastModifiedDate) from which to start reading older events in the format YYYY-MM-DDTHH:MM:SS. If the Salesforce organization's time zone is not the same as Striim's, convert the Salesforce start time to UTC (GMT+00:00) and include a Zat the end of the string. See SimpleDateFormatfor more information.

Thread Pool Size

Integer

5

Set this to match your Salesforce Concurrent API Request Limit (see API Request Limits and Allocations).

Use Connection Profile

Boolean

Set to True to use a connection profile instead of specifying the connection properties here. See Using connection profiles.

Username

String

When Auto Auth Token Renewal is False, this property is ignored and does not appear in Flow Designer.

When Auto Auth Token Renewal is set to true, specify an appropriate username (see Add a Single Useron help.salesforce.com).