GRAX Lightning Connect

Let's take a look at how to use GRAX's lightning related list feature to visualize related record data directly on your Salesforce record detail page.

🚧

Compatible with Salesforce Lightning Only

It is important to remember that this Lightning Component feature is ONLY available in Salesforce Lightning. Please work with your internal Salesforce Administrator to set up the pages as desired to conform with your lightning page configurations; GRAX does not provide Salesforce Administrator services.

*Also note that you may need to enable custom domain in Salesforce to work with custom lightning components. See Salesforce help for more information.

Settings and Instructions

GRAX Lightning Connect is intended to be utilized to display related records which are in the datalake. Users have the ability to show an unlimited number of related lists, set the fields to be viewed, preview the records, and restore the records.

To create your Lightning Component related list, follow these steps:

  1. Go to the object an page layout that you would like to add the related list to then click the gear, and Edit Page
  2. On the left hand side of the screen, scroll to the section Custom - Managed and drag the component GRAX_LgtCmp_CustomRelatedList to the desired location
  3. On the right hand side, set the following values:

Lightning Component Parameter

Description

Object Name

Enter the API Name of the object that you want the related list to be based off of… for example “Consignment_Note__c”

Relationship Label

Label for your related list if you do not want to use API Name

Fields to Display

Enter the API Name of the fields on the object that you want displayed separated by a comma. For example, “ID,Name”

Height

This will set the height of the related list AND the preview screen if you select this option.
It is recommended to have a height no less than 400.

Show Preview Button

Set to true if you want to allow your users the ability to preview this record

Show Restore Buttons

Set to true if you want to have ability to restore certain records (remember GRAX permission sets still dictate who can restore so even with this enabled does not guarantee user will be able to restore)

Relationship Field Name

The field on the 'child' object that you want to use to match against the Parent Field

Enter the API name of the relationship field that you want to display. For example, the Contact object could have 10 different lookup fields to Account - which relationship/linkage field do you want to display with this related list component? Or in this Account/Contact example, you may have an external ID field that matches to Accounts at the Contact level.

In the standard scenario where you have a single standard lookup on Contact pointing to Account, you can leave this and the Parent Field blank.

Parent Field

This defines which value you want to use from the parent object for matching. For example, instead of using the standard SFDC ID of the parent object, you may want to use an external ID field on the Account that you would specify here.

Specify the parent field's API name.

Query Filter

this powerful functionality allows you to further filter which records you want to display in the related list. For example, you could show only a certain record type etc.

Show Records From All Environments

If you have data from multiple orgs in a single data lake, use this checkbox to see everything.

  1. Save your updated page layout

Settings / Parameters

Ability to preview records

By checking the Display Restored Info checkbox you will add two columns to the component, the restored record and last restored date

As you can see in the Query Filter, here we are only showing Meter Reading records that have a certain field value of 965

🚧

Rich Text Fields

Note that Salesforce rich text fields may render as html.