Configuring Advanced Settings

You can view and modify system limits and default settings configured in Veeam Backup for Salesforce. To do that, switch to the Configuration page, navigate to About > Advanced Settings and click Confirm. From the drop-down list, choose whether you want to view the restore or backend advanced settings. Note that only Administrators can update the advanced settings.

The Backend service list shows general settings of the management server and key settings that Veeam Backup for Salesforce uses for backend operations:

• archive.hierarchy.default.restricted.depth — the deepest hierarchy level of child records linked to the root record using restricted relationships that can be removed during archival operations.
• archive.object.allow.parallel — defines whether the product allows you to create multiple archival policies for the same root object or file type. However, it is not recommended that you set this parameter to true as unexpected performance errors may occur.
• aws.allowed.region — the codes of AWS regions to which master keys of the connected AWS accounts belong. If these parameter values do not match the necessary AWS region codes, the product will not be able to access the keys of this region. For more information on codes, see the AWS Documentation.
• backend.domain — the FQDN or IP address of the management server. Keep in mind that the parameter value must match the callback URL in the Connected App settings in Salesforce and redirect URI in Microsoft Entra ID.
• backend.metadata.download.files — the maximum number of metadata files that you can download at a time to the local machine during restore operations. The minimum value is 1; the maximum value is 500.
• backend.object.limit.rows — the maximum number of backed-up records retrieved from the product database that can be displayed on the Browse tab. The minimum value is 1; the maximum value is 50,000.
• backend.reschedule.job.delay — the minimum delay (in seconds) before Veeam Backup for Salesforce runs archival and backup jobs again if they fail on the first try. This parameter applies only if the backend.reschedule.job.enable parameter value is set to true.
• backend.reschedule.job.delay.random — the maximum random delay (in seconds) before Veeam Backup for Salesforce runs archival and backup jobs again if they fail on the first try. This parameter applies only if the backend.reschedule.job.enable parameter value is set to true.
• backend.reschedule.job.enable — defines whether archival and backup jobs will be restarted in case the management server runs out of memory when processing multiple jobs in parallel. It is not recommended that you set the parameter value to false as unexpected processing errors may occur.

If you set the parameter value to true, you must also specify the backend.reschedule.job.delay and backend.reschedule.job.delay.random parameter values.

• backup.describe.objects.in.batch — the number of objects in one request sent to Salesforce during a metadata backup session.
• backup.disk.cache.enabled — the indication whether the product performs caching of data retrieved from Salesforce. It is recommended that you enable this setting in either of the following cases: a database that is used to store backed-up data is hosted on the same server as Veeam Backup for Salesforce, backed-up data is stored on hard disk drives (HDD), or timeout errors occur when connecting to Salesforce.
• backup.file.max.failure — the maximum number of failed attempts to back up a file before the file is excluded from the backup policy. If you set this parameter value to 0, the file will not be excluded from the backup policy regardless of the number of failed attempts.
• backup.metadata.retrieve.batchsize — the number of metadata files retrieved in one request (batch) to Salesforce during a backup session. If you set this parameter value to 0, the number of requests sent to Salesforce will depend on the amount of processed data.
• backup.query.preferred — the indication whether the product uses bulk API queries for data backup. If this parameter value is set to true, the product uses bulk API queries only. If the parameter value is set to false, the product can use either bulk API or QueryAll requests.
• data.storage.location — the path to the folder where the product stores backups of Salesforce files and metadata. By default, the product stores backups in the /opt/vbsf/data folder. If you change this parameter value, you must move all your backups to a new location manually before enabling backup policies. Note that each Salesforce organization has its unique subfolder containing the organization ID that cannot be modified.
• encryption.data.object.max.field — the maximum number of record fields that can be encrypted for one object. Note that if you increase this parameter value, the backup job may take significant time to complete.
• logging.add.domain.filename — defines whether the product adds the backend domain name to the name of the downloaded log archive file.
• logging.archive.file.retention — the period of time (in days) during which the product keeps archival session logs in the configuration database and log storage folder.
• logging.backend.file.retention — the period of time (in days) during which the product keeps configuration logs in the log storage folder.
• logging.backup.file.retention — the period of time (in days) during which the product keeps backup logs in the configuration database and log storage folder.
• logging.restore.file.retention — the period of time (in days) during which the product keeps restore logs in the configuration database and log storage folder.
• mask.template.default — the default data masking template that is automatically generated by Veeam Backup for Salesforce upon installation.
• proxy.settings — the settings of a web proxy that the management server uses to connect to the internet.
• restore.compatible.only — defines whether Veeam Backup for Salesforce will restore data to a compatible Salesforce organization only (that is, from a production to a sandbox organization that was created based on the environment of this production organization). This feature is experimentally supported in Veeam Backup for Salesforce version 3.0 and later. For more information on experimental support, see this Veeam KB article.
• restore.job.allow.parallel — defines whether the product runs parallel restore jobs for the same organization.
• restore.job.draft.lifetime.days — the period of time (in days) during which the product keeps restore job drafts in the configuration database. If you set this parameter value to 0, the product will keep job drafts for 1 day only.
• sf.api.version — Salesforce API version of the Veeam backup and backend services.
• ui.restore.max.selected.records — the maximum number of root records that can be restored in one restore job. This parameter applies to record, field and metadata restore jobs only.

The Restore service list shows key settings that Veeam Backup for Salesforce uses for restore operations:

• archive.bulk.exec.timeout.minutes — the timeout (in minutes) used for a Bulk API archival job (maximum amount of time (in minutes) for a Bulk API archival job to execute). When the timeout is exceeded, Veeam Backup for Salesforce sends a new bulk request to Salesforce. The default parameter value is 60.
• archive.fetch.size — the maximum number of records the product retrieves from the product database in one request during an archival session.
• archive.thread.pool.size — the number of worker threads processed during an archival session.
• hierarchy.default.child.depth — the maximum level to which child records are automatically restored. This setting applies only to those records that have not been reviewed (customized) when configuring child hierarchy for restore. The default parameter value is 2, that is, the product restores records that you selected when specifying data for restore and 2 levels of their child records.
• hierarchy.default.parent.depth — the maximum level of the parent object hierarchy that is specified when configuring hierarchy advanced settings. The default parameter value is 1.
• log.obfuscation.level — the level of masking sensitive data in restore logs.
• restore.bulk.exec.timeout.minutes — the timeout (in minutes) for a Bulk API restore job to execute. When the timeout is exceeded, Veeam Backup for Salesforce sends a new bulk request to Salesforce. The default parameter value is 60.
• restore.bulk.threshold — the maximum number of records sent to Salesforce before the product switches to Bulk API 2.0.
• restore.fetch.size — the maximum number of records the product retrieves from the product database in one request during a restore session.
• restore.objects.filter — the set of rules that define what types of objects and records Veeam Backup for Salesforce does not restore. By default, these rules include those object and record types whose restore is not supported.
• restore.parallel.hierarchy.threshold — the maximum number of root records restored in sequence before the product switches to parallel restore.
• restore.thread.pool.size — the number of worker threads processed during a restore session.
• sf.composite.batch.size — the number of records the product sends to Salesforce in one request (batch) during a restore session.