Retrieves records from a Salesforce sObject. Users can add arbitrary filter conditions by setting the 'Custom WHERE Condition' property. The processor can also run a custom query, although record processing is not supported in that case. Supports incremental retrieval: users can define a field in the 'Age Field' property that will be used to determine when the record was created. When this property is set the processor will retrieve new records. Incremental loading and record-based processing are only supported in property-based queries. It's also possible to define an initial cutoff value for the age, filtering out all older records even for the first run. In case of 'Property Based Query' this processor should run on the Primary Node only. FlowFile attribute 'record.count' indicates how many records were retrieved and written to the output. The processor can accept an optional input FlowFile and reference the FlowFile attributes in the query.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|
| Salesforce Instance URL | salesforce-url | | | The URL of the Salesforce instance including the domain without additional path information, such as https://MyDomainName.my.salesforce.com
Supports Expression Language: true (will be evaluated using variable registry only) |
| API Version | salesforce-api-version | 54.0 | | The version number of the Salesforce REST API appended to the URL after the services/data path. See Salesforce documentation for supported versions
Supports Expression Language: true (will be evaluated using variable registry only) |
| Query Type | query-type | Property Based Query | - Property Based Query
 - Custom Query
| Choose to provide the query by parameters or a full custom query. |
| Custom SOQL Query | custom-soql-query | | | Specify the SOQL query to run.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the [Query Type] Property has a value of "Custom Query". |
| sObject Name | sobject-name | | | The Salesforce sObject to be queried
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [Query Type] Property has a value of "Property Based Query". |
| Field Names | field-names | | | Comma-separated list of field names requested from the sObject to be queried. When this field is left empty, all fields are queried.
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [Query Type] Property has a value of "Property Based Query". |
| Record Writer | record-writer | | Controller Service API:
RecordSetWriterFactory
Implementations: JsonRecordSetWriter
RecordSetWriterLookup
AvroRecordSetWriter
XMLRecordSetWriter
FreeFormTextRecordSetWriter
CSVRecordSetWriter
ParquetRecordSetWriter
ScriptedRecordSetWriter | Service used for writing records returned from the Salesforce REST API
This Property is only considered if the [Query Type] Property has a value of "Property Based Query". |
| Age Field | age-field | | | The name of a TIMESTAMP field that will be used to filter records using a bounded time window.The processor will return only those records with a timestamp value newer than the timestamp recorded after the last processor run.
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if the [Query Type] Property has a value of "Property Based Query". |
| Initial Age Start Time | initial-age-filter | | | This property specifies the start time that the processor applies when running the first query.
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if all of the following conditions are met:- The [Age Field] Property has a value specified.
- The [Query Type] Property has a value of "Property Based Query".
|
| Age Delay | age-delay | | | The ending timestamp of the time window will be adjusted earlier by the amount configured in this property. For example, with a property value of 10 seconds, an ending timestamp of 12:30:45 would be changed to 12:30:35.
Supports Expression Language: true (will be evaluated using variable registry only)
This Property is only considered if all of the following conditions are met:- The [Age Field] Property has a value specified.
- The [Query Type] Property has a value of "Property Based Query".
|
| Custom WHERE Condition | custom-where-condition | | | A custom expression to be added in the WHERE clause of the query
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
This Property is only considered if the [Query Type] Property has a value of "Property Based Query". |
| Read Timeout | read-timeout | 15 s | | Maximum time allowed for reading a response from the Salesforce REST API
Supports Expression Language: true (will be evaluated using variable registry only) |
| Create Zero Record FlowFiles | create-zero-record-files | false | | Specifies whether or not to create a FlowFile when the Salesforce REST API does not return any records
This Property is only considered if the [Query Type] Property has a value of "Property Based Query". |
| OAuth2 Access Token Provider | oauth2-access-token-provider | | Controller Service API:
OAuth2AccessTokenProvider
Implementation: StandardOauth2AccessTokenProvider | Service providing OAuth2 Access Tokens for authenticating using the HTTP Authorization Header |