External ID - An Overview

We know that Vertical Solutions allows you to integrate third-party apps and manipulate data through APIs. While you integrate a third-party application, you may want to store the third-party reference IDs in  your solution's records. To meet this need of storing an external value inside the solution, we have introduced the External ID field.

What is an External ID field?

An External ID is a custom single line field in a module in the Vertical Solution that can hold a record's unique ID in an external system.

When can you use an External field?

When you integrate an application with Vertical Solution, you can use the external field's value to create, update, or delete a record in the solution instead of the solution's record ID.
This is particularly useful when you deal with huge data where you can work with just one ID per record instead of two.

• Integration and data sync - You can simply use the external ID to upsert records instead of the solution's record ID, and maintain data sync.
• Search - When you have an external field, you can search for a record through its external ID instead of the record ID.

Creating an External Field

• Go to Setup > Customization > Modules and Fields > Choose a module.
• Create a single line field and provide a name.
• Click the more options icon and select Edit Properties
• In the Single Line Properties pop up, specify the field label, and check the Set External Field box.

• Choose the field's visibility and the type of the external field.

  

• Click Done. Click Save and Close in the module builder.

Types of External Fields

User-based External field

When you set an external field of this type, the external ID of this field is available to each user in the solution. So, each user can manipulate records based on this external value. For example, there are two users in Google "user1" and "user2" that have saved a single Google Contact as "GC1" and "GC2", respectively. Now, when the integration between Google Contacts and Vertical solution happens, there will be a single Contact record in Vertical Solution with a record ID. Now, these users can use their respective Google Contact IDs as an external field's value, and update that record in Vertical Solution.

Org-based External field

When you set an external field of this type, the external ID of this field is the same for all users of the org. Consider an example where you have integrated MailChimp with Vertical Solution, and all the email addresses are stored as individual contacts in the solution. In MailChimp, the Campaign ID is the same for all the email addresses in the list. So, when you set the Campaign ID as the value to an external field, all solution users can use this external value in solution to manipulate these contacts.

Mandatory Header in the API Requests

X-EXTERNAL: {module_API_name}.{external_field_API_name}

Possible Values for the Header

• Simple Reference: {base_module_api_name}.{external_field_api_name}
  Example: Contacts.External_Contact_ID.
• Associate an external field through a lookup field: {base_module_api_name}.{lookup_field_api_name}.{external_field_api_name}
  Example: Contacts.Account_Name.External_ID.
• For a Product ID inside a line item: {inventory_module_api_name}.Product_Details.product.{product_external_field_api_name}
  Example: Quotes.Product_Details.product.External_Product_ID.
• Polymorphic lookup: Events.What_Id->Accounts.External_Account_ID.
• For a Price Book ID inside a line item: {inventory_module_api_name}.Product_Details.book.{price_book_external_field_api_name}
  Example: Quotes.Product_Details.book.External_ID.
• For a lookup field in a Subform: {base_module_api_name}.{subform_api_name}.{subform_lookup_field_api_name}.{associated_module_external_field_api_name}
  Example: Contacts.Subform_1.Deal_lookup.External_ID.