Configuring Retrieve Operation Adapter Services
Use the Retrieve Operation template to configure an adapter service that retrieves selected fields from records of a Salesforce object. The Retrieve operation wraps the retrieve call of the Salesforce.com Web service API.
The input to the adapter service includes an ID String List. At run time, pass the adapter service the ID of each record to retrieve. Each ID is a String value within the ID String List.
As a response, the Salesforce.com retrieve call returns the objects that contain the field values of the retrieved records.
The following table describes the output from a Retrieve Operation adapter service:
Variable | Description |
results | Document List Each Document in the Document List contains the selected fields of the retrieved records. There is a one-to-one mapping between the IDs of the records specified in the ID input parameter to the output in the results Document List. |
invalidIds | String ListContains the list of invalid IDs. If the user does not have sufficient privilege or if one or more IDs specified in the input parameter are invalid, the response from the Salesforce.com retrieve() call is null. Adapter for Salesforce cannot retrieve the records for invalid IDs. These invalid IDs are made a part of the invalidIds output parameter. Note:
When there are invalid IDs in the invalidIds output parameter, the number of records in the results output parameter will not match the number of IDs specified in the input signature. |
The IDs of the records to retrieve in the IDString List input parameter map to the output in the results Document List.
Note:
Salesforce.com imposes restrictions on the number of IDs that can be passed for a single call. Ensure that the number of IDs passed to a single Retrieve operation does not exceed the maximum limit. For more information, see the Force.com Web Services API Developer's Guide.
To configure an adapter service that uses the Retrieve Operation template
2. Start Designer.
3. Right-click the package in which the service should be contained and select New > Adapter Service.
4. Select the parent namespace, type a name for the adapter service, and click Next.
5. Select Adapter for Salesforce as the adapter type and click Next.
6. Select the appropriate Adapter Connection Name and click Next.
Important:
Ensure the Salesforce.com user account identified by the connection has all the required permissions to retrieve records from the Salesforce object that you will select later in the procedure.
7. From the list of available templates, select the Retrieve Operation template and click Finish.
The adapter service editor for the adapter service appears. You can select the Adapter Settings tab at any time to confirm adapter service properties such as the Adapter Name, Adapter Connection Name, and Adapter Service Template, as necessary.
8. Identify the Salesforce object from which the adapter service is to retrieve records.
a. Select the Schema tab.
b. From the Salesforce object list, select the Salesforce object from which you want to retrieve records.
9. Identify the fields of the retrieved records that you want returned. If you do not specify fields, the adapter reports an INVALID_FIELD error, which Salesforce.com returns.
a. Select the Retrieve Operation tab.
b. Click the 
icon to populate the table with the fields of the selected Salesforce object. c. For each field want returned, select the check box in the Use Field column.
10. Select File > Save to save the adapter service.
