Skip to end of metadata
Go to start of metadata

Introduction

A Salesforce Bulk Upsert activity updates a large number of existing records and inserts a large number of new records in a Salesforce endpoint and is intended to be used as a target to consume data in an operation. After configuring a Salesforce connection, you can configure as many Salesforce activities as you like for each Salesforce connection.

The Bulk Upsert activity is faster and scales better than a non-bulk Salesforce Upsert activity, but should be used only if you do not need to use a transformation to change data prior to reaching its target. (Salesforce bulk activities cannot be used with transformations.)

The Bulk Upsert activity requires the use of an external ID field to (1) insert records if they do not already exist and (2) update records if they already exist. For information on creating an external ID field in Salesforce, see Creating a Salesforce External ID for JitterbitIf instead you want to bulk insert new records only, or if you want to bulk update existing records based on the ID of the object in Salesforce, use a Salesforce Bulk Insert or Bulk Update activity.

The Salesforce connector supports Salesforce Bulk API 2.0. For more information, see Prerequisites and Supported API Versions.

Creating a Salesforce Activity

From the design canvas, open the Connectivity tab of the design component palette:

Use the Show dropdown to filter on Endpoints, and then click the Salesforce connection block to display activities that are available to be used with a Salesforce connection:

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Configuring a Salesforce Bulk Upsert Activity

Follow these steps to configure a Salesforce Bulk Upsert activity:

Step 1: Enter a Name and Select an Object

  • Name: Enter a name to use to identify the Salesforce Bulk Upsert activity. The name must be unique for each Salesforce Bulk Upsert activity and must not contain forward slashes (/) or colons (:).
  • Select the Object Reference: Use the dropdown to select a Salesforce standard or custom object to bulk upsert. Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive.

    TIP: If the dropdown does not populate with available objects, the Salesforce connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
  • Refresh: Click the refresh icon  to reload objects from the Salesforce endpoint. This may be useful if you have recently added objects to Salesforce.
  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Specify an External ID

  • External ID: Use the dropdown to select the existing Salesforce field that you want Jitterbit Harmony to use as the external ID to associate records. For information on creating an external ID field in Salesforce, see Creating a Salesforce External ID for Jitterbit.

    WARNING: The field used as the external ID should have a unique value for each record. If you have multiple records with the same external ID value, an error response from Salesforce will be returned and the bulk upsert will fail for the records with duplicate IDs.
  • Back: Click to temporarily store the configuration for this step and return to the previous step.
  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Provide the Response Schema

  • Provide Response Schema: The response schema defines the structure of response data that is used by the Salesforce bulk activity. This response schema is used as part of the Salesforce bulk activity for creating mappings in the next step. Select from one of two options below.

    NOTE: Schemas for Salesforce bulk activities are always part of the activity and can never be defined in a transformation, as transformations cannot be used in an operation that has a Salesforce bulk activity.
    • Use Saved Schema: Choose this option to select an existing file schema that has previously been defined in the current project.
      • Saved Schemas: Use the dropdown to select from an existing schema to reuse.

      • View/Edit Schema: After an existing schema is selected, you can view or edit it directly within the text area below the dropdown.

      • Validation: As you edit a schema, validation information is provided below the text area, with any errors reported one line at a time. That is, after resolving an error on one line, additional syntax errors to resolve may be reported for subsequent lines. Validation is based on the file extension of the saved schema.

        WARNING: If you have edited a saved schema, a dialog asks you to acknowledge that the edits will affect other areas of the project where the saved schema is used. If you click Continue, the edits will take effect everywhere the schema is used in the project. If you don't want to affect other areas where the saved schema is used, click Cancel and provide a new schema instead.

    • Provide New Schema: Choose this option to define a new schema by uploading a file or manually entering one into the text area.
      • Schema Name: Enter a name for the schema into the upper text box, including the .csv file extension. If no file extension is provided, the file is treated as CSV by default. If you are uploading a file, you can leave this blank, as the name is populated once the file is loaded.

      • Upload File: Click this button to open a dialog where you can load a schema from a file that is accessible from the current machine:

        • File: Use the Browse button to the right to browse to a CSV file that has not yet been used in the current project. Files up to 5 MB in size can be uploaded.

          WARNING: If you try to upload a file with the same name as an existing file already defined in the project, a dialog asks if you want to overwrite the existing file. If you click Continue, the file will be replaced with the new file with the same name in all places where it is used in the project. If you don't want to overwrite the file, click Cancel and then manually modify the file so it has a name that is not already being used, then try to upload it again.

        • Load: Click this button to load the schema from the file. Note that some data may be converted during processing as described in Schema Processing.
        • Cancel: Click Cancel to close the Upload Schema File dialog without saving.
      • View/Edit Schema: After a schema is loaded, you can view or edit it directly within the text area below the Upload File button. Another option is to manually enter or paste a schema into this area without loading a schema from a file.
      • Validation: As you edit a schema, validation information will be provided below the text area, with any errors reported one line at a time. That is, after resolving an error on one line, additional syntax errors to resolve may be reported for subsequent lines. Validation is based on the file extension of the provided schema.
  • Back: Click to temporarily store the configuration for this step and return to the previous step.
  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Map Headers

  • Map Headers: This step is used to map fields by column in the source file to those in the Salesforce bulk target activity. To complete a mapping, drag a source field on the left to a target field on the right. When fields are mapped, the background becomes orange and a line is drawn between the mapped fields. To remove a mapping, click either the source field or target field.
    • Source File Headers: The left side shows the headers for the columns in the CSV file provided in the previous step.
      • Search: Enter any part of the header name into the search box to filter the list of headers. The search is not case-sensitive.
      • Import Mapping: To import a mapping that has previously been exported, click the Import Mapping link, then provide input in the dialog:

        • File Type: Use the dropdown to select the format of the mapping file:
          • JDL: Select JDL to use a file that has been exported from a Design Studio bulk process operation (from the Design Studio option to Save Mappings to File described in Salesforce Bulk Process Wizard).
          • JSON: Select JSON to use a file that has been exported from Cloud Studio using the Export Mapping link described below.
        • File: Click the Browse button on the right to select a file that contains the mapping.
        • Upload: After selecting a file, click Upload to upload the mapping.

          WARNING: The uploaded mapping overwrites any existing mappings, if present.
        • Cancel: Click Cancel to close the import dialogue without uploading a mapping.
      • Export Mapping: To export an existing mapping, click the Export Mapping link. This initiates the download process in your browser. The exported file is in JSON format. Each field mapping includes the source field name, target field name, and source index.

        NOTE: Exported bulk activity mappings cannot be imported as transformation mappings and can be imported only using the Import Mapping link described above.
    • Salesforce Fields: The right side shows the column names in Salesforce that are available to be mapped to. 
      • Search: Enter any part of the column name into the search box to filter the list of headers. The search is not case-sensitive.
      • Automap: Click the Automap link to map source and target field names that are exact match (regardless of case) and have identical data types. Fields that are automapped are in addition to any existing mappings, which are left in place.
      • Start Over: Click the Start Over link to clear all mappings.
  • Back: Click to temporarily store the configuration for this step and return to the previous step.
  • Finished: Click to save the configuration for all steps and close the activity configuration.
  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Salesforce Bulk Upsert activity, complete the configuration of the operation by adding and configuring other activities or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After a Salesforce Bulk Upsert activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

Salesforce Bulk Upsert activities can be used as a target with this operation pattern:

A Salesforce activity can be used as an operation step in only a single operation. That is, you cannot reference the same activity multiple times within other operations. Instead, you can make a copy of a Salesforce activity to use elsewhere (see Component Reuse).

Other patterns are not valid using Salesforce Bulk Upsert activities. See the validation patterns on the Operation Validity page.

This example setup depicts one common operation setup using a Salesforce Bulk Upsert activity:

In addition, the file-based source used in the operation must be using a CSV file format with a header and only these data types:

  • Base64
  • Boolean
  • Date formats
  • Double
  • Integer
  • Salesforce ID
  • String

Operations that use Salesforce activities can also have operation actions configured to trigger on a SOAP fault — an error resulting from an incorrect message format, header processing, or incompatibility. Operation actions can be configured to run an operation or send an email after a SOAP fault occurs. For instructions on triggering an action on SOAP fault, refer to Operation Actions.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jun 15, 2021

  • No labels