Query for Salesforce - Data360_Analyze - 3 - 3.12

Data360 Analyze Server Help

Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 Analyze
Version
3.12
Language
English
Product name
Data360 Analyze
Title
Data360 Analyze Server Help
Copyright
2023
First publish date
2016

Queries SALESFORCE.COM objects via SOQL over the SALESFORCE.COM REST API.

The node takes in SOQL queries which can be provided as a default value. Alternatively, the queries can come from a single field on the input pin, and the node processes them one by one, as they are input.

A maximum of one input pin is permitted.

If the Query property is set to Field then the SOQL query must exist in that input pin.

The node uses the connected app and OAuth 2.0 authorization to access REST API, using the mandatory username, password, clientId and clientSecret credential fields.

It produces one output.

The Records pin contains all returned records. The field names differ depending upon the query used. If a node makes multiple calls with different returned metadata, the output has the union of all field names.

The ProxyUrl property can be used to provide the URL of a proxy server with any corresponding authentication details in the ProxyUsername and ProxyPassword properties.

Properties

Query

Specify the SOQL query.

Choose the (from Field) variant of this property to look up the value from an input field with the name specified.

A value is required for this property.

ServerUrl

Optionally specify the URL of the Salesforce server hosting the Salesforce instance (e.g. https://test.salesforce.com). The URL must be correctly formatted, or the node will fail.

The default URL is https://login.salesforce.com

SfdcUsername

Specify the name of the user under which to make all this node's calls.

A value is required for this property.

SfdcPassword

Specify the password to login to the SFDC server.

A value is required for this property.

SfdcClientId

The connected app's consumer key, which you can find on the connected app's Manage Connected Apps page, or from the connected app's definition.

SfdcClientSecret

The connected app's consumer secret, which you can find on the connected app's Manage Connected Apps page, or from the connected app's definition.

Output Fields

Optionally specify which fields will be used for the output in a scenario where no records are returned from Salesforce.

Where no type is specified this will default to Unicode.

However if no fields are specified this will result in Error.

SfdcVersion

Optionally specify the SALESFORCE.COM API version that is used for all calls from this node. The string provided is placed directly into the request URL as shown below:

v<version>/sobjects/<SObjName>

Notice that the "v" that precedes the version number is not included in this property as it is prepended to the value in this property by the node.

The default value is set to latest available version.

ConnectionTimeout

Optionally specify the maximum period (in seconds) to wait before the connection times out. By default, a connection timeout period does not apply.

PassThroughFields

Optionally specify which input fields will "pass through" the node unchanged from the input to the output, assuming that the input exists. The input fields specified will appear on those output records which were produced as a result of the input fields. Choose from:

  • All - Passes through all the input data fields to the output.
  • None - Passes none of the input data fields to the output; as such, only the fields created by the node appear on the output.
  • Used - Passes through all the fields that the node used to create the output. Used fields include any input field referenced by a property, be it explicitly (i.e. via a "field1" reference) or via a field pattern (i.e. "1:foo*").
  • Unused - Passes through all the fields that the node did not use to create the output.

The default value is Used.

If a naming conflict exists between a pass-through field and an explicitly named output field, an error will occur.

AllRecords

Optionally set to True to include deleted records.

The default value is False.

RetryCondition

Optionally specify under what conditions to retry a request.

Choose from:

  • Never - Never retry a request.
  • Http Status Error - Retry the request if the response status code is in the 4xx client error or 5xx server error categories.
  • Network Error - Retry the request if a network error occurs. A network error is any low level network error that might occur. This could be a socket o r connection timeout, TLS error and so on.
  • Any Error - Retry the request if the response contains a http status error or a network error.

The default value is Never.

RetryTimeout

Optionally specify the maximum total amount of time to attempt to retry a failed request regardless of the number of attempts.

The default value is unlimited, the node will not timeout.

RetryDelayFalloff

Optionally specify the floating point fall-off factor that is used to calculate the next retry delay. A fall-off of 1.0 would keep the delay the same for every retry. A fall-off greater than 1.0 will increase the delay and a fall-off less than 1 will decrease the delay.

Negative numbers are invalid.

The default value is 1.0.

ProxyUrl

Optionally specify the URL of the proxy server to use for the HTTP requests. The URL should contain the protocol (http or https), the host, and the port. All other parts of the URL will be ignored.

The URL should be in a format similar to the following:

  • HTTP proxy: http://proxy.example.com:1234
  • HTTPS proxy: https://proxy.example.com:443

The node supports automatic detection of system proxy settings To override system proxy settings see the IgnoreSystemProxy property.

ProxyUsername

Optionally specify the proxy username, where the proxy requires authentication.

This property should be left blank if ProxyUrl is not set.

ProxyPassword

Optionally specify the proxy password, where the proxy requires authentication.

This property should be left blank if ProxyUsername is not set.

ProxyAuthenticationMethod

Optionally specify the authentication method used to verify the user of the proxy server. Choose from:

  • Basic
  • Digest
  • NTLM

If not set the system will try to automatically detect the best one. Not set by default.

Enabled

Optionally specify whether the node is enabled or disabled. You can either choose from True or False, or reference another property (see the topic Using derived property values) which will be evaluated to a true/false value.

Disabled nodes are not executed, even if they are selected to run.

The default value is True.

Note: The Enabled property cannot reference (either directly or indirectly) any of the Run Properties of a data flow.

LogLevel

Optionally specify the level at which non-fatal messages are logged. The lower the level, the more information will be recorded in the log file. Choose from:

  • 0 - Information
  • 1 - Low
  • 2 - Medium
  • 3 - High
  • 4 - Fatal

The default value is 2 (Medium), which can be changed in the ls_brain_node.prop configuration file by modifying the property ls.brain.node.logLevel.

Inputs and outputs

Inputs: 1.

Outputs: Records.