You are here:
Migrate to the Archive App
Migrate your production org from the Archive managed package to the Archive App. The migration process copies your archiving policies, user permissions, and historical logs. The process takes up to one hour, and your Archive managed package remains fully operational during the data copy.
Before you begin, make sure that you meet these requirements:
- Archive App license is active in your org.
- Your org runs Archive managed package version 24.0 or later. If you're using Archive managed package 23.0 or earlier, then upgrade to the latest version.
- Assign the Archive Admin permission set to the Authenticated User.
- Salesforce admins with the standard System Administrator profile can access the Archive App by default. If you use custom admin profiles, assign the Archive App Admin permission set to those users.
- Document your current custom configurations (Lightning page widgets, Apex code, integrations) for reference when completing manual updates.
If you experience installation failures while upgrading the Archive managed package to v24, follow the resolution steps for your current package version in Troubleshoot Migration from the Archive Managed Package.
Optional: Before migrating to production, test the migration workflow in a sandbox. See Test Archive Migration in a Sandbox.
User Permissions Needed
| Permission | Purpose |
|---|---|
| Archive Admin | Assign to the Authenticated User to start migration and complete post-migration configuration. |
After your Archive App license is activated, the Archive managed package displays a persistent banner: The Archive App is available for your org. Migrate by opening Archive App from the App Launcher. Open the Archive App from the App Launcher to begin migration.
- From the App Launcher in production, open Archive (not Legacy Archive).
-
Review the information on the migration screen:
- Your Archive App license is active.
- Your Archive managed package remains fully operational with no changes to your data.
- Starting this process triggers the final data cutover to the Archive App.
- Your managed package becomes read-only.
Recommended: Review the migration requirements and post-migration checklist before proceeding.
- Select the checkbox: "I understand that this action is permanent and irreversible."
-
Click Start Migration.
The system shows "Migration in Progress" and begins copying your archiving policies, user permissions, and historical logs.
-
Wait for the data copy to complete (up to one hour).
During the copy, your Archive managed package remains fully operational and your daily archiving tasks continue. The managed package becomes read-only only after the data copy completes.
-
When the data copy completes, the screen shows: Welcome to the Archive App.
If you closed the Archive App during the migration process, open it again to view the completion screen. If the completion screen doesn't appear, refresh the page.
Your migration is complete. Your Archive managed package interface is now read-only. The screen shows a checklist of required manual configuration updates.
Complete the required manual configuration updates within 30 days. See the post-migration actions below.
- Archive App Migration Overview
Understand migration eligibility, the Archive App provisioning process, and the 30-day grace period before you migrate from the Archive managed package to the Archive App. - Test Archive Migration in a Sandbox
Test the Archive migration workflow in a sandbox environment before migrating your production org. Sandbox testing is optional. - Troubleshoot Migration from the Archive Managed Package
Review common issues and prerequisites for migrating from the Archive managed package to the Archive App. If you encounter package upgrade errors, use the version-specific resolutions in this topic.
Replace Archive Widgets with Archive App Components
After migrating to the Archive App, replace the legacy Archive widgets from the managed package with the new Archive App components on your Lightning record pages. The new Archive App components have the same configuration options as the old widgets.
The new Archive App components are:
- Archive Single Object
- Archive Multiple Objects
The configuration options for the new Archive App components are identical to the old widgets. Replace the widget and apply your existing settings.
Complete these steps for each record page that uses the old Archive managed package widget.
- Go to a record page of the object that you want to modify.
- Click the Setup gear icon and select Edit Page.
- On the page canvas, find the old Archive managed package widget and click the Delete icon to remove it.
- From the Components panel on the left, find the new Archive App component.
- Drag the new Archive App component onto the page.
- With the new Archive App component selected, recreate its configuration in the properties panel to match your previous settings.
- Save your changes.
- If necessary, activate the page.
- Repeat this process for all other record pages that use the old Archive widget.
Post-Migration Configuration Checklist
After migrating to the Archive App, complete these required manual configuration updates within 30 days of clicking Start Migration to maintain integration functionality and user access.
The Archive App shows a checklist of required manual updates after migration completes.
-
Update Archive Components.
Manually replace the legacy Archive widgets from the managed package with the new Archive App components on any Lightning record page. See Replace Archive Widgets with Archive App Components.
-
Update Custom Permissions.
Update any custom permissions based on the original Archive managed package to use the new corresponding permissions from the Archive App. See Authenticated User Permission Requirements for Archive.
Note In Setup, if you see more than one admin permission set in the Permission Sets list (for example, if your org has custom permission sets), select the one with the most recent Created Date. -
Update Apex Code (If Applicable).
If you use custom Apex code (Archive SDK) that interacts with the archive process, update your class references.
-
In your custom Apex classes and triggers, find all instances of
OB_Archiver. -
Replace all instances of
OB_Archiverwith the new class nameSF_Archive.
-
In your custom Apex classes and triggers, find all instances of
-
Verify OAuth and Connected Apps Access.
After updating permissions, verify that OAuth access works correctly. If the Archive dashboard doesn't load or users can't access Archive, see Post-Migration Authentication and Access Issues for troubleshooting steps.
Verify That the Archive App Works
After you complete the manual configuration updates, verify that your system is working as expected.
- Go to the Archive App and confirm that your archiving policies are active.
-
Test Archive App functionality:
- Archive a single test record to make sure that the service is running.
- Verify that the Archive component is visible on record pages.
- Confirm that users with the updated permissions can view and use the new component.
- Test your updated Apex code and the Lightning pages with the new Archive App component to confirm they work.
Uninstall the Archive Managed Package
When you've fully verified that the Archive App is operational and all customizations are working, uninstall the old Archive managed package.
Archive App Migration Overview
Understand migration eligibility, the Archive App provisioning process, and the 30-day grace period before you migrate from the Archive managed package to the Archive App.
Migration Eligibility
Migration to the Archive App is not available for all customers. Review the exclusions before proceeding.
Archive Products
Each Archive product has its own set of help articles. See Find Documentation for Archive Products.
| Archive Product | Description | Icon |
|---|---|---|
| Archive App | New feature for archiving objects in your org. |  |
| Own Archive | The managed package that you're leaving. |  |
| Legacy Salesforce Archive | A separate Salesforce product that isn't part of this migration path. |  |
App Provisioning vs. Migration
When your Archive App license is activated, it becomes available in your org's App Launcher. Provisioning does not start the migration process or trigger any data copy.
After your Archive App license is activated, the Archive managed package displays a persistent banner: The Archive App is available for your org. Migrate by opening Archive App from the App Launcher.
Migration begins when you click Start Migration in the Archive App. This action:
- Starts the 30-day grace period
- Copies your data from the Archive managed package to the Archive App
- Makes your Archive managed package read-only after the data copy completes
You control when to start migration. There's no predetermined schedule or deadline.
Understanding the 30-Day Grace Period
The 30-day grace period begins the moment you click Start Migration, not when your Archive App license is activated. This applies whether you're migrating in a sandbox or production environment.
After the data copy completes
Your Archive managed package admin interface becomes read-only immediately. Users can view existing data but cannot make configuration changes or archive new records through the managed package.
During the 30-day grace period
The 30-day grace period gives you time to complete the migration configuration. During this time, end users retain access to:
- Historical archived data through the Archive managed package
- Archive managed package widgets on Lightning pages that display archived data
- Custom SDK integrations (Apex code using the Archive SDK) that continue to work without modification
Use this grace period to complete the required manual configuration updates and replace these components with their Archive App equivalents. See Post-Migration Configuration Checklist.
After 30 days
After 30 days, all remaining access to the Archive managed package ends. This includes:
- Data Query SDK (Apex code that reads archived data)
- Archive component search on Lightning pages
- Archive search functionality
Accessing the Archive managed package displays this message: This Archive managed package is no longer active. You now use the Archive App. Open the Archive App from the App Launcher to manage policies and data.
See Also
Test Archive Migration in a Sandbox
Test the Archive migration workflow in a sandbox environment before migrating your production org. Sandbox testing is optional.
Make sure that you meet these requirements:
- Archive App license is provisioned in your production org.
- Create or sync your sandbox:
- If you don't have a sandbox yet, then create a Full or Partial Copy sandbox from production after the Archive App license is active.
- If you already have a sandbox, then sync it from production to receive the Archive App license.
- Make sure that Archive managed package v24.0 or later is installed in the sandbox. If you're using Archive managed package 23.0 or earlier, then upgrade to the latest version.
- Assign the Archive App Admin permission set to your Authenticated User in the sandbox. When you sync your sandbox, the Archive App license transfers from production, but permission set assignments do not. In Setup, navigate to Permission Sets, select Archive App Admin, and assign it to your Authenticated User.
-
From the App Launcher in your sandbox, open Archive (not Legacy Archive).
The migration screen opens: "Migrate to the Archive App."
- Click Start Migration.
-
Follow the migration steps in your sandbox.
See Migrate to the Archive App for detailed steps.
- Complete the manual configuration updates (components, permissions, Apex code).
- Verify that archiving functionality works as expected.
Troubleshoot Migration from the Archive Managed Package
Review common issues and prerequisites for migrating from the Archive managed package to the Archive App. If you encounter package upgrade errors, use the version-specific resolutions in this topic.
Prerequisites
Before you begin migration, confirm that you meet these requirements:
- From the Archive App, assign the Archive App Admin permission set to the integration user.
- Run Archive managed package version 24.0 or later in your org. If you're using Archive managed package 23.0 or earlier, then upgrade to the latest version before proceeding.
If you experience installation failures while upgrading the Archive managed package to v24, follow the resolution steps for your current package version.
Package Upgrade Issues
| Package Version | Error Message | Resolution |
|---|---|---|
| v22 to v24 | Content Asset Unexpected Error | In General Settings under Salesforce Files, deselect Skip triggers execution and Skip triggers. Save and try the upgrade again. After the upgrade completes, re-enable these settings. |
| v19.29 | You don't have the level of access... | Make sure that you have the Salesforce Admin profile. In General Settings under Salesforce Files, select Enable Libraries. Save and reinstall the package. |
| v19.29 | Workspace not found: sfdc_asset_company_assets |
|
Post-Migration Authentication and Access Issues
After you complete permission updates during migration, users can encounter OAuth or Connected Apps access blockages that prevent access to the Archive dashboard.
| Symptom | Resolution |
|---|---|
| Dashboard doesn't load after permission updates | 1. In Setup, go to . 2. In the Search field, enter Archive, then select your Archive app. 3. Verify that all actions associated with the app are unblocked. If you see blocked actions, select them and click Unblock. 4. Review the Connected App policies and verify that the System Administrator and Integration User profiles are listed under Permitted Users. If these profiles are missing, add them to the permitted users list. 5. Re-authenticate the Archive app. In Archive Settings, click Change Authenticated User and sign in with your credentials. 6. From the App Launcher, open Archive and verify that the dashboard loads without errors. |
| Can't access Archive after migration | This indicates that OAuth access is blocked. Follow the resolution steps above for "Dashboard doesn't load after permission updates." If the issue persists, verify that the Authenticated User has the Archive App Admin permission set assigned. |
