QuerySalesforceObject

Description:

Retrieves records from a Salesforce sObject. Users can add arbitrary filter conditions by setting the 'Custom WHERE Condition' property. 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. It's also possible to define an initial cutoff value for the age, filtering out all older records even for the first run. This processor is intended to be run on the Primary Node only. FlowFile attribute 'record.count' indicates how many records were retrieved and written to the output.

Additional Details...

Tags:

salesforce, sobject, soql, query

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
URLsalesforce-urlThe URL for the Salesforce REST API 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 Versionsalesforce-api-version54.0The 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)
sObject Namesobject-nameThe Salesforce sObject to be queried
Supports Expression Language: true (will be evaluated using variable registry only)
Field Namesfield-namesComma-separated list of field names requested from the sObject to be queried
Supports Expression Language: true (will be evaluated using variable registry only)
Read Timeoutread-timeout15 sMaximum time allowed for reading a response from the Salesforce REST API
Supports Expression Language: true (will be evaluated using variable registry only)
OAuth2 Access Token Provideroauth2-access-token-providerController Service API:
OAuth2AccessTokenProvider
Implementation: StandardOauth2AccessTokenProvider
Service providing OAuth2 Access Tokens for authenticating using the HTTP Authorization Header
Record Writerrecord-writerController Service API:
RecordSetWriterFactory
Implementations: RecordSetWriterLookup
XMLRecordSetWriter
FreeFormTextRecordSetWriter
CSVRecordSetWriter
ScriptedRecordSetWriter
AvroRecordSetWriter
JsonRecordSetWriter
ParquetRecordSetWriter
Service used for writing records returned from the Salesforce REST API
Create Zero Record FlowFilescreate-zero-record-filesfalse
  • true
  • false
Specifies whether or not to create a FlowFile when the Salesforce REST API does not return any records
Age Fieldage-fieldThe 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)
Initial Age Start Timeinitial-age-filterThis 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 the [Age Field] Property has a value specified.
Age Delayage-delayThe 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 the [Age Field] Property has a value specified.
Custom WHERE Conditioncustom-where-conditionA custom expression to be added in the WHERE clause of the query
Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

NameDescription
successFor FlowFiles created as a result of a successful query.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mime.typeSets the mime.type attribute to the MIME Type specified by the Record Writer.
record.countSets the number of records in the FlowFile.

State management:

ScopeDescription
CLUSTERWhen 'Age Field' is set, after performing a query the time of execution is stored. Subsequent queries will be augmented with an additional condition so that only records that are newer than the stored execution time (adjusted with the optional value of 'Age Delay') will be retrieved. State is stored across the cluster so that this Processor can be run on Primary Node only and if a new Primary Node is selected, the new node can pick up where the previous node left off, without duplicating the data.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.