Retrieves data from the Salesforce customer relationship platform using Salesforce Object Query Language (SOQL) queries.
How does it work?
SalesforceConnector executes a SOQL SELECT statement using the Salesforce Lightning Platform REST API. Each returned record is a feature in FME.
Refer to the Salesforce’s SOQL SELECT Syntax documentation for information on how to build a valid SOQL SELECT statement.
SalesforceConnector authenticates with Salesforce using OAuth 2.0.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
This transformer outputs a new feature for each record returned by the SOQL SELECT Statement.
The Attributes to Expose parameter may be used to expose the fields returned by the SOQL SELECT Statement. In addition, the following attributes are always exposed:
|
Attribute |
Description |
|---|---|
| salesforce_instance_url | The fully-qualified URL for the Salesforce instance in use. |
| salesforce_record_url | The URL that uniquely identifies the Record that this feature represents. It can be appended to salesforce_instance_url to obtain a fully-qualified URL. |
| salesforce_record_type | The Record type that this feature represents. Typically, this is value to the right of the FROM portion of the SOQL SELECT Statement. |
<Rejected>
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.
Note: If a feature comes in to the SalesforceConnector already having a value for fme_rejection_code, this value will be removed.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Connection
| Salesforce Account |
Performing operations against a Salesforce account requires the use of OAuth 2.0 authentication using a Web Connection. To create a Salesforce connection, click the 'Salesforce Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections. |
Request
HDFS Path
| SOQL SELECT Statement |
The Salesforce Object Query Language SELECT statement to send to Salesforce to retrieve records. Example: SELECT Name FROM Account |
| Include Deleted Records |
If this parameter is set to Yes, the QueryAll endpoint is used in order to include all deleted and archived records. |
Advanced
|
Attributes to Expose |
A list of attributes to expose on output features. These attributes should correspond to the fields specified by the SOQL SELECT Statement. |
|
API Version |
The Salesforce API Version to use for the request, for example,“41.0”. The available Record types and fields may change between API Versions. The default is to use the latest available version. It is an error to specify an API Version that is unrecognized by the Salesforce instance. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click 
beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
How to Set Parameter Values
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
Content Types
| These functions manipulate and format strings. | |
|
Special Characters |
A set of control characters is available in the Text Editor. |
| Math functions are available in both editors. | |
| Date/Time Functions | Date and time functions are available in the Text Editor. |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Table Tools
|
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
|
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
|
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
|
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | Salesforce account |
| Aliases | |
| History | Released FME 2018.0 |
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for all results about the SalesforceConnector on the FME Community.