Salesforce Upsert Methods Setup

In order to use the Upsert Account or Upsert Contact methods you must first setup a custom external ID field within the object in salesforce.

Setting up the method will be a slightly different process depending upon whether you are using Salesforce Classic, or Lightning Experience.

External ID Creation - Salesforce Classic

  1. To add a custom external ID field to an object in Salesforce first click the Setup button in the top right of the screen.

  2. Scroll down to the Build label and click Customize -> Account (Or Contact) -> Fields.

  3. Once on the Fields screen scroll down to where it says ‘Account Custom Fields & Relationships’ and press New.
  4. Select the Text checkbox and press Next.
  5. Enter the Field Label and Length. Select Do not allow duplicate values and Treat "ABC" and "abc" as different values. And Select Set this field as the unique record identifier from an external system, then press Next.
  6. Check Visible and press Next and then Save.

External ID Creation - Lightning Experience

  1. To add a custom external ID field to an object in Lightning Experience first click the Setup cog in the top right of the screen, and select Setup.

  2. Scroll down to the Platform Tools label and click Objects and Fields -> Object Manager.

  3. Once on the Object Manager screen, select the object you wish to add an external field for. For example, if you are setting up an Upsert Account method, select Account.

  4. Select the Fields & Relationships from the menu and click the New button.
  5. Select the Text checkbox and press Next.
  6. Enter the Field Label and Length. Select Do not allow duplicate values and Treat "ABC" and "abc" as different values. And Select Set this field as the unique record identifier from an external system, then press Next.
  7. Check Visible and press Next and then Save.

Using the Upsert Methods

Once you have setup your External ID field you are ready to use the corresponding Upsert method.

  1. Copy the API Name of your External ID field from Salesforce:

    Salesforce Classic

    Lightning Experience

  2. Go to setup the Upsert method in Cyclr, and insert the copied value into the ‘External ID Field’, and map your External ID value to the ‘External ID’ field.

Tags: connector
Edit me