Salesforce Source

Overview

Salesforce Source Component is SSIS Data Flow Component for consuming data from Salesforce Service. The configuration options are provided in the standard data flow source component dialog.

Setup

Use the options below to setup the component.

Options

SFORCE

Select an existing Salesforce connection manager.

Related Topics: Salesforce Connection Manager

BatchSize

Specify the number of rows to be retrieved as a batch. The maximum is 2000.

InputType

Specify input type. This property has the options listed in the following table.

Value Description
Object Input type is Salesforce object. Selecting this value displays the dynamic options Object, ObjectFilter (1.5 SR-2).
Statement Input type is SOQL statement. Selecting this value display the dynamic options Statement.

Note: After input change, you have to use Refresh command in the 'Column Mappings' tab to reload source object metadata.

Object

Select SalesForce data object.

ObjectFilter (1.5 SR-2)

Specify object filter statement using SOQL statement expressions.

Statement

Specify SOQL statement.

IncludeDeleted (1.4 SR-1)

Specify to include all records in result, including the deleted. This property has the options listed in the following table.

Value Description
True The deleted records are included in the result.
False The deleted records are not included in the result.

How to modify source dynamically at runtime?

The source object or statement are available in the data flow properties list. Follow these steps to setup expression:

  • Right-click on data flow canvas and select Properties menu.
  • Scroll-down and find property named like [Salesforce Source].[Statement]. This is the property containing the statement.
  • Scroll-down and find Expressions property. Setup expression to modify the statement dynamically.

How to include the missing columns when using SOQL statement?

Salesforce service only returns fields containing data. If there is no data for specific field, no data is returned. Therefore it is impossible to setup the appropriate field and field type. There are 3 options to include the missing columns:

Option 1

This option will work fine for SOQL statements without relationships. For statements with relationships check the other options below.

  1. Set InputType to Object. Select the object from which you want to retrieve data.
  2. Go to the 'Column Mappings' tab and press 'Refresh' to reload object's columns.
  3. Set InputType to Statement and specify your statement. Do not refresh the columns in the 'Column Mappings' tab.
  4. If you want to remove columns you don't need, go to the 'Column Mappings' tab and remove the mappings you don't need.
Option 2
  1. Setup temporary Salesforce record and required relationship data.
  2. Open 'Salesforce Source' component setup dialog and specify SOQL statement retrieving the temporary record data.
  3. Refresh 'Column Mappings' tab. All needed column metadata should be now included.
  4. Go back to the Salesforce setup window and remove the temporary record and all other unneeded data.
Option 3

This option requires manual definition of the missing columns.

  1. Go to 'Input and Output Properties' tab.
  2. Go to 'Salesforce Source Output' -> 'External Columns'.
  3. Press 'Add Column'.
  4. Specify column name and type. Make sure the name is specified properly with the appropriate structured definition.