Reader Directives

The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the Salesforce Reader is SALESFORCE.

DATASET

This parameter specifies the host through which to log in to Salesforce. Upon successful login, the Salesforce Reader will automatically switch to a different host if necessary.

Required/Optional

Required

Mapping File Syntax

<ReaderKeyword>_DATASET login.salesforce.com

USER

This parameter specifies the user that accesses Salesforce.

Required/Optional

Required

Mapping File Syntax

<ReaderKeyword>_USER user@example.com

Workbench Parameter

User

PASSWORD

This parameter specifies the password for the user that accesses Salesforce.

Required/Optional

Required

Mapping File Syntax

<ReaderKeyword>_PASSWORD password

Workbench Parameter

Password

SECURITY_TOKEN

This parameter specifies the security token for accessing Salesforce. If Salesforce is being accessed outside of a trusted network, a security token is needed to log in.

Required/Optional

Optional

Mapping File Syntax

<ReaderKeyword>_SECURITY_TOKEN TiIeyLhXxGYDnshhctimJvSzz

Workbench Parameter

Security Token

DEF

Each Salesforce table may be defined before it can be read. A definition that specifies a subset of fields will reduce data transfer and processing time. If a definition is not present for a table, all fields and records will be retrieved. The syntax of the definition is:

SALESFORCE_DEF <objectName> \

[salesforce_sql_where_clause <whereClause>] \

[<fieldName> <fieldType>] +

SALESFORCE_DEF <objectName> \

[salesforce_sql_statement <sqlQuery>] \

[<fieldName> <fieldType>] +

Parameter	Contents
objectName	The name of the objects to be read.
salesforce_sql_statement	This specifies an SOQL SELECT query to be used as the source for the results. If this is specified, Salesforce will execute the query, and the Salesforce Reader will use the resulting rows as the features instead of reading from the table <objectName>. All returned features will have a feature type of <objectName>, and attributes for all columns selected by the query. The salesforce_where_clause is ignored if salesforce_sql_statement is supplied. Refer to Salesforce documentation for SOQL syntax and limitations.
salesforce_where_clause	This specifies the SOQL WHERE clause applied to object fields to limit the set of features returned. If this is not specified, then all the rows are returned. This keyword will be ignored if the salesforce_sql_statement is present.

Parameter

Contents

objectName

The name of the objects to be read.

salesforce_sql_statement

This specifies an SOQL SELECT query to be used as the source for the results.

If this is specified, Salesforce will execute the query, and the Salesforce Reader will use the resulting rows as the features instead of reading from the table <objectName>. All returned features will have a feature type of <objectName>, and attributes for all columns selected by the query. The salesforce_where_clause is ignored if salesforce_sql_statement is supplied. Refer to Salesforce documentation for SOQL syntax and limitations.

salesforce_where_clause

This specifies the SOQL WHERE clause applied to object fields to limit the set of features returned. If this is not specified, then all the rows are returned. This keyword will be ignored if the salesforce_sql_statement is present.