Salesforce Docs Portal

Set Up the Archive Widget for Lightning

Display 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 in the Archive managed package.

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

By adding and customizing the widget, Salesforce Admins can gain more control over who can view archived data. You can define all the archived related objects and the order in which they appear as a default display.

From Archive Package 21, these widgets are recommended for customization.

  • CustomListRelatedRecordArchivedWidget

    To select up to 10 archived related objects and configure the order in which they appear, use the predefined CustomListRelatedRecordsArchive widget. All records of a specific archived related object are displayed in a collapsible widget. The first three selected objects are expanded as a default view.

  • CustomSingleRelatedRecordArchivedWidget

    To select one archived related object for customized display, use the predefined CustomSingleRelatedArchive widget. The Parent Details page provides a customized view of the archived records.

Note
Note From Archive Package 21 and later, CustomListRelatedRecordArchivedWidget and CustomSingleRelatedRecordArchivedWidget are supported as Archive Visualforce Components in Salesforce Classic. In the standard email message layout, you can't add both Lightning and Classic > component /Visualforce page.

Add the Archive Widget to the Lightning Page

Add the Archive managed package widget to Lightning with one of these recommended procedures.

Create a Custom Tag

  1. At the top left of the page, click the menu icon, and filter by typing the object you want to add the widget to, such as Accounts.
  2. Select an account. A page with the selected object and its information is displayed.
  3. Click the Settings icon to open the dropdown menu, and select Edit Page.
  4. Click the middle section to view the different tabs on the right.
  5. Click Add Tab to add a new tab.
  6. Click the newly added tab. Select Custom from the dropdown menu. Update a custom label for the tab, such as Archive.
  7. Click the newly created tab to configure it.
  8. Drag one of the Lightning Components under Custom Managed from the left menu onto the newly created custom tab.
  9. Complete the Default Child Objects as required.
  10. Click Save.
  11. Click Activation.
    The results are displayed to your users as defined, with an overview of the total number of records archived displayed. To drill down and expand the results, click a widget.
Example
Example To let Customer Support users view archived Cases through the SingleRelatedObject widget, the default child object must be Case, and only users with a Customer Support profile can see the widget.

Create a Custom Component

  1. Go to Setup.
  2. Select the Object Manager tab.
  3. Select the Object to insert the widget on its page, such as Account.
  4. Select Lightning Record Pages to access the layout editor.
  5. Select the existing record page or create one.
  6. Select Edit.
  7. Select the location to insert the widget on the page.
  8. On the Components toolbar scroll to the Custom - Managed section.
  9. Locate the components CustomListRelatedRecordArchivedWidget or CustomSingleRelatedRecordArchivedWidget.
  10. Drag the component to the location.
  11. Save the change.
  12. Make sure the page is Activated.
  13. Click Close to go back to the object.

Archive Widget Access and Download Control (Optional)

Standard users can't access archived data through the widget and may encounter a system.security.NoAccessException error.

To turn on Archive Widget access:

  1. Go to Setup.
  2. Locate Permission Sets and select Archive View Archived Records.
  3. To assign the permission set to relevant users, click Manage Assignments and then Add Assignments.