Retrieve Objects activity

Use this activity to retrieve one or more Salesforce.com objects of a specified type. While the Salesforce.com API limits the number of objects that it can retrieve in a single call to 2,000 objects, the WebSphere® Cast Iron Salesforce.com connector does not have such a limit. You can use the Retrieve Objects activity to retrieve an unlimited number of objects.

Using the Retrieve Objects activity

  1. In the Activities tab, open the Salesforce.com directory to find the Retrieve Objects activity.
  2. Add the activity to your orchestration.

    The Checklist and Summary for the activity are displayed below the orchestration.

  3. Select a Salesforce.com endpoint.

    For instructions on creating or editing a Salesforce.com endpoint, see Creating or editing a Salesforce.com endpoint.

  4. Configure the activity, by choosing a Salesforce.com object type and object field preferences.

    Only object types that the Integration Appliance is able to retrieve via the Salesforce.com API display.

  5. Specify the Retry and Time out parameters for the activity.
  6. Map the input of the activity.
  7. Map the output of the activity.

Map the input of the Retrieve Objects activity

  1. In the Checklist, select Map Inputs.

    The ids element is displayed in the To Activity pane. The element contains the collection of IDs that the Integration Appliance retrieves from Salesforce.com

  2. (Optional) Right-click the default node and choose Show Optional Parameters, to show the optional input parameters for this activity:
    • MruHeaderUser
    • CallOptions
    • connection
    • sessionInfo
  3. Click Select Inputs... and select the input variables for the map.

    For instructions about creating variables, see Creating Variables.

  4. As appropriate, map the input parameters to the variables.

    For mapping instructions, see Creating a Map.

Optional and nillable field elements have the following behavior:
  • If the field being retrieved is null, the Integration Appliance sets the xsi:nil attribute to true in the result.
  • If the input ID is not valid or does not represent the object type you specified, then for the entire object element the Integration Appliance sets xsi:nil to true for that element's position in the result set.

Map the output of the Retrieve Objects activity

  1. In the Checklist, select Map Outputs.

    The objects element is displayed in the From Activity panel. The element contains all fields that you selected in the field preferences table, during the configuration steps.

  2. Click Select Outputs... and select the output variables for the map.

    For instructions about creating variables, see Creating Variables.

  3. As appropriate, map the output parameters to the variables.

    For mapping instructions, see Creating a Map.