Data360 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

This deprecated node queries SALESFORCE.COM objects via SOQL over the SALESFORCE.COM REST API.

CAUTION:
This node has been deprecated and will not be supported in a future release. As an alternative, the [%=GeneralPlatform%] Get for Salesforce (Superseded) node can be used to provide similar functionality.

The node takes in SOQL queries, all of which come from a single field on the input pin, and processes them one by one, as they are input. If a query does not succeed, the node will not fail; rather, it will add a record to the Error output pin and continue processing. The node fails only if it cannot log into the SALESFORCE.COM server or if the SfdcVersion property is invalid.This node produces three outputs: Summary, Records, and Error. All input fields are passed to the output in order to facilitate tracing error data and matching up summary data with records.The Summary output contains summary, or aggregate, data. This data may include a record count. If a query returns only aggregate fields, then only this pin will have output data.The Data 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 Error pin contains the input fields of any queries that fail. It will also contain any error data that SALESFORCE.COM returns.

Properties

QueryField

Specify the name of the input field with the SOQL queries.

A value is required for this property.

SfdcUsername

Specify the username under which to make this node's queries.

A value is required for this property.

SfdcPassword

Specify the password of the user.

A value is required for this property.

SfdcSecurityToken

When the Data360 Analyze server is on a machine with an IP address that SALESFORCE.COM trusts, then the password alone can enable the user to login. However, if the server is not on a machine with a trusted IP address, then the SALESFORCE.COM Security Token must also be provided in order to log in.

This token is used for all calls from this node.

SfdcVersion

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

v<version>/query/?q=<Query>

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.

The default value is 27.0.

NullValueBehavior

Optionally specify how the node reacts if the Query field is null. The node may stop processing and report an error, log the error and continue processing, or simply ignore the null value in its entirety.

The default value is Error.

OutputDataFormat

Optionally specify if the data returned by SALESFORCE.COM will be output as individual fields or as raw XML. In most cases, the default, Fields, will be desired. However, in cases where performance is important, the XML option can help speed things up. Once the node outputs XML, the user can configure successor nodes to process only a subset of the XML data, thus saving either disk space or time.

If Fields is chosen, then the Summary pin will contain summary data about the output, such as returned record count. The Data pin will contain the individual record fields returned by the related query. The message and error codes will also be parsed on the Error pin.

If XML is chosen, then the Summary pin will have zero records. The Data pin will contain the raw XML returned by SALESFORCE.COM for each query. This XML data will be contained in a field named "_XML". The Error pin will similarly have an "_XML" field that contains the raw XML with the error message.

The default value is Fields.

ProxyUrl

Optionally specify the URL of the proxy server to use to access SALESFORCE.COM. 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 does not support automatic detection of system proxy settings at this time.

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 ProxyUrl is not set.

IgnoreSystemProxy

If proxy settings are not defined then the system proxy is automatically used. This optional property tells Data360 Analyze to Ignore the system proxy when set to True.

The default value is False.

Inputs and outputs

Inputs: in1.

Outputs: Summary, Records, Error.