Configuring Text-Based Key Fields

If you have object records in Salesforce that include text fields containing IDs of other records, you can instruct Veeam Backup for Salesforce to treat these text fields as lookups. This means that the records containing the text fields will be treated as child records linked using restricted relationships. You can further restore and archive the hierarchy of these records.

To identify text fields that may potentially be used as lookups when restoring or archiving data of a Salesforce organization, perform the following steps:

  1. Install the postgresql-contrib package on the PostgreSQL server that is used to host databases of the protected organization.
  2. In the Veeam Backup for Salesforce Web UI, do the following:
  1. Switch to the Configuration page.
  2. Navigate to About > Advanced Settings and click Confirm.
  3. In the list of available settings, locate custom.relationships and click Edit.
  4. In the Text-based Key Settings window, specify the API names or prefixes of fields that you want to be analyzed, and click Save.

When analyzing the fields, Veeam Backup for Salesforce will detect all objects that contain fields with the specified API names and prefixes — and then will look through the first 100 records of each of the detected objects to identify non-empty field values. To modify the number of records, provide a new value in the Sample size for analysis field.

Important

For text fields to be processed as lookups, all fields with the same API name or prefix must belong to the same object, and the text field values must be record IDs consisting of 18 characters.

After you click Save, Veeam Backup for Salesforce will not start looking through text fields and updating the backup database immediately. The product will wait till the next day (or till the related restore job or archival policy is launched) — and then will keep analyzing the fields once a day until you disable this functionality. To track the results, proceed to the Audit page.

Tip

  • If you do not specify any names or prefixes, the search may take significant time to complete as Veeam Backup for Salesforce will look through all the backed-up records.
  • If you remove any of field API names or prefixes specified in the custom.relationships configuration, these fields will no longer be treated as lookups. However, the changes will take effect only the next day (or when the related restore job or archival policy is launched).

Configuring Text Fields

Page updated 4/8/2026

Page content applies to build 3.2.0.3957