Step 5. Configure General Settings

At the Options step of the wizard, you can select an archival schedule, specify API request and safety control limits and run the policy in the test mode.

Schedule Settings

In the Schedule section, choose whether you want to launch the policy every day, every week, every month or according to a custom schedule. For a custom schedule to be displayed in the list of available schedules, it must be created for the company selected at step 1 as described in section Creating Backup Policies.

Test Mode Settings

In the Test mode section, you can choose whether you want to run the archival policy in the test mode without actually deleting any data. To do that, select the Run in test mode check box — and then, either wait for the policy to run according to the selected schedule or run it manually after you finish working with the Add Archival Policy wizard. When the archival session completes, follow the instructions provided in section Viewing Archival Policy Sessions to view the number of records that will be archived for both the selected object and all its child objects.

Archive Limit Settings

By default, Veeam Backup for Salesforce archives up to 100,000 records during one archival session to avoid performance issues. In the Safety controls section, you can adjust this limit taking into account the number of records that has been calculated at step 4.

If the limit that you specify is less than the calculated number of records, the product will archive only the specified number of records while other records will be archived later, during subsequent archival sessions. Note that Veeam Backup for Salesforce can archive data during subsequent archival sessions only after running the related backup policy — this allows the product to preserve data consistency between backup sessions.

Hierarchy Depth Settings

By default, Veeam Backup for Salesforce deletes child records linked using restricted relationships (that is, required lookup field relationships and optional lookup field relationships with the Delete this record also option enabled) of the 1st and 2nd hierarchy levels only. In the Safety controls section, you can adjust the depth level.

NoteS

The hierarchy depth settings do not apply to master-detail relationships.

Consider the following example. You want an archival policy to delete child records in the root object 1 level deep down the hierarchy where records in the root object are linked to a child record using master-detail relationships. In this case, Veeam Backup for Salesforce will take the following steps while archiving records:

  1. Delete the child record.
  2. Proceed to deeper hierarchy levels until the 1st level child records linked using restricted relationships are detected.
  3. Delete the detected 1st level child records with restricted relationships.
  4. Proceed to deeper levels and keep deleting master-detail relationships until the 2nd level child records linked using restricted relationships are detected.
  5. Keep the detected 2nd level child records and stop proceeding to deeper levels of the child hierarchy for this root record.
  6. Try to finalize the archival operation. If deeper levels of child hierarchy contain records linked using restricted relationships, the operation will complete with an error and Veeam Backup for Salesforce will not be able to delete these child records.

API Request Limits

You can also specify thresholds for REST API and BULK API requests that must not be breached during archival operations since the total number of API requests that can be sent to Salesforce within 24 hours is limited for each Salesforce organization — this will help you ensure that Veeam Backup for Salesforce does not conflict with other applications that use API requests for integration with Salesforce. To do that, click Set API limits and enter the necessary threshold values (in percentage) in the Set API limits window.

NoteS

By design, Veeam Backup for Salesforce checks the number of remaining API requests every time it starts a new policy session:

  • If any of the specified thresholds is breached, the session fails with an error indicating that the API request limit has been exceeded.
  • If none of the specified thresholds is breached, Veeam Backup for Salesforce starts processing child objects added to the policy one by one.

Every time it processes a new child object, it checks the number of remaining API requests — if any of the specified thresholds is breached, the session fails with an error indicating that the API request limit has been exceeded, and all child objects that have not been processed yet remain undeleted. However, Veeam Backup for Salesforce continues sending requests to Salesforce to archive child objects whose processing started before the session failed. The latter may cause Veeam Backup for Salesforce to accidentally exceed the maximum limit of API requests that you specified.

Adding Archival Policy

Page updated 11/26/2024

Page content applies to build 3.1.0.2378