For the complete documentation index, see llms.txt. This page is also available as Markdown.

Features

Second-Generation Managed Package

Demos and Training Always Available

The Related Records component is designed to make viewing records that are related to a live Salesforce record as easy as possible, regardless of whether they are also live in Salesforce, were deleted by a user, or archived by GRAX.

Related Records Component

This component is most valuable in Salesforce orgs that take advantage of GRAX's Archive features to keep the size and growth of their org under control. As you move more of your historical data out of Salesforce, it becomes increasingly important to be able to access that data in a user friendly way. With this component, users don't even need to leave the record page to:

  • See all cases ever opened for a customer, deleted or not

  • Review email threads related to deleted cases

  • Reread the notes on recurring tasks that were cleaned up years ago

  • ...and much more.

This component can be placed on record detail pages. It automatically searches for records matching the configured filters that are related to the record being viewed. For example, if the component is placed on an Account record page, the component will display records related to that account or its children. The set of fields returned can be configured in the component settings once added to a page.

Users can jump out into the standalone GRAX web application at will if their exploration becomes deep or complicated enough by clicking on the record hyperlinks.

Configuration

The following settings can be configured via the component properties within the Lightning App Builder:

Setting
Effect

Related Object

Controls the type of records that will be displayed.

Dataset Selection

Filters out records based on their deletion status.

Possible values are:

  • All (Live, Deleted, and Archived records)

  • Archived (Deleted by GRAX Archive)

  • Deleted (Deleted by any other means)

  • Archived or Deleted (Anything not Live)

Child Level

The level in the hierarchy under the root record that records should be retrieved from.

For example:

  • 1 means immediate children of the root record

  • 2 means grandchildren of the root record

  • 3 means children of grandchildren of the root record

Fields

A comma-separated list of Field API names to include in the output table. If no field exists for a provided name, that column will be blank in the resulting table.

Records Per Page

The number of records that will be displayed at once on the table. If more records than this exist, users can page through the results.

Override Title

Allows customization of the default page title which is usually based on the root object type.

Height

Sets the height of the component in the page.

Additional Configuration

A place to set optional, advanced configuration values that get passed to the GRAX application.

Record Versions Component

The Record Versions component is designed to make exploration of single-record history as easy as possible. This component can be placed on record detail pages. All backed up versions of the target record will be shown in the table, alongside a measure of how different each version is from the current state of the record.

Record Versions Component

Through use of the "Compare" functionality, users can see at a granular level what was changed in each version, what the old and new values were at each change, and even who made the change. Users can restore either an entire version of a record or cherry-pick specific fields from specific versions to restore.

Record Versions Comparison

Users can jump out into the standalone GRAX web application at will if their exploration becomes deep or complicated enough by clicking on the record name hyperlink.

Configuration

The following settings can be configured via the component properties within the Lightning App Builder:

Setting
Effect

Records Per Page

The number of records that will be displayed at once on the table. If more records than this exist, users can page through the results.

Override Title

Allows customization of the default page title which is usually based on the root object type.

Height

Sets the height of the component in the page.

Previewing the LWC in your GRAX App

The Related Record Builder within your GRAX app provides an interactive tool to build and preview the LWC configuration. Simply navigate to your GRAX App Settings, click on Diagnostics and Tools and choose the Related Record Builder at the bottom of the page.

Related Record Builder Sample Data
  • Under General Settings, enter in the Parent Record ID of the object you'd like to view.

  • Enter an Override Title (e.g., 'Archived Case Records').

  • Choose the Related Object you want to display (e.g., 'Case').

    • When the Related Object is chosen the Child Level will automatically populate with the correct level of the Related Object.

  • Select the Data Set Selection: All Data, Archived Data, Deleted Data, or Archived + Deleted Data.

  • Add the Fields you want to display on the LWC (e.g., Case Number, Subject, Status).

By default, the Sample Data will show the record ID, mod stamp and the "Name" field. However, once you specify the fields you'd like to display those are dropped for your selection.

Related Record Builder General Settings

Once the LWC preview is configured to your liking, use the LWC Settings Reference to auto-populate your settings within the Salesforce LWC directly. Click the Copy to LWC button (box with arrow icon) to transfer your settings.

LWC Settings Reference

Global Search Component

The Global Search component is designed to let users search for data within GRAX using powerful filters and conditions without needing to leave the Salesforce platform. It offers parity with the normal Global Search experience in a form that will sit right alongside your other application tabs in Salesforce.

Global Search Custom Tab

As an Administrator, you can let your users interact with the full Global Search feature set, shown above, or give users a constrained template-based experience, shown below. Templates allow Administrators to define performant, index-optimized searches for use by end-users. This can help reduce the wait-time for results, strain on infrastructure, and the amount of training required for new users.

Template Search in Search Tab Component
Template Search Results
Template Search Record View
Configuration (App or Home Page)

This configuration information is only relevant if using the Search component on an "AppPage" or "HomePage" within Salesforce. If using the component as a standalone Custom Tab, see the section below.

Setting
Effect

Mode

If "Full Search" is selected, users will see the full Global Search experience. If "Template Search" is selected, users will see the template-based Search experience.

Show Template ID

This setting only has an effect if the "Mode" setting is set to "Template Search". If enabled, users will be shown the input form for a specific template with the given ID. If disabled, users will be shown the list of all available templates.

Configuration (Custom Tab)

This configuration information is only relevant if using the Search component on a standalone Custom Tab within Salesforce. If using the component on an App or Home page within Salesforce, see the section above.

Custom Tabs within Salesforce do not have the same configuration options as native Lightning Web Components. To change the behavior of your Custom Tab, you can change settings within the GRAX package's Custom Settings:

Setting
Effect

Search Tab: Template Search

If enabled, users will see the template-based Search experience within the Custom Tab.

If disabled, users will see the full Global Search experience within the Custom Tab.

Search Tab: Show Template ID

This setting only has an effect if the "Search Tab: Template Search" setting is enabled. If enabled, users will be shown the input form for a specific template with the given ID. If disabled, users will be shown the list of all available templates.

These settings do not have any impact on the Search component when used as a native Lightning Web Component on an App or Home page.

Do you need something slightly different?

Permissions Model

The components included in the Managed Package are secured by the same permissions model that the normal GRAX application interface uses. To use the components, users must have one of the following permission sets:

  • GRAX Console Standard Permission

  • GRAX Console Seeding Permission

  • GRAX Console Purge Permission

  • GRAX Console Power Permission

  • GRAX Console Admin Permission

These permission sets are created by Auto Config when you connect your GRAX app for the first time.

Users will also need to self-authorize the GRAX connected app by opening the GRAX application in a separate tab the first time they log in. This can be avoided by an admin pre-authorizing the users via the Connected App settings.

Last updated

Was this helpful?