Salesforce Composite Tree
The Salesforce Composite Tree activity creates one or more sObject trees with root records of the specified type.
General
On the General tab, you must provide the following information to establish a connection with the Salesforce.com server:
to select a usable connection for the activity.
Description
On the Description tab, you can enter a short description for the Salesforce Composite Tree activity.
Input
On the Input tab you can specify the following input values for the Salesforce Composite Tree activity:
| Input Items | Data Type | Description |
|---|---|---|
| SalesforceSessionInput (All fields in this section are optional) | ||
| externalSessionUrl | String | The external web address of the endpoint that is used by this operation |
| externalSessionId | String | The external unique ID associated with this session |
| serverSessionUsed | Boolean | Specifies whether an external session ID was used.
If the value is set to true, an external ID is set in the sessionId field. In this case, when the session has to be refreshed, the refresh operation cannot be performed and an exception occurs. |
| SalesforceCompositeTree | ||
| sObjects | ||
| rootObject | Complex | Complex rootObject can be type substituted by a complex element from the
composite.xsd schema, retrieved from Salesforce.com server.
childRelationship: After the rootObject is type substituted, you can see the childRelationship element that contains the children of the substituted rootObject. Create sObject trees by type substituting the objects inside childRelationship. |
| SalesforceOptionalInput | ||
| timeout | Integer | The timeout value.
The duration (in milliseconds) for which an internal API call waits before the data is returned. |
| HttpHeader | Request headers and their values to include with the subrequest.
For more information, see Salesforce API documentation. |
|
| key | String | HTTP header name |
| value | String | HTTP header value |
Output
The Output tab displays the activity results.
The following table lists the output elements on the Output tab of the Salesforce Composite Tree activity. For more information on any of the fields, see the Salesforce Composite API documentation.
| Output Item | Data Type | Description | |
|---|---|---|---|
| SalesforceCompositeTreeOutput | |||
| hasErrors | Boolean | true - This value is displayed when at least one of the results in the result set is an HTTP status code in the range of
400 to
500.
false - This code is displayed when there are no errors. |
|
| results | Collection of results | ||
| referenceId | String | Reference ID of the requested record | |
| id | String | ID of the requested record | |
| errors | |||
| fields | String | Fields for which there is an error | |
| message | String | Error message | |
| statusCode | String | If the request is not well-formed, the API returns a
400 Bad Request HTTP status.
Fix the syntax of the request and try again. If the request is well-formed, the API returns a 200 OK HTTP status. If an item was processed successfully, the success flag for that item is displayed. Error information is returned in the error array. |
|
| extendedErrorDetails | More details about the error.
Reserved for future use. |
||
| extendedErrorCode | Extended error code and extra error properties | ||
Fault
On the Fault tab, you can find the error code and error message of the Salesforce Composite Tree activity. For more information about the error codes and the corrective actions to take, see Error Codes.
| Fault | Thrown when.. |
|---|---|
| SalesforceRestException | There is a problem with REST request, response or some other REST API issue. |
| SalesforceLoginException | An error occurs when logging in to the Salesforce.com server. |
| SalesforceConnectionNotFoundException | An error occurs when the external session ID is not used or the Salesforce connection is not configured correctly. |