Property

Description

Connection

Resource Name

The name of the resource, previously defined in the Resource Repository, that you selected in the Component Properties dialog box's Settings tab.

Operation

Object

Click to open the Objects List. Select the object that the operation will be performed on. This list is generated when you click the Objects List button in the Salesforce Resource dialog box.

Operation

Select one of the following operations from the drop-down list:

• Query: This is used to retrieve data from an object. You can use the Data Mapper to retrieve objects based on specific criteria. For example, you can retrieve all contacts with Title = Professor. If you want to retrieve all available contacts, you do not need to supply any mapping.

• Query All: This is identical to the Query operation except that it also returns the deleted records from Salesforce (deleted records are identified by the IsDeleted element true value).

• Create: This is used to create new objects in your organization’s data. You can use the Data Mapper to specify new object fields’ values.

• Bulk Create: This is identical to the Create operation except that it allows you to work with an external file containing many records.
  Since version: V3.2 SP1

• Update: This is used to update a specific object in your organization’s data. When you update an object, you need to know its ID. For example, you can use the Query operation (above) to retrieve an object ID, and then you can call the Update operation. You should use the Data Mapper to set the object ID, as well as the other fields that you want to update.

• Bulk Update: This is identical to the Update operation except that it allows you to work with an external file containing many records.
  Since version: V3.2 SP1

• Delete: This is used to delete a specific object from your organization’s data. If you want to delete an object, you need to know its ID. For example, you can use the Query operation (above) to retrieve an object ID, and then you can call the Delete operation. You should use the Data Mapper to set the object ID. This is the only value that you should set.

• Bulk Delete: This is identical to the Delete operation except that it allows you to work with an external file containing many records.
  Since version: V3.2 SP1

• Upsert: This is used to prevent inserting of duplicate records into Salesforce. The Upsert operation checks, based on field values, the existence of an object instance and updates the object if one exists or inserts a new one if it does not. The Upsert option is only available for objects that can be both updated and created.

• Bulk Upsert: This is identical to the Upsert operation except that it allows you to work with an external file containing many records.
  Since version: V3.2 SP1

Batches Mode

This field is only available when you select one of the Bulk operations in the Operation field. It enables you to control the way in which a job processes batches. Select one of the following from the drop-down list:

• Parallel (default): Batches are processed simultaneously.

• Linear: Batches are processed one after the other.

Since version: V3.2 SP1

Batch Size

This field is only available when you select Create, Update, or Upsert in the Operation field.

This controls the maximum number of objects sent in each request to Salesforce. Enter a value between 1 and 200.

Since version: V3.3

Upsert Field Name

This field is only available when you select Upsert or Bulk Upsert in the Operation field.

The fields that are listed are the unique fields for the selected object. At least one object must be selected for the Upsert lookup process. The selected object must be mapped with a value later on.

When working with the Bulk Upsert operation, the field selected here must also be selected in the Object Fields List so that it will appear in the Data Mapper screen.

For more details, see the Upsert operation in the Salesforce API documentation.

New Object ID

This field is only available when you select Create or Upsert in the Operation field.

Click to open the Variables List and select a variable that will hold the object ID that was upserted.

Return Fields

This field is only available when you select Query or Query All in the Operation field.

You can choose All by selecting the adjacent check box, or you can select specific fields from the Object Fields List.

Return Child Objects

This field is only available when you select Query, Query All, or Create in the Operation field.

If you selected Query or Query All in the Operation field, the object will be fetched together with its selected child objects to a single XML file.

You can perform a query on both the parent object and its child objects.

If you selected Create in the Operation field, the object will be fetched together with its selected child objects.

Click to open the Child Objects of Account List. Here, you can select the child objects that you want to return.

Since version: V3.3

Object Fields

This field is only available when you select one of the Bulk operations in the Operation field.

Click to open the Object Fields List. This enables you to select the required object fields and fill in their relationship details. You can enter relationship data for Index and External ID fields only. By default, no fields are selected.

Since version: V3.2 SP1

Return Job ID

This field is only available when you select one of the Bulk operations in the Operation field.

Click to open the Variables List and select a variable that will hold the returned job ID.

Since version: V3.2 SP1

Result Options

Store result in

Defines where you want to store the resulting XML file. Select one of the following from the drop-down list:

• File: Select a file to hold the object data that is returned by Salesforce. Click to open the Expression Editor or click and enter the file path where this information is to be stored.

• Variable (default is C.UserBlob): Select a variable to hold the object data that is returned by Salesforce.
  Click to open the Variables List. Select a variable where this information is to be stored.

• Split files: Splits a large XML file into several smaller XML files. If you select this option, you need to enter the required information in the Split Files Options section of this dialog box (below). Since version: V3.2 SP1

Operation success

This field lets you easily determine if the data object was successfully located in Salesforce. Select one of the following from the drop-down list:

• None (default): Select this option if you do not want to save the connector’s success or failure status.

• Variable: Select the variable where you want to store the connector's success or failure status.

Split Files Options

Since version: V3.2 SP1

Directory

The directory holding the split files. Click to open the Expression Editor and enter the directory name.

Prefix

The prefix of the split files. Click to open the Expression Editor and enter the prefix.

Records per file

The number of records in each split file. Click to open the Expression Editor and enter the required number of records.

Number of splits

The numeric variable where the number of splits will be returned to. Click to open the Variables List and select the required variable.

Button

Description

Refresh XSD

Refreshes the current schema.

When you click Refresh XSD, the current schema is overwritten. A message dialog opens, and clicking OK confirms the update and the overwrite. Clicking Cancel exits the process without updating the schema.