Login

Lightning Web Components

The GRAX Lightning Web Components (LWCs) allow you to bring the power of GRAX directly into SFDC.

We offer 2 generations of LWCs:

Second Generation LWCs

Available Second Generation Components

The following LWCs are available in our Second Generation Managed Package:

GRAX Related Records

The GRAX Related Records LWC is purpose-built for use on a "record page" in SFDC. It can be added to a record page layout and configured to display records for a specific object that is related to the current context. Records can be filtered by status (live, deleted, archived, etc.) and returned/displayed fields can be specified per component instance.

Related Records Example

"GRAX Related Records" Example Use Cases
  • Display archived and/or deleted EmailMessages related to a Case
  • Display all recent Cases for an Account, regardless of whether or not they have been deleted

GRAX Versions (v2)

The GRAX Versions LWC is purpose-built for use on a "record page" in SFDC as well. It can be add to a record page layout and configured to display all historical versions of the currently viewed record. This allows users to analyze changes to a record over time, identify who made changes, and even restore a previous version of the record if necessary.

GRAX Versions Example

"GRAX Versions (v2)" Example Use Case
  • Display previous versions of an Account record so you can track what changes were made and when.

GRAX Search

The GRAX Search LWC is implemented as a "custom tab" and is available by default after installing the package via the App Launcher as GRAX Search. It allows users who have the appropriate permission sets to create and manage GRAX Global Search jobs and results from within SFDC.

GRAX Search Example

"GRAX Search" Example Use Case
  • End users may need to be able to search for EmailMessage records that are no longer in SFDC (archived or deleted) and they don't want to have to leave SFDC to do so.

Second Generation LWC Permissions

In order to view the LWCs, users will need:

  • At least one of the following GRAX permission sets:
    • GRAX Console Standard Permission or GRAX - User
    • GRAX Console Seeding Permission
    • GRAX Console Purge Permission
    • GRAX Console Power Permission or GRAX - Advanced User
    • GRAX Console Admin Permission or GRAX - Configuration Admin
    • GRAX Console View All Fields
  • The ability to self-authorize, or be pre-authorized by an admin, if they have never logged into GRAX before and want to view the LWCs.

πŸ“˜

Access Control

The GRAX LWCs enforce the same access controls as if users were accessing the GRAX application directly. This means that users will only be able to load the components and interact with data if they have been granted access to GRAX via permission sets.

Visibility can be further restricted by utilizing standard SFDC tools.

Second Generation LWC Installation and Configuration

To install the GRAX Related Records and GRAX Versions LWCs, use the SFDC Lightning App Builder from the Record Home page.

  • Navigate to the object where you want to install the LWC
  • Click Edit Page to open the Lightning App Builder
  • Scroll down to the Custom - Managed section
  • Add the LWC of your choice
  • Click Save and Activate

The GRAX Search LWC can be found in the App Launcher as a custom tab.

App Launcher List

First Generation LWCs

Available First Generation Components

The following LWCs are available in our First Generation Managed Package:

GRAX List Records

The GRAX List Records LWC is purpose-built for use on a "record page" in SFDC. It can be added to a record page layout and configured to display records for a specific object that is related to the current context. Records can be filtered by status (live, deleted, archived, etc.) and returned/displayed fields can be specified per component instance.

"GRAX List Records" Example Use Cases
  • Display archived and/or deleted EmailMessages related to a Case
  • Display all recent Cases for an Account, regardless of whether or not they have been deleted
"GRAX List Records" Customization

The GRAX List Records LWC is the only First Generation LWC that can be customized. Customization options include:

  • Related Object: Determines which related object is displayed within the LWC.
  • Related Object Fields: Determines which object fields are displayed within the LWC.
  • Override Title: Allows the LWC title to be overridden.
  • Data Set Selection: Determines which data set is displayed within the LWC (All Data (Live + Archived + Deleted data), Archived Data, Deleted Data, or Archived + Deleted Data).
  • Use iFrame: Allows for faster loading.
  • iFrame px size: Determines the size of the iFrame.
  • Records per Page: Determines the number of records displayed within each page of the LWC.
  • Hide ID Field: Determines whether the Record ID is visible within the LWC.
  • Child Level: Determines the number of levels of child records that are displayed within the LWC.
  • Additional Parameters: This field is deprecated and is no longer relevant.

The following customization options are only applicable when the Use iFrame option is NOT enabled:

  • Hide Show Record: Determines whether the Show Record option is visible in the dropdown menu located on the far right of each row within the LWC.
  • Hide Show in GRAX: Determines whether the Show in GRAX option is visible in the dropdown menu located on the far right of each row within the LWC.
  • Hide View Graph: Determines whether the View Graph option is visible at the top of the LWC and in the dropdown menu located on the far right of each row within the LWC.
  • Hide Restore Button: Determines whether the Restore button is visible within the LWC after clicking Show Record. This setting is only applicable if the Hide Show Record setting is disabled.
  • Do NOT Enforce Security or Salesforce Object Deleted: Determines whether the LWC respects FLS. Salesforce Object Deleted is bundled with not enforcing FLS because when an object is deleted, SFDC does not contain that object schema anymore, and therefore GRAX cannot check if the LWC user should see the deleted object or not.

GRAX Versions

The GRAX Versions LWC is purpose-built for use on a "record page" in SFDC as well. It can be add to a record page layout and configured to display all historical versions of the currently viewed record. This allows users to analyze changes to a record over time, identify who made changes, and even restore a previous version of the record if necessary.

"GRAX Versions" Example Use Case
  • Display previous versions of an Account record so you can track what changes were made and when.

GRAX Single Record Restore

The Single Record Restore LWC provides restore capability to end users. While it's possible to install this component individually on a page, it does rely on the GRAX Versions component to provide the capabilities described here.

"GRAX Single Record Restore" Example Use Case
  • Restore a previous version of an Opportunity because the user doesn't remember making the most recent changes.

First Generation LWC Permissions

In order to view the LWCs, users will need:

  • At least one of the following GRAX permission sets:
    • GRAX Console Standard Permission or GRAX - User
    • GRAX Console Seeding Permission
    • GRAX Console Purge Permission
    • GRAX Console Power Permission or GRAX - Advanced User
    • GRAX Console Admin Permission or GRAX - Configuration Admin
    • GRAX Console View All Fields
  • Access to the GRAXLWCHelper Apex Class.
    • You can grant access to the GRAXLWCHelper Apex Class by navigating to the user's profile, clicking on Enabled Apex Class Access, adding the GRAXLWCHelper Apex Class and then clicking Save.
  • The ability to self-authorize, or be pre-authorized by an admin, if they have never logged into GRAX before and want to view the LWCs.

πŸ“˜

Access Control

The GRAX LWCs enforce the same access controls as if users were accessing the GRAX application directly. This means that users will only be able to load the components and interact with data if they have been granted access to GRAX via permission sets.

Visibility can be further restricted by utilizing standard SFDC tools.

First Generation LWC Installation and Configuration

To install the LWCs, use the SFDC Lightning App Builder from the Record Home page.

  • Navigate to the object where you want to install the LWC
  • Click Edit Page to open the Lightning App Builder
  • Add the LWC of your choice
  • If you installed the GRAX List Records LWC, customize the LWC to display the object/fields desired (see Customization below)
  • Click Save and Activate

Screen Shot 2021-05-03 at 9.36.37 AM.png

Considerations / Known Issues

⚠️

Separate Tabs

It is recommended (and a documented SFDC best-practice) to place LWCs like GRAX's on separate tabs within page layouts that are not visible/open by default upon page visit. This reduces the load on GRAX, the user's browser, and SFDC itself by avoiding unnecessary work if a user is visiting the record page for a reason other than using GRAX.

  • You may see what looks like an error in the "Difference" calculation on the First Generation GRAX Versions LWC. This could occur when the user that is viewing the LWC has a different set of Profile permissions than the GRAX integration user. This number is calculated out of the GRAX Data and therefore should have a view of all fields.
    • This would show to the end user as a difference that is greater than the number of fields shown when they are looking at only the modified fields.
    • This indicates that some of the fields that are different aren't visible to the user who is viewing the record.
  • These LWCs are only available for the Lightning Experience on the Desktop. SFDC Classic and mobile aren't supported.
  • The GRAX Single Record Restore LWC respects profile settings, but shows fields that are hidden on the page layout.

FAQs

Is the GRAX Managed Package required in order to utilize the GRAX LWCs?

Yes. To install the First or Second Generation Managed Packages, click here.

How do I know if I have the First or Second Generation Managed Package installed?

The First Generation Managed Package namespace is grax, while the Second Generation Managed Package namespace is graxinc.

Why do I see other GRAX LWCs in the Lightning App Builder?

You may see GRAX_LgtCmp_CustomRelatedList and GRAX_LgtCmp_RefreshBulkAPIJob LWCs within the First Generation Managed Package. These LWCs are deprecated and have been removed from the Second Generation Managed Package.

Are there any requirements with regard to where the First Generation "GRAX Versions" and "GRAX Single Record Restore" LWCs are placed since they work together?

Both LWCs should be on the same tab, but there are no other placement requirements.

Why don't I see the "GRAXLWCHelper" Apex Class in the "Enabled Apex Class Access" section?

Whether you're able to see the GRAXLWCHelper Apex Class within the Enabled Apex Class Access of a profile is dependent on which users were provided access to the managed package when it was installed.

If you're unable to see the GRAXLWCHelper Apex Class within the Enabled Apex Class Access of a profile, we recommend updating to the latest version of GRAX and selecting the Install for Specific Profiles option.

Appendix