Invoke Headers Page

Enter the Salesforce invoke header values for your integration.

The headers available for configuration are based on the operation you selected on the invoke Operations page. There are two types of headers:
  • Request headers are sent with the request message to the Salesforce application.

  • Response headers are received with the response message sent from the Salesforce application.

Visit www.salesforce.com and specify the specific name of the header property in the search utility.

Note:

The Headers page is visible only if the Use Default Header checkbox is deselected on the Operations page.
Element Description

All Or None Header (request header)

Specifies the transactional behavior for Salesforce application operations. The behavior of this parameter is based on the version of the integration and is applicable to the create, delete, update, undelete, and upsert operations.

  • Integration flows created before version 16.4.1:
    • If set to true and the response contains error elements, it maps to UnexpectedErrorFault. This is also the case if All Or None Header is set to false (that is, unselected).

  • Integration flows created for version 16.4.1 and later:

    • If set to true (that is, selected and there are error elements), it maps to UnexpectedErrorFault.

    • If set to false (that is, unselected), the adapter returns the whole response even if it contains error elements along with success elements in the response.

If you want integration flows created before 16.4.1 to use the new behavior, edit the Salesforce Adapter in the Adapter Endpoint Configuration Wizard.

Allow Field Truncation Header (request header)

Specifies the truncation behavior for the following fields (each are string data types):
  • anyType

  • email

  • picklist

  • encryptedstring

  • textarea

  • mulitpicklist

  • phone

  • string

Set Allow Field Truncation to one of the following values:
  • True: If you enter a value of 25 characters in a field of 20 characters, the first 20 records are inserted into the field and the transaction is successful.

  • False: If you enter a value of 25 characters in a field of 20 characters, an error is thrown and the transaction does not commit.

Assignment Rule Header (request header)

Specifies the assignment rule to use when creating or updating an account, case, or lead. The assignment rule can be active or inactive. The ID is retrieved by querying the AssignmentRule object. If the ID is specified, you do not need to specify the Use Default Rule value.

  • Assignment Rule Id: The ID of the assignment rule to use. The ID is not validated by the Salesforce Cloud application, whether or not it exists. Validation occurs during runtime.

  • Use Default Rule: If set to true, the default (active) assignment rule is used. If set to false, the default (active) assignment rule is not used.

Duplicate Rule Header

Specifies the duplicate management behavior of the Salesforce application operations. The behavior of this parameter is handled in a mutually exclusive way. This header has three properties:

  • Allow Save: This property is selected by default when configuring a Salesforce endpoint.

    • True (if selected): Creates/updates duplicate records. The selection of this property disables the selection of Include Record Details and Run As Current User.

    • False (if deselected): Prevents created and updated duplicate records from being saved.

  • Include Record Details: This option is selectable when Allow Save is deselected. This option enables you to get record details of existing duplicates.

    • True (if selected): Retrieves duplicate error details and duplicate record details that impact the transaction.

    • False(if deselected): Retrieves duplicate error details that do not include duplicate records.

  • Run As Current User: Enforces the sharing of rules for the current user.

    • True (if selected): Runs duplicate rules for the current user and ignores the rules not available to them.

    • False (if deselected): Applies shared rules for the current user.

A use case that describes how to use the Duplicate Rule Header property is provided. See Allow and Prevent Duplicate Headers with the Duplicate Rule Header Property.

Email Header (request header)

Specifies whether or not to send a notification email. You can set the following properties:
  • Trigger Auto Response Email

    • true: Triggers automatic response rules for leads and cases.

    • false: Automatic response rules for leads and cases are not triggered.

  • Trigger Other Email

    • true: The email is triggered outside the organization.

    • false: The email is not triggered outside the organization.

  • Trigger User Email

    • true: The email is triggered and sent to users in the organization. This email is triggered by a number of events such as adding comments to a case or updating a task.

    • false: The email is not triggered and sent to users in the organization.

Mru Header (request header)

The Salesforce application shows the most recently used (MRU) items. In API version 7.0 or later, the list is not updated by itself. Use Mru Header to update the list. Using this header can negatively impact performance. Set Update Mru to one of the following values:
  • true: The list of MRU items is updated in the Salesforce application.

  • false: The list of most recently used items is not updated in the Salesforce application.

Package Version Header (request header)

Specifies the package version for any installed package. The package version identifies the components in a package. The package version follows the format majorNumber.minorNumber.patchNumber (for example, 3.4.5, where 3 refers to majorNumber, 4 refers to minorNumber, and 5 refers to patchNumber) .

Query Options (request header)

Specifies the batch size for queries. The minimum and default value is 200 and the maximum value is 2000.