You are here:
Configure Archive Settings
Configure settings to archive, unarchive, purge, search, display, and export records in the Archive app.
View Organization Information
To review org details such as Organization ID, Organization Type, and Region, go to Org Information.
Validate or Change the Authenticated User
To view the username, email, user ID, or to change the Authenticated User, go to the Authenticated User tab.
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 Integration User Updates: Bypass protection for records updated by the Integration User.
- Use Hard-Delete During Archive: 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.Note This setting requires Bulk API permissions. For more information, see Salesforce Bulk API Hard Delete Permissions.
- Archive Accounts with Closed-Won Opportunities: Archive accounts with Closed-Won opportunities, overriding Salesforce's default data protection.
- Exclude Specific Objects from Archiving: Exclude object types, such as Feed,
History, Share, or objects with formula fields, from all archiving processes.
These objects are deleted from Salesforce and excluded from Archive.
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 record.
- Exclude Records with External Files: Prevent the archiving of files that are linked to external references.
- Exclude ContentDocuments with Non-Archived Parents: Exclude ContentDocuments
related to root records that remain unarchived.Note A ContentDocument is only archived if the archived root record is the last or sole relation to the ContentDocument.
- Retry Bulk Delete: When Hard-Delete is active, the Bulk Delete API handles parent records without lookup child records. If a delete operation fails, the operation is retried in smaller batches to improve success rates.
- Archive EmailMessages with Related Tasks: Archive an EmailMessage and all its
related Task records. Note Enhanced Email must be enabled.
- Archive Digital Signatures: Archive digital signature records collected in Salesforce Field Service when their related root records are archived.
- Enable Archiving of Objects with Missing Relationship Names: Add cascade-delete
support for objects without a defined relationship name in their schema. Warning Objects archived with this setting turned on can't be unarchived later because the system has no relationship path to follow for restoration.
- 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 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 a Heroku source to Salesforce: Enable unarchive record from archived Format and import data from a Heroku source to Salesforce.
Unarchive Settings
- Unarchive Retention Period: Specify the retention period, in days, to prevent recently unarchived records from being rearchived.
- Preserve Original Case Number: When unarchiving a Case record, create a custom field to preserve the original Case Number.
- Nullify EmailMessage 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
ValidatedFromAddressfield is cleared and the operation is retried using theFromAddressto 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, such as Account History Copy. Then verify that all the fields of the new history object match the 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 process.
- Unarchive with Related References: Unarchive related records and maintain 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.
Purge Settings
- Archived Data Protected from Purge: Define the number of days archived data is protected from purge policies, which permanently remove data.
Search and Display Options
- Archive Search Layout: Select up to 15 fields for the layout. Note Non-indexed fields can take longer to retrieve.
- Archive Component Search 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 verify how many fields remain in your quota.
- Archive Component Restriction Rules: Create rules to restrict the data visible
in the Archive Component. You can restrict up to 5 objects. Users can only see
child records that follow your org's sharing settings.
For more information, see Archive Component 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.
ShareFeedHistoryRelationRole
- Similar to the standard suffix objects,
LiveChatTranscriptEventobjects 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.
See Also
- Same Root and Child Filter
- Manage Archive Component Controls and Layout
- Archive Component Restriction Rules
- Manage Index Fields in Archive
- Retention vs Purge Policies in Archive
- Purge Policies
- Manage Related Records During Unarchive
- Exclude Records with External References When Archiving
- Use Enhanced Email for More Email Functionality
