Archive Settings

Configure Archive Managed Package 24 Settings and later. You can access all settings outlined here from the Settings tab in the Archive Managed Package.

Note
Note This content relates to Archive. For Salesforce Archive, see Store Data Externally with Salesforce Archive.

Users must have the Archive Admin or Archive Settings Permission Set assigned.

View Organization Details

To review org details such as Organization ID, Organization Type, Archive Version, and Region, go to Org Information.

Note
Note These details are required when you open a support ticket.

Validate or Change the Authenticated User

To verify that the Authenticated User has the same permissions as an admin, go to the Authenticated User tab.

Your username, email, and user ID are shown here.

For more information, see Salesforce Authenticated User Permission Requirements for Archive.

Manage Archive Settings

  • Configure Salesforce Data Protection Period: Set a default protection period of up to 365 days based on LastModifiedDate. Unless you set custom values, Salesforce Data Protection Period prevents the archiving of recently modified records.
  • Bypass Data Protection for Authenticated User Updates: Bypass protection for records updated by the Authenticated User.
  • Hard-Delete: Permanently delete records instead of sending them to the Recycle Bin. This setting requires the Bulk API Hard Delete user permission. If a record has lookup children,it’s sent to the Recycle Bin even if this setting is enabled.
  • Archive Accounts with Closed-Won Opportunities: Archive accounts with Closed-Won opportunities, overriding Salesforce's default data protection.
  • Exclude Specific Objects from Archiving: Exclude History, Feed, Share, or formula field objects by enabling the relevant setting.

    These objects are deleted from Salesforce and excluded from Archive.

    Note
    Note Skipped fields appear empty in Archive Search.
  • Configure Person Account Settings: View a Person Contact child records for Person Accounts.

    This feature is available only if enabled in your org.

  • Same Root & Child Filter: Archive an object by filtering out root IDs where a child record is the same type as the root.
  • Exclude Records with External Files During Archive: Prevent archiving of files that are linked to external references.
  • Exclude ContentDocuments with Non-Archived Parents: Exclude ContentDocuments associated with parent records that remain unarchived.

    A ContentDocument is only archived if the archived parent is the last or sole relation to the ContentDocument.

  • Retry Bulk Delete: Retries failed delete operations in smaller batches. This setting is available only when Hard Delete Records is selected.

    If a delete fails, the operation is tried again in smaller batches to improve success rates.

  • Archive EmailMessages with Related Tasks: Archive all EmailMessages along with their associated Tasks.

    This setting requires Salesforce Enhanced Email to be enabled.

  • Archive Digital Signatures: Archive digital signatures collected in Field Service when related records are archived.
  • Enable Archiving of Objects with Missing Relationship Names: Add cascade delete support for objects without defined relationships.
    Warning
    Warning Objects without defined relationships can't be unarchived later.
  • Unsupported Child Object Handling: Controls how archive policies handle child objects that can't be archived. When enabled, policies skip unsupported child objects instead of failing. When disabled (default), policies fail when they encounter an unsupported child object, requiring manual adjustment. Archive excludes non-creatable objects from policies because archived data can't be unarchived if the object doesn't support record creation.
    Warning
    Warning When this setting is on, policies skip child objects, which can cause data loss or orphaned relationships when you archive root records.
  • Import Data from Heroku: Format and import data from a Heroku source to Salesforce.

Define Unarchiving Options

  • Unarchive Retention Period: Specify the retention period in days to prevent recently unarchived records from being rearchived.
  • Preserve Original Case Number: Create a custom field to preserve the original Case Number when unarchiving a case record.
  • Nullify Email Message Created By ID Pre-Insertion: Clear the original Created By ID for email messages.
  • Automatically Retry Email Address Validation Errors: Retries unarchiving if Salesforce address restrictions cause a failure. The ValidatedFromAddress field is cleared and the operation is retried using the FromAddress to restore the record.
  • Unarchive History Records: Restore history records to a copy of the original history object.

    To restore history records, create a custom object with a Copy suffix, like Account History Copy. Then verify that all the fields of the new history object match those fields of the original history object.

  • Handle Private Libraries During Unarchive: Automatically clears or adjusts ContentVersion fields that reference a user's private library during unarchive. This setting prevents errors during unarchive operations or when unarchiving content from former users whose private libraries no longer exist.
  • Unarchive Related References Management: Select one of these options for related references during unarchiving.
    • Ignore Related References: Unarchive only the selected item without affecting other records. This value is the default value.
    • Nullify Related Reference Links: Remove references to other records outside the Archive job.
    • Unarchive with Related References: Unarchive related records and maintains relationships.
  • Integration User for Inactive Owners: When the original record owner is inactive, Archive assigns the record to the Integration User and retries the unarchive operation.

Set Purge Protection for Archived Data

  • Archived Data Protected from Purge: Define the number of days archived data is protected from purge policies, which permanently remove data.

Customize Search

  • Archive Search Layout: Select up to 15 fields for the layout.
    Note
    Note Non-indexed fields can take longer to retrieve.
  • Archive Widget Layout: Select up to 15 fields for the layout.
  • Index Fields Setup: Select multiple fields from one or more objects to submit for indexing.

    Identify non-indexed fields and check how many fields remain in your quota.

Configure Widget Restriction Rules

Customize access to archived data by setting up restriction rules. You can restrict access to up to five objects, limiting child record visibility based on sharing settings.

For more information, see Archive Widget Restriction Rules.

Export Settings

  • By default, to test the connection to your external target, Archive writes a small test file and then immediately deletes it. This standard test verifies that the app has both write (PUT) and DELETE permissions. To skip the delete step of this test, select Check Connection via PUT Only. When enabled, the connection test only writes the file and confirms a successful write.
  • By default, the Archive App automatically filters out and excludes objects with standard suffixes, as they typically contain auto-generated system data or auditing information.

    To turn off this filter and include these object types in your export, select Suffixes Included. This setting applies to objects with these suffixes.

    • Share
    • Feed
    • History
    • Relation
    • Role
  • Similar to the standard suffix objects, LiveChatTranscriptEvent objects are automatically excluded from exports by default. To include this specific object type in your archive, select LiveChatTranscriptEvent Included.
  • Some storage endpoints, such as AWS S3, require a Server-Side Encryption (SSE) header to be explicitly present to accept the connection and enforce server-side encryption. To include the SSE header in all export requests, select Send SSE Header Explicitly.