The Archive Viewer allows Salesforce users to view archived records from a Gearset archive within Salesforce. Problems relating to the viewer can occur for many reasons - those most common are detailed below.
I cannot see the "Archived Records" tab
If you cannot see an "Archived Records" tab on a specific object, then it is likely that the tab has not been added. To verify this, navigate to the settings cog and go to Edit page. If you cannot see the "Archived Records" tab here, then you will need to create a tab on the page and add the gearsetArchivedRecordsViewer lightning web component to the tab. You may need to activate the page to allow your users to see the tab.
Can't see the Edit page option? This likely means that you are not a Salesforce admin and do not have permission to edit this page. Please speak to your Salesforce admin and ask them to follow this troubleshooting step.
I cannot see any archived records
If you repeatedly see the warning of "No archived records" then it is likely that your archive is empty, does not archive any records related to this object, or archives records which do not look up to any others. The archive viewer shows archive records that are related to a specific record - if you have no archived records then you will need to create an archiving policy within Gearset.
I cannot find the gearsetArchivedRecordsViewer
If you cannot find the gearsetArchivedRecordsViewer when trying to add it to a tab within Salesforce, then it is likely that you have not deployed the archive viewer to this organization. Please verify that you are logged into the organization associated with the archive that you have set the viewer up for or attempt the archive viewer setup again.
The "Archived Records" tab is showing an error
If you have the archive viewer connector deployed and have followed the connection steps and still see an error within the tab, then use the following to understand your error.
We're processing a lot of requests right now
You've been sending too many requests to Gearset within a short amount of time. This can happen if you have many users accessing the archive viewer at the same time. If this happens frequently, please reach out to the Gearset team.
The connection for this page has expired
Your Archive Viewer API key has likely expired. You may need to create a new one by navigating to the archive settings (and connecting it to your organization) or you may wish to extend the duration of the API key using Access Token Management.
Access to the archive has been blocked
This implies that your API key is not currently linked to your archive. You will need to create a new key in the archive settings and connect this to your Salesforce organization.
The request timed out
Sometimes fetching related records takes a long time, especially if your archive is particularly large. Salesforce has a built in limitation that means that if Gearset does not respond within a specified timeframe, an error is thrown. To fix, try refreshing the page. If this happens frequently, please speak to Gearset support.
You don't have permission to access the archive
As part of the Archive Viewer Connector metadata, there is a permission set that allows users to access the archive. If you see a permission error, then this implies that you have not assigned yourself the GearsetViewArchivedRecords permission set.
You have not connected your API key
The second step of the archive viewer setup is to add an API key to the Gearset Archive Viewer external credential principal header. This error indicates that this key has not been added. To add this key, follow the Connection Steps guide (LINK).
The server encountered an error
Please try refreshing the page. If you see this error consistently, please reach out to Gearset support.
An unexpected error occurred accessing the archive
If you have deployed the Archive Viewer Connector metadata and are not seeing any of the above errors, then you will see a more general error message like this one. The error description will aid in identifying the problem.
No archiving run is available
In order to see archived records, you must have ran an archiving policy at least once - specifically, you must have deleted records from your Salesforce organization using Gearset (and have not just ran a preview policy run).
Revision ID for record is missing or invalid
Verify where the archive viewer lightning web component has been placed. We currently only support being shown on a record page.
Archiving job is missing or invalid
The archive connected to the archive viewer API token has been deleted. You will need to create a new archive and follow the setup steps again if you wish to continue using the archive viewer.
You might not have the required permissions, or the named credential "GearsetArchiveViewer" might not exist.
This can occur if you have manually created a permission set and not included the permission to read the external credential. To fix, either assign the permission set included in the bundle or ensure your users have the permission to read external credentials.
Error code: X
If you receive an error which specifies an error code, then try to refresh the page and see if the error is resolved. If you see this error consistently, please contact Gearset support.