Archiving Your Salesforce Data

  1. Log in to your Vault account.

  2. Go to the Setup module.

  3. Locate the Salesforce Org for which the data has to be archived. You can use the Search filter to easily find the required Salesforce Org.

    Search for Salesforce Org
  4. Navigate to the Configs tab.

  5. Click on Add Archive Config. This will allow you to view all the components available in your Salesforce Org and choose the components for which you want to define the archive policy.

    Add Archive Config
  6. Select the components that you need to archive on the next screen.

    Select components
  7. Using Filters, you can define the criteria for which the records will get fetched. For example, you can define criteria to fetch AccountBrand records that are older than 1,000 days and field Id is not empty.

    AccountBrand-Filter

Validate your query to see whether the criteria set is correct and view the number of records that will be fetched. You can even set the record count limit for your data being fetched. Click on Apply to set the criteria and close the Filter dialog box. To easily identify the objects for which the filter is applied, the filter icon is highlighted.

Filter
Filters
  1. The Hierarchy option will allow you to view all the corresponding child objects for your selected object. These child objects will also get archived once you archive their parent object. Such a hierarchy schema view can be seen using the Hierarchy option.

    Hierarchy

    You may notice in the schema view that some of the objects are auto-selected by default and cannot be unchecked. These are the child objects of its parent object, which will be deleted if the parent object is selected for archival per policy. However, for other objects that are related to the selected object in some other way, you may have the option to choose them manually for archival. Visit the Mandatory Child Archival page for more information.

    Schema
    Child Schema
  2. Once done, click Save to close the hierarchy-schema screen. Similar to filter criteria addition, the hierarchy icon gets highlighted corresponding to the object for which hierarchy is selected.

  3. Click Next. On the next screen, do the following:

    • Give the process a name.

    • Select the email notification checkbox to receive an email notification whenever the objects are getting deleted from your Salesforce Org. If unchecked, data will be automatically deleted without any prior notification.

    • Select the date and time interval for the archive process to run under the Schedule Archive section. You can set the policy to run either daily, weekly, monthly, or input any duration manually.

    • You can specify till what time period you want to retain the archived data under the Archive retention period section.

    • Specify the batch size for components to retrieve records. 10K is the max batch size that you can set per batch. This option is useful in running large jobs that would exceed normal processing limits. As per the Salesforce governor limit, you can deploy or retrieve up to 10,000 files at once or a max size of 40MB. Using Batch Size, you can process records in batches to stay within platform limits. If you have a lot of records, processing records through batches are your best solution.

    • Enable serial mode for Bulk API: Serial mode processes batch one at a time, however, it can increase the processing time for a load.

  4. Disable Automation Rules

    1. This provision to disable the automation rules is useful in making sure the automation rules created on various fields in Salesforce will not impact the Archival process midway.

      Step-By-Step Guide:

      1. Set up the configuration for the automation rules at “Scheduling” while creating the “Archive Config”.

      2. On selecting the required automation configurations, continue to “Save Config”.

      3. Once saved, the set job configurations can be observed under the “Archive Config Details”.

      4. Clicking the information icon under the "Archive Config Details" column opens a pop-up displaying the configuration details associated with the respective archive job. This provides a quick view of the selected archive parameters without navigating away from the main screen.

      5. Run a job for the created configuration and observe the configuration details reflected on the job

      6. The automation configurations selected during the creation of the Archive Config will appear on the Start Archive screen in the same state as they were initially defined.

      7. For archive configurations where the "Notify before deleting records in Salesforce" option is not selected, the automation settings will still appear on the Start Archive page..

      8. On clicking the “ARCHIVE NOW” button, observe the automations to make sure they reflect in the same state of selection during the archive config creation.

      9. For "Archive Configs" with "Notify before deleting records in Salesforce" enabled, the automation rule settings will not be displayed on the Start Archive screen when the ARCHIVE NOW button is clicked.

      10. Once the archive job is completed, observe the automation rules details on the “Job Info” section.

      11. Click on the information icon under the “Job Info” section to observe the job automation details configured.

      12. Once the archive job is completed, any automations that were temporarily disabled during job creation will be restored to their original state as they were before the job was triggered.

  5. Click Save Config.

  6. A summary of all the objects, filters, and criteria selected or applied will get displayed before your archive policy gets configured. Click Save.

    Save Config Details
  7. Now go to the Archive tab.

  8. Select your Salesforce Org for which you configured the archive recently.

  9. Select the Environment.

  10. Select the archive configured recently under Configurations drop-down field.

    Archive Settings
  11. Click on Get Details to fetch all the existing archive configured for your Salesforce Org. If you've initiated the archival process for the first time in Vault, you will not find any details on this page.

  12. To run on-demand archive before the scheduled archive set, use Archive Now button.

  13. On the Start Archive screen, the label name gets auto-populated; however, you have the option to edit the label name and enter the label you desire.

  14. Select your configuration and click Archive.

    Start Archive
  15. You'll be redirected to the Archive page to view the status of the ongoing archive process being run.

    View Status
  16. For each archive job, the following information will be displayed:

Parameters
Description

Label

An identification name for each archive performed in Vault

Configuration Name

Archive configuration name

Date/Time

The date and time stamp for the archive process took place

Expiry Date

Till which date the archive job will remain with Vault

Duration

Time-taken to complete the archive operation

Records

Total numbers of records archived

API Calls

API call duration (in seconds)

Query

Filter or query that have been used to fetch the records

Data Backup

Backup type for data components i.e., Full backup or Incremental backup

Status

Status of the archive i.e., completed, in progress, or failed

Actions

  1. Summary Report: View the summary info for the archive performed. The report will contain the list of both success and failed components for the job triggered as shown below.

  2. View Log: View the log information for the archive job triggered.

  3. Download Archival Report: Specify the email address to receive the downloadable link to allow mentioned users to download the archive report on their local machine.

Filter & Download Records

This provision is useful in filtering the “backed up” and archived records. The available records can be filtered through various options provisioned on the application.

Step-By-Step Guide:

  1. Follow the following flow for the backup records download:

  2. Go to the backup module of the Vault application

  3. Click on the “Label Name” to open the backup details

  4. On landing on the backup details section, click on the “Records”

  5. On opening the backup “Records”, observe the “Downloads” option.

  6. The download has three values in the drop-down

    1. Download All Records

    2. Download Records On Screen

    3. Download Filtered Results

  7. 6. Download All Records: Selecting this option will download all the backed up records

  8. 7. Download Record On Screen: Selecting this option will download all the records available on that current page

  9. Download Filtered Records: Selecting this option will download the records filtered

Limitations

  • Inconsistent File Download During GDPR Requests: When a GDPR request is initiated within an organization, file downloads may behave inconsistently. This issue will be resolved in the upcoming release.

  • File Download Issues with Special Characters in File Names: Files with special characters in their names may not function properly in certain environments, particularly on macOS. This issue will be addressed in the upcoming release.

Last updated

Was this helpful?