Introduction

Ardira RelationshipVista (“RVC”) is a Lightning Web Component(LWC) that allows quickly navigating and visualizing all the related records of a record. The component can be dropped in a record detail page to visualize all the related records.

When an RVC component is dropped in a record detail page, 

  • It will automatically allow your users to navigate and visualize all the related records.
  • Use Relationship Views (R-Views) to create custom visualizations of related records tailored to your needs.
  • “R-Views” are similar to Salesforce “List Views”. 
  • Empower your users with flexibility – choose to allow them to configure their own R-Views, or opt for pre-configured views to streamline data analysis.
Ardira RelationshipVista Component

To start using the Relationship Vista, edit your record detail page, create a custom tab and drop the “Ardira RelationshipVista” component in that page. Name the custom tab appropriately (e.g. RelationshipVista). You are not limited to adding the component in a custom tab, you can add the component anywhere in the record page.

Make sure to save and activate the page.

For example, if you had dropped an RVC in your account detail page, you will be able to visualize account related records.


RVC component Properties

RVC Component supports following public properties:

Record Id: The “Id” field pertains to the record whose relationships are to be visualized. When the component is placed in a record page, there is no need to manually input the record id, as the platform will automatically set it.

Use Configuration: If a view configuration name is specified, the relationship view will be rendered with that configuration and users will not be able to select an alternative configuration. However, it’s important to note that this functionality only works when none of the views from the View Configuration are pinned.

Allow Users to Update View Configuration: Enabling this setting grants users permission to create and edit view configurations that are owned by them. If this setting is disabled, users will not have the ability to create or edit view configurations.

Show: This setting allows you to specify which records should be displayed in the visualization. The default option is “My Records,” which displays records that are owned by the currently logged-in user. Alternatively, you can select “All Records” to display all records that are accessible to the currently logged-in user.

Auto Expanded Levels: This setting determines the number of levels that will be automatically expanded when the visualization is first displayed. However, if a value is entered for “Max Visible Records Count” in the View Configuration, this setting will be overridden.

Please note that auto-expand functionality only applies to object and group nodes, and will not work with record nodes.

Show Objects: To restrict the types of records that are displayed in the visualization, you can specify a comma-separated list of object API names. Only records from the specified objects will be included in the visualization.

Visible Records Limit: This setting determines the maximum number of child records that will be displayed for a parent record. Any additional records beyond this limit can be viewed by clicking on the “View n more…” option.

View Layout: This setting allows you to specify which visualization layouts should be enabled for the component. The available options are:

  •  All: This option enables all supported layouts and allows users to switch between them. This is the default setting.
  • Explorer: This layout displays the relationship view with an explorer or indented tree layout.
  • Tree: This layout displays the relationship view with a graphical tree layout.

Width: This setting determines the width of the visualization area in pixels, as a percentage of its container, or “auto” to automatically adjust the width based on the size of the component. In most cases, the default setting of “100%” works best with the most layouts.

Height: This setting determines the height of the visualization area in pixels, as a percentage of its container, or “auto” to automatically adjust the height based on the size of the component. In most cases, the default setting of “auto” works best with the most layouts.

  • Note: * Please note that these properties can be overridden by view-level configurations..
Relationship Views (“R-Views”)

When the component is first placed in a record page, the relationships are displayed based on the component attributes that were set in the page builder. You can create custom configurations using the relationship view selector.

You can configure “Relationship Views” using relationship view selector to navigate and visualize related records that are important and/or relevant. “Relationship Views” management is similar to managing Salesforce “List Views”. Relationship View configuration allows you to configure each node in the view hierarchy to restrict types of records to visualize, filter records, group records by object fields, and more.

Sample Data

When evaluating RVC in a sandbox/test environment, use the RelationshipVista Getting Started tab to quickly add sample data.

Go to the “RelationshipVista Getting Started” tab from the app launcher.

Click “Load Sample data” to load some sample data to play around and experience RelationshipVista.

The screenshots used in the subsequent sections use the following sample data.

Create/Update/Delete a View Configuration

A view configuration allows you to set what records are visualized in the relationship view by configuring the view configuration properties at each node in the relationship view.

If your Salesforce administrator has configured an RVC so that users can update view configurations, you will see the following options to manage your view configurations.

A view configuration has following properties:

Name: This setting refers to the name of the View Configuration.

Show: This setting allows you to specify which records should be displayed in the visualization. The available options are:

  • My Records: This option displays only the records that are owned by the currently logged-in user. This is the default setting.
  • All Records: This option displays all records that are accessible to the currently logged-in user.

Pinned: If this setting is enabled, the view will become the default view for any user who created the View Configuration.

Max Visible Records Limit: This setting determines the maximum number of child records that will be displayed for a parent record. Any additional records beyond this limit can be viewed by clicking on the “View n more…” option. Please note that this setting overrides any “Auto Expand Level” configurations that are set for the component on the Page Layout.

Sharing Setting: This setting allows you to configure the visibility of the View Configuration. The available options are:

  • Only Me: This option restricts the View Configuration to be visible only to the user who created it.
  • All Users: This option makes the View Configuration visible to all users in the organization.

Root Node Configuration

You can configure the root node in a “Relationship Views” to navigate and visualize related records that are important and/or relevant. To update the node configuration of a relationship view, select the view and click edit. To configure a root node, click the settings icon next to the node. It will open the root node configuration dialog with the following configuration options:

  1. This setting displays the object type that is configured by the current node configuration.
  2. Record Node Label Field : You can select a field that will be used as the label for the record nodes in the visualization. The value of this field will be displayed next to the node representing the record.
  3. Auto Expand: This setting allows you to enable automatic expansion of a node when it is visualized. When this setting is enabled, the node will automatically expand to show its child nodes when the visualization is loaded.
  4. Show Objects: This setting allows you to select a set of objects that will limit the type of records displayed in the visualization as children of the current node. Please note that the “Show Objects” setting at the node level will override the corresponding view-level setting.

Node Configuration

You can configure each node in a “Relationship Views” to navigate and visualize related records that are important and/or relevant. To configure a node, click the settings icon next to the node. It will open the node configuration dialog with the following configuration options:

Click on gear icon and click on Edit.

  1. To modify or edit the configuration of an object, click on the gear icon corresponding to that object. This will display the configuration options for the selected object, including the object type that is currently configured by the node.
  2. Object Node Label : This configuration setting allows you to modify the label used for the object node in the visualization.
  3. Record Node Label Field : This configuration setting enables you to choose a field whose value is utilized as the label for the record nodes in the visualization.
  4. Auto Expand: This setting allows you to enable automatic expansion of a node when the visualization is displayed. If enabled, the node and its immediate child records will be expanded by default.
  5. Display Configuration Node: Enable this setting to display the configuration node in the visualization layout as a node.
  6. Cascade Auto Expand: If the Auto Expand setting is enabled, the visualization will automatically expand up to the next record node. If Cascade Auto Expand is enabled, the visualization will automatically expand one more level to the subsequent record node. This option is useful when you want to expand past junction object records.
  7. Display Record Node: This option allows you to show or hide record nodes in the visualization. Hiding record nodes can be useful in the case of junction objects, where the nodes may not provide relevant information for the user.
  8. Record icon URL : You can set the standard or custom icon from the Lightning Design System (https://www.lightningdesignsystem.com/icons/#standardto be displayed for the node in the visualization.
  9. Record Icon Background Color : You can set the color of the icon using developer tools or by specifying a color code from an external source.
  10. Show Objects: This configuration setting allows you to select the set of objects that will be displayed as children of the node in the visualization. Note that the “Show Objects” setting at the node level will override the corresponding view level setting.
  11. Filter Records: You can configure filters to limit which children records are visualized under this parent node.
  12. Group Records: You can configure to group children records as sub-nodes under this parent node. This allows you to organize and visualize related records together in the hierarchy.
  13. Sort Records By: When a node contains Salesforce records as children, you can configure how they should be sorted.

Configuration for Junction Object

  1. Account Contact Relationship is a junction object. It can be enabled in Account Settings.
  2. Just below the junction object is the id which represents the Account Contact Relation i.e., junction object.
  3. Cascade Auto Expand: This setting allows you to automatically expand the child nodes of a node. This is particularly useful for visualizing junction objects.
  4. Display Record Node: This setting allows you to hide the record node of a junction object in the visualization. This is useful when you want to hide the record IDs or any other information associated with a junction object.

Below images show the use of the Cascade Auto Expand and Display Record Node.

In the below example Person Accounts are enabled, allowing users to relate a contact to multiple accounts (which is AccountContactRelation Junction object).

When “Display Record Node” is set to false, the record id node is hidden. Relation of Test Account ABC to another contact named Test Contact XYZ can be seen without the intermediate junction object record.

Change icons in record url from Lightning Design System

  1. Go to the official website of lightning design system  > Icons > Standard & Custom or click the below link https://www.lightningdesignsystem.com/icons/
  2. Select the name of :
    1. Standard Icons and paste it in the url as /img/icon/t4v35/standard/your_standard_icon_name.svg
    2. For custom icons grab it from the same site in the Custom icons section and paste it in the link as /img/icon/t4v35/custom/your_custom_icon_name.svg

Set the record icon background color

  1. Use color picker or the standard Inspect element to pick the color code and change it as follows :
    1. Right click and select Inspect to open the inspect element or the developer tools or press F12.
    2. Use the color picker option given in the dev tools to pick the color.
    3. Click on any color you like and it will be copied to clipboard as a hex color.
  2. Paste the color picked into the record icon background color field and hit save to apply that color to the icon.

Sort Records

Sort the child records based on different fields of the object. Also filter and group records. See example below where sorting, grouping and filtering are applied to Opportunity object records.

  1. Select the object that needs to be configured for sorting.
  2. Auto Expand: If enabled, the parent node is auto expanded.
  3. Show Objects: To show the relation of opportunities of another object.
  4. Filter Records: Filter to show opportunities whose Probability is Greater or Equal to 10%. Multiple filter conditions Can be used to filter the records.
  5. Group Records: Group the records by fields of opportunity and choose a different label for it too. More than one criteria can be used for grouping records.
  6. Sort Records By: Sort the records by fields of opportunity.

Miscellaneous Features

Restricting the display of view selector

In some situations, the administrator would like to define a view and restrict all the users to that view. To do this, the administrator will configure the view name in the “Use Configuration” component attribute in the page builder. If the “Use Configuration” attribute is set, the view selector is hidden from the users. This is overridden when View Configuration has a pinned view.

Configuring views that a user can select

In some situations, the administrator wants to give the users a few view options to select from. To do this, the administrator will build multiple views. For each of these views to be shared with the users, the administrator will set “Sharing Setting” to “All users can see”.

Configuring a default view for the users

The administrator can pin a view by checking the “Pinned” attribute to make the view as a default view for every user. This is similar to pinning Salesforce list views. Note that a user who can create her view can also pin a view to make it default selected for her.

Controlling if the users can create their own views

In some cases, the administrator would like to allow the users to create their own views. To do this, the administrator will check the page attribute “Allow Users to Update View Configuration” in the page builder. If that is checked, users will be able to create their own views and also share with other users.

Have Questions?

For any questions related to RelationshipVista and how to configure to visualize your Salesforce records’ relationships & hierarchies feel free to Contact us @ support@ardira.com