Archive App

Manage growing data volumes and improve system performance by archiving old or inactive data. The Archive app not only enhances system performance by reducing data volume but also helps you maintain accurate and consistent data. You keep only important and reliable information in production.

• Get Started with the Archive App
  The Archive app helps you manage storage costs and enhance performance by moving historical data out of your org.
• Archive Admin Permissions
  To secure sensitive archived data and manage storage efficiently, configure granular access levels for admins and end users. By using a role-based approach, you can restrict unarchive or purge capabilities to authorized users or teams based on their specific operational requirements.
• Authenticated User Permission Requirements for Archive
  Archive connects to your Salesforce org through the API via an Authenticated User. This user account serves as the integration point for all Archive operations.
• Hyperforce Infrastructure in the Archive App
  As the Archive app transitions to Salesforce Hyperforce infrastructure, certain legacy authentication and data handling processes are streamlined or replaced.
• Archive Regions and IP Addresses for Allowlisting
  Find the AWS data center locations where Archive stores data. To ensure successful connection requests, add the IP addresses for your specific region to your organization's allowlist.
• Archive Dashboard (Home Tab)
  The Archive app dashboard under Home provides a comprehensive overview of your data, file storage, and other essential metrics.
• Run an Archive Field-Level Security (FLS) Report
  To identify which fields to include or exclude during the archive process, run a Field-Level Security (FLS) Report in the Archive app.
• Archive Storage Analyzer
  Get a comprehensive analysis of data and file storage within your Archive app production org. This visual tool provides an overview of the top objects consuming storage and their usage history.
• Configure Archive Settings
  Configure settings to archive, unarchive, purge, search, display, and export records in the Archive app.
• Get Started with Archive Policies
  Use the Archive app to create automated, scheduled policies that manage your data's lifecycle.
• Create Archive Policies
  To select specific records for archiving, define filters, schedule a process, and set data retention periods, create a policy in the Archive app.
• Manage Archive Policies
  To streamline your data archiving process in the Archive app, run, edit, clone, estimate, and preview archive policies.
• Archive Activities Tab
  The Activities tab opens the Activities Table in the default list view of logs in the Archive app. You can create your own custom list views to filter and sort this information.
• Set Up the Archive Widget in the Archive App
  Show archived data as related lists within Salesforce. Even though the data has been archived and is no longer stored directly in Salesforce, end users can still access and view the data in the familiar Salesforce interface.
• Manage Archive Widget Controls and Layout
  Manage the display and configuration of objects within Archive app widgets, defining both root and child objects that end users can query. Also, the layout provides insights into root-child object relationships via the Is Root identifier.
• Grant Access to the Archive Widget in Experience Cloud
  To access the Archive app widget in Experience Cloud, assign users the appropriate permission set.
• Add the Archive Widget to Lightning Pages
  Add an Archive app component, also known as a widget, to Lightning Experience record pages with one of these recommended procedures.
• Archive Widget Restriction Rules
  Control end-user visibility in Salesforce of specific archived records according to object sharing tables in the Archive app. Applicable to Archive Single Objects and Archive Multiple Objects widgets.
• View Archived Records in the Archive App
  When a record is archived, the Archive app preserves the record's metadata at the time of archiving, including its assigned Record Type and the data available on the layout. Page Layouts are based on the viewing user's profile, while Dynamic Forms aren't supported for archived records.
• Archive Search
  To access archived data, use Archive Search in the Archive app to find archived records related to your org.
• Manage Index Fields in the Archive App
  Efficient management of index fields in the Archive app is essential for optimizing search and query performance. Archive automatically indexes certain fields based on internal algorithms. However, some fields can't be indexed at all, and others must be configured manually for optimal data retrieval. The Index Fields Setup feature provides admins with visibility into which fields are indexable and permits manual selection to improve search performance.
• Retention vs Purge Policies in the Archive App
  Managing data in the Archive app is done through retention and purge policies. Explore the characteristics of each policy type, and their differences.
• Purge Policies
  Define data removal policies for archived records in the Archive app. Purge policies override the original data retention expiration set at the time of archiving. When designated to do so, purge policies permanently delete data.
• Unarchive from Archive Search or Archive Widget
  Restore archived records with Archive Search or Archive Widget in the Archive app.
• Archive SDK—Right to Be Forgotten (RTBF)
  Data privacy regulations grant individuals the Right to Be Forgotten (RTBF), requiring organizations to securely erase personal data upon request. Archive SDK enables compliance by identifying and deleting specific data from the Archive app, ensuring thorough removal while preserving the integrity of other archived data.
• Archive SDK Data Query
  The Archive SDK Data Query enables programmatic access to archived data in the Archive app. These data queries automate business processes, support third-party system integrations, create custom views and reports, and cross-reference archived data with active records.
• Archive SDK Testing
  Before working in your production environment, run tests in your Apex Class Wrapper in the Archive SDK in the Archive app.
• Unarchive SDK
  In the Archive app, programmatically start an unarchive function based on specific filters. Then initiate a search by code and get the results that match your request.
• Manage Legal Hold Requests in the Archive App
  Place archived records on legal hold by creating a legal hold request in the Archive app. When records are under legal hold, they can't be unarchived, deleted, or removed—whether accessed through the SDK RTBF or the user interface.
• Restrict Visibility for Imported Data in the Archive App
  Secure sensitive archived records by manually enabling Archive Widget Search Restriction Rules and uploading custom sharing entries for specific objects. This configuration prevents unauthorized users from accessing imported data in the Archive widget while maintaining visibility for record owners.
• Import Data from a Local Drive in the Archive App
  Import offloaded Salesforce data stored in local CSV files to the Archive app staging area. Then manage the final data migration and set specific retention periods for your records by configuring an Archive import policy.
• Prepare Your Data and AWS S3 Environment for Archive Import
  Successfully import offloaded Salesforce data into the Archive app.
• Export Archive Search Results
  Set criteria to find target archived records in the Archive app and export the search results. You can download these search results as a CSV file.
• Export from Archive CSV to Download
  Export records from the Archive app by selecting single or multiple criteria.
• Export to AWS S3 Bucket
  Export data from the Archive app to an AWS S3 bucket.
• Archive Incremental Export
  Rather than exporting the entire dataset from the Archive app every time, export only the data that was changed or added after the last export.
• Archive Limitations
  Various limitations and unsupported features for archiving, unarchiving, and other functionalities within the Archive app, including policy record limits, object exclusions, and operational constraints.
• Image Limitation for Archive Content Notes
  Content Notes that contain embedded images can't be archived in the Archive app.
• Common Errors and Warnings in the Archive App
  Errors and warnings that occur when using the Archive app, and how to solve them.
• Salesforce Objects Excluded from the Archive App
  Objects excluded from the Archive app fall into one of these categories: non-deletable and non-queryable objects, or objects without relationship names.
• Create a Custom Agent Action
  Create a reusable action, and then assign that action to the agent in the Archive app.
• Search with the Archive Agent
  Search for archived records in the Archive app by using the Archive Agent. Specify an object directly in your search phrase, add criteria for accuracy, and work within system limitations to find the records you need.