Salesforce Operation

Note: Before working with a Connector operation, you should be familiar with general Process development, building Connectors and the XML profile.

The Salesforce operation defines how to interact with your Salesforce account. The operation represents a specific action (e.g., Query, Create, Update, Delete) to be performed against a specific Salesforce record type or object (e.g., Account, Opportunity, Contact, etc.). You must create a separate operation component for each action/object combination required for your integration. Not all actions are available for every object.

Note: Contact your Salesforce Representative to learn about the API field-level requirements for Salesforce and how to access additional Help documentation. Also review the Salesforce Integration Best Practices page to further apply these configuration concepts.

Options Tab

Available Actions: Depending on how you create the Salesforce operation component, the Action type is either non-configurable or selectable from the drop-down list. The actions listed below describe the different settings that can be configured for each type.

[ QUERY ] [ CREATE ] [ UPDATE ] [ UPSERT ] [ DELETE ]

Import Wizard: The Import Wizard steps instruct you how to define the object you are integrating. It is required that you click the Import button and follow the wizard to successfully configure an operation and automatically generate the Response XML Profile that can include all required base and custom fields.

Select or Create the Salesforce Connection component and click Next.
Select the desired Object Type from the drop-down.
Select the desired Action from the drop-down and click Next. The options will differ based on the Get or Send Connector Action.
Check the child and/or parent objects that you would like to integrate along with the base object and click Next.
Review results and click Finish.

Standard Get Fields: This table describes the default field definitions for each inbound action type.

Field Name	Description
Object	Displays the object you selected in the Import Wizard.
Action	Displays the action you specified in the Import Wizard.
Response Profile	The XML Profile definition that represents the XML structure that is being returned to the Connector.
Include Deleted	If checked, returns deleted records in results (QueryAll).
Batch Results	If checked, combines results into a single List document.
Query Limit	Numeric field that allows you to specify maximum number of rows/documents to return (*Default -1 or blank is all results).

Standard Send Fields: This table describes the default field definitions for each outbound action type.

Field Name	Description
Object	Displays the object you selected in the Import Wizard.
Action	Displays the action you specified in the Import Wizard.
Request Profile	The XML Profile definition that represents the XML structure that is being sent to the Connector.
Batch Count	Numeric field that allows you to specify the number of documents you would like to send in one SFDC request.
Return Application Error Responses	Defines whether to forward responses through the Process or fail at the Connector level. If checked, failed operations will not be reported on the Manage menu, allowing you to act on them in your Process.

Inbound Actions

This section describes how the Salesforce operation can be configured to retrieve document records from a Salesforce organization instance. For all inbound operations, unique parameters are required at run-time to request data. Review the Setting Parameters section to understand how these parameter values can be statically or dynamically defined in a Process for run-time.

QUERY

This action returns zero to many object record documents from a single QUERY request based on zero or more "filters". It is the only Get Connector Action available for the Salesforce Connector. The bottom half of the operation component window contains configuration options that allow you to choose the fields to return, add filters to limit the results and select sorting options.

Objects Configuration

On the left side of the query window is a tree representing the objects that will be returned by the operation. Click the object name (for example, "Account") to display the configuration options to the right. If you selected any related child or parent objects during the Import Wizard, they will be displayed here as well. You can configure the fields, filters and sorting options for each object type.

Fields Configuration

By default, all fields for a highlighted object are checked, and it is a typical setting for most integration scenarios. Clearing a field's check box will remove it from the main query syntax. To quickly select or clear all the fields for a given object, use the check box next to the object's name at top of the field list. The Show SOQL button allows you to see the query syntax sent to Salesforce. This is automatically modified as you configure the fields, filters, and sorts. You cannot edit the syntax but it can be useful to verify complex nested filter logic.

Filters Configuration

Filters allow you to limit the records returned to those that match certain criteria. The filters essentially represent the input parameters for this operation. You will provide values to pass into the filter(s) when the operation is used, be it in a Connector step or a Connector call within a decision, Map function or other Process step.

Salesforce allows you to define multiple expressions and group them into logical sub-groups to create sophisticated query logic. The operator at the logical group level defines how the multiple expressions and/or logical sub-Groups within that logical group will be evaluated. Choose "AND" to return records that match all the expressions; choose "OR" to return records that match any of the expressions.

Note: Filters on child or parent objects will not affect the primary object. For example, suppose you are querying all accounts and want to return just contacts for the state of New York. If you created a filter on the Contact object to filter by State, you would still get all account records, but the related contact records for each account would only contain contacts from New York. If your integration scenario required returning only contacts from New York, make Contact the primary object (go through the Import Wizard again) and select Account as the related parent object.

To add a filter, click the drop-down ( ) on the "Logical - AND" node, choose "Add Expression", select the new expression and configure the settings to the right. To remove an expression, click the drop-down ( ) next to the expression and choose "Delete Expression". Similarly to add a Logical Sub-Group, click the drop-down next to another Logical Group and choose "Add/Insert Logical Sub-Group".

Filter Options

Field Name	Description
Filter name	Reference Name for expression. Common practice is to define the selected field name and associated operator (e.g., OrgName=).
Field	Filter placeholder that binds to the filter number defined in the associated Report ID.
Operator	Used to define how the request input parameter should be compared against the filter (e.g. = , != , >).

Sorts Configuration

You can sort the results by any field in the object. Click the Add ( ) icon to specify one or more fields by which to sort. Sorting logic is applied in the order specified. You can click the green up or down arrow icons to adjust the order. Click the Delete ( ) icon to remove sorting.

Field	Description
Sort Field	Use the Browse ( ) button to select the field by which to sort by.
Sort Order	Choose Ascending (default) or Descending.
Sort Nulls	Choose to put null (blank) values First (default) or Last.

Outbound Actions

This section describes how the Salesforce operation can be configured to send data to a Salesforce organization instance. For all outbound operations, request XML data needs to be sent into the Connector that corresponds with the defined XML profile. In most cases, request documents are the destination output of a Data Map. However, you can also set parameters on the outbound Connector's Parameter tab within the Process to supply static or dynamic request values.

CREATE

This action will create new records in the Salesforce object defined in the create operation. The internal 'ID' field is generated automatically per each document sent to the operation.

When Return Application Error Responses is checked:

Salesforce will return an XML response with a Success status and the newly generated object's internalID.

Salesforce will return an XML response with a Failure status along with a statusCode and error message.

UPDATE

This action will update existing records in the Salesforce object defined in the update operation. You must supply the internal 'ID' field in the request to update the existing object record. If this internal ID is not readily available in your source data, consider using a Connector Call function to QUERY data based on a standard value such as Name.

When Return Application Error Responses is checked:

Salesforce will return an XML response with a Success status and the object's internalID.

Salesforce will return an XML response with a Failure status along with a statusCode and error message

UPSERT

The Upsert Action is a convenient way to do common "insert-new-or-update-existing" integrations. Instead of having to do a lookup against the destination system (Salesforce) to determine if a given record exists and then perform separate insert or update mappings and calls accordingly, you can simply perform one map to the Upsert request and let Salesforce determine whether it really needs to do an insert or update.

To use this feature, you must customize the particular Salesforce object to designate at least one field as the External ID. Because objects can have multiple External IDs defined, you must select which one to use in the operation. Click the object name in the tree to the left and then click the Browse ( ) button to choose an External ID from the list.

Upsert Options Configuration

Field	Description
External ID	The External ID to use for the upsert. Salesforce will look for a record with a matching value and will update it if found or create it if not found.
Reference Fields	Fields in the primary upsert object that can link the record to other associated objects (Example: Acct to Parent Acct, Oppty to Acct).
Use External ID For Reference	Determines if a specific value should be used to perform the reference. Reference Fields will use internalID by default.
--Object Type	Indicates the object type to which the reference field is linked.
--Ref External ID	Identifies the data that will be used to perform the reference.

Note: Review the Salesforce Integration Best Practices to learn how to apply references.

When Return Application Error Responses is checked:

Salesforce will return an XML response with a Success status and the object's internalID.

Salesforce will return an XML response with a Failure status along with a statusCode and error message.

DELETE

This action will delete an existing record in the Salesforce object defined in the delete operation. You must supply the internal 'ID' field in the request to delete the existing object record. If this internal ID is not readily available in your source data, consider using a Connector Call function to QUERY data based on a standard value such as Name.

When Return Application Error Responses is checked:

Salesforce will return an XML response with a Success status and the object's internalID.

Salesforce will return an XML response with a Failure status along with a statusCode and error message.

Archiving Tab

Click here for more information on Archiving.