Metadata for Salesforce - Data360_Analyze - 3.12

Data360 Analyze Server Help

Data360 Analyze
Product family
Product name
Data360 Analyze
Data360 Analyze Server Help
First publish date

Retrieves metadata in SALESFORCE.COM objects via the SALESFORCE.COM REST API.

The Metadata for Salesforce node enables easy and fast access to SALESFORCE.COM via SALESFORCE.COM's REST API.

Each input record represents a single REST API call. Therefore, if the node has 10,000 input records, this node will make 10,000 API calls. Be sure to keep your call capacity in mind when using this node.

A maximum of one input pin is permitted.

If any node property is set to Field then the data must exist on this 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.

The request URL is created from the ObjectName property. The base REST URL used in the metadata request is retrieved from the response to the user's SALESFORCE.COM login request. The node then appends the ObjectName to the base URL to create the appropriate URLs for each call.

The MetadataOperation property can be set to either show all objects in the SALESFORCE.COM database (default) or to show the metadata of the specified object. This information is displayed on the Data output pin.

The Metadata for Salesforce node produces three outputs: Data, Relationships and sessionData. All data is output as strings.

The Data output pin contains details of the data read from SALESFORCE.COM objects.

The Relationships output pin contains details of the relationships between objects.

The sessionData pin contains data about the session such as the ID and URL.

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. The node does not support System proxy detection, therefore if a proxy server is used to access Salesforce the ProxyUrl property must be specified.



Optionally specify the operation to be performed on the SALESFORCE.COM environment. Choose from:

  • Show Objects in Database - Lists the objects in the SALESFORCE.COM database.
  • Show Object Metadata - Lists information about the columns in the specified ObjectName.

The default value is Show Objects in Database.

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


Optionally specify the SALESFORCE.COM object that this call will affect.

The object is only used if the metadata operation selected is - Show Object Metadata.

This string is identical to the SObject type that would be put into a standard request URL. For example, to read an Account object, the ObjectName property should have the value "Account". This would correspond to a URL suffix such as the one shown below:


where the Account string replaces the SObject type.

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


Optionally specify the URL of the Salesforce server hosting the Salesforce instance (e.g. The URL must be correctly formatted, or the node will fail.

The default URL is


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

A value is required for this property.


Specify the password to login to the SFDC server.

A value is required for this property.


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.


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.


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:


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.


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.


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


Optionally specify the URL of a 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:
  • HTTPS proxy:

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


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

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


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

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


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.


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.


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.


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.


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.


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 optional.

Outputs: Data, Relationships.