Salesforce Input

(warning) PLEASE NOTE: This documentation applies to an earlier version. For the most recent documentation, visit the Pentaho Enterprise Edition documentation site.

Description

The SalesForce Input step provides you with the ability to read data directly from SalesForce using the SalesForce Web Service. The following sections describe each of the available features for configuring the SalesForce Input step.

Settings Tab

The settings tab is where you configure the SalesForce WebService URL, login credentials, module to query from and query conditions:

Input

Description

SalesForce Webservice URL

This is the URL to the SalesForce Webservice.
Note: This URL is dependent on the API version you are using:

  • PDI 3.2.x uses API version 10.0. 
  • PDI 4.3 until 6.1 use API version 24.0.
  • PDI 7.0 and later versions use API version 37.0.

Username

Username for authenticating to Salesforce (i.e. myname@pentaho.com)

Password

Password for authenticating to Salesforce.  Enter your password followed by your security token.  If you password is 'PASSWORD' and your secuirty token is 'TOKEN', enter 'PASSWORDTOKEN' in this field.

Module

Select the module you wish to retrieve data from.  Note: This list will be populated upon successfully authenticating to Salesforce using the Test Connection button.

Query Condition

Enter any query filters you wish to apply.  For example, 'fieldname=myvalue AND fieldname2=myvalue2...'
Note that you do NOT need to include WHERE in your condition statement and variables are supported for this field.

Content

The content tab allows you to optionally include additional descriptive fields in the result set

Option

Description

Include URL in Output?

Enable to add a field to the output containing the URL used to retrieve the data.

Include Module in output?

Enable to add a field to the output containing the module from which the data was retrieved.

Include SQL in output?

Enable to add a field to the output containing the SQL used to generate the result set.

Include timestamp in output?

Enable to add a field to the output containing the timestamp for when the record was retrieved.

Include Rownum in output?

Enable to add a field to the output containing a row number for each record retrieved.

Time out

Configure the timeout interval in milliseconds before the step times out.

Limit

Configure the maximum number of records to retrieve.  Note: Setting this to '0' means there will be no limit placed on the number of records that can be retrieved.

Fields

The fields tab displays the fields that will be read from the SalesForce object (Module chosen on the Settings tab). You will need to go to the Fields tab and press the "Get Fields" button to populate the fields returned before being able to preview the rows returned.