Data360 Metadata for Salesforce (Superseded) - 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

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

Note: This node has been superseded by the Metadata for Salesforce node which provides similar functionality, but the underlying code is Python rather than Data360 Analyze Script. The Data360 Metadata for Salesforce (Superseded) node is provided for backwards compatibility, but where possible it is recommended that you use the new Metadata for Salesforce node.

The Data360 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 2 input pins permitted.

If any node property is set to Field then the data must exist on the first input pin. If all node properties are literal and only one input pin exists then the session data may be included; however if there are 2 input pins specified then the session data must exist on the second pin.

Session data

The Data360 Get For Salesforce node, Data360 Metadata For Salesforce node and Data360 Update For Salesforce nodes output session data on the sessionData pin as provided by the SALESFORCE.COM REST API. This sessionData pin can then be connected to another instance of the Data360 For Salesforce nodes to enable the node to re-use the previously created session (to optimize performance).

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

Properties

MetadataOperation

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.

ObjectName

Specify the SALESFORCE.COM object that this call will affect.

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 this below:

<version>/sobjects/Account/describe

where you can see that the "Account" string fills in for the SObject type.

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

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.

SfdcSecurityToken

Optionally specify a security token.

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 should also be provided in order to log in. This token is used for all calls from this node.

By default a token is not used.

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

ProxyUrl

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: http://proxy.example.com:1234
  • HTTPS proxy: https://proxy.example.com:443

The node supports automatic detection of system proxy settings. If the proxy URL is specified, the system proxy is not used.

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.

ConnectionTimeout

Optionally specify the maximum period (in seconds) to wait before the connection times out. By default, a connection timeout period of 60 seconds is applied.

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.

Inputs and outputs

Inputs: 2 optional.

Outputs: Data, Relationships, sessionData.