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 will allow 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 the product 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 the product 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.db.config.timeout.ms — the maximum amount of time (in milliseconds) for the product to wait for a response from the backup database during backup operations. When the timeout is exceeded, the connection to the database is terminated.
• backup.describe.objects.in.batch — the maximum number of objects that can be sent to Salesforce in one batch during a metadata backup session.
• backup.disk.cache.enabled — defines whether the product will cache data retrieved from Salesforce. It is recommended that you set this parameter value to true if the backup database is hosted on the management server, if backed-up data is stored on HDDs or if you get timeout errors when connecting to Salesforce.
• backup.file.max.failure — the maximum number of failed attempts that the product makes 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 maximum number of metadata files that can be retrieved from Salesforce in one batch 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 — defines whether the product will use bulk API queries for data backup. By default, the parameter value is set to false, which means that the product can use either bulk API or QueryAll requests. If you set this parameter value to true, the product will use the QueryAll requests only.
• backup.records.metadata.range.size — the maximum number of records that can be processed in one batch during a backup session. This parameter applies only to object records containing rich text area fields that are used to identify and download embedded images.
• 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 process may take significant time to complete.
• logging.add.domain.filename — defines whether the product will add 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 the product 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 the product 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 will run 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 maximum amount of time (in minutes) for a Bulk API archival job to execute. When the timeout is exceeded, the product sends a new bulk request to Salesforce. The default parameter value is 60.
• archive.fetch.size — the maximum number of records that can be retrieved from the product database in one request during an archival session.
• archive.thread.pool.size — the maximum number of worker threads that can be processed during one archival session.
• hierarchy.default.child.depth — the depth level of the child object hierarchy that is automatically restored for all records, unless you exclude or customize these records when configuring the record restore settings. The default parameter value is set to 2, which means that the product will restore the records that you selected at step 4 of the Record Restore wizard and their child records 2 levels deep down the hierarchy.
• hierarchy.default.parent.depth — the maximum level of the parent object hierarchy that can be specified when configuring hierarchy advanced settings. The default parameter value is set to 1.
• log.obfuscation.level — the level of masking sensitive data in restore logs.
• restore.bulk.exec.timeout.minutes — the maximum amount of time (in minutes) for a Bulk API restore job to execute. When the timeout is exceeded, the product sends a new bulk request to Salesforce. The default parameter value is set to 60.
• restore.bulk.threshold — the maximum number of records that can be sent to Salesforce before the product switches to Bulk API 2.0.
• restore.fetch.size — the maximum number of records that can be retrieved 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 will not be restored. By default, these rules include object and record types whose restore is not supported by the product.
• restore.parallel.hierarchy.threshold — the maximum number of root records that can be restored in sequence before the product switches to parallel restore.
• restore.thread.pool.size — the maximum number of worker threads that can be processed during one restore session.
• sf.composite.batch.size — the maximum number of records that can be sent to Salesforce in one batch during a restore session.