Comet Apps logo

Relatable View Builder

A “View” is our term for a custom list configured using Relatable. Manage all Views from the View Builder. Create new, edit existing and delete all from this page. Use the dropdown to filter all views by parent object.

Create A New View

From the View Builder page, click new to launch the View properties panel. From here you can edit all of the View’s properties. Once the required properties are populated (see below), click save to create a new View. You will be redirected to the View. You can re-open the properties panel by clicking the pencil icon next to the View’s name. 

View Properties

  • View Name: Required property. This is the name users see. View Name can be edited after a View is created
  • Parent Object: Optional property. Select a parent object to build a related list, leave blank to build a list view. The parent object dictates the list of related objects that are available in the View. e.g if you select the Account object, only objects that have a lookup relationship to Account are available. You can select from standard or custom objects. Each View can use a different parent, you can create multiple Views using the same parent. Note: The parent object cannot be changed once a View has been created 
  • Active: Optional checkbox. When active, a View becomes available to users in the lightning component. The component only shows active Views where the parent object matches that of the lightning record page. I.e  an Account lightning page with the component placed on it, will only show Views where the parent object is Account. You can toggle the active status at any time 
  • Allow Inline Editing: Optional checkbox. When active, enables users to perform inline editing for that View, disabled when inactive. Editing is subject to Salesforce permissions
  • Show New Record Button: Optional checkbox. When active, enables users to create new records from the View, disabled when inactive. Creating new records is subject to Salesforce permissions
  • Show Attachments: Optional checkbox. When active, enables users to see and upload attachments to rows, disabled when inactive.  Viewing and creating attachments is subject to Salesforce permissions
  • Show Record Actions: Optional checkbox, When active, enables users to see edit and delete actions per row, disabled when inactive. Editing and deleting is subject to Salesforce permissions
  • Allow CSV Export: Optional checkbox. When active, enables users to export the current rows as a CSV file. Export is subject to Salesforce permissions 

Add Objects as Rows

Click Add Object to see a dropdown of available objects you can add to the View. The drop down will show all available* objects in your org. If you have specified a parent object, the dropdown will only show objects that look-up to the parent (via master-detail or lookup relationship). e.g From a View with Account as the parent object, you can select Opportunities. This means for any given account, you will see any related Opportunities of that Account as rows in the View. The list contains the related objects name and the relationship name between it and the parent. Depending on how your org has been configured, you may see the same object appear twice in the dropdown, these are differentiated by relationship name. The format is as follows: Object Name (Relationship Name). Note: Maximum of 10 related objects (as rows and child rows) per View. 

* certain objects will not be visible i.e history tracking

Add Child Rows

Once an object has been added as a row, click Add Child Rows against that row to see a dropdown of available child objects. Multiple child rows can be added for each object. E.g Add Opportunity as a row, then add Opportunity Products (OpportunityLineItem) as a child row. When configured child rows appear nested below the parent record. You can include child, grandchild and great grandchild objects as child rows.

Add Columns

Click the Add Column button to open the column configuration panel. 

Column Properties:

Column Label

Required property. This is the name users see. Column labels can be edited after a View is created.

Data Type

Required dropdown. Controls field mapping and formatting options. E.g if you select the Checkbox data type for your column, only fields where the data type is checkbox will be available in the mapping dropdown. A breakdown of each data type below: 

  • Object Name - Relatable includes object icons by default, however sometimes it might not be clear what object the icon represents. This data type returns the selected object's name. No manual field mapping is required.
  • Record Name - For showing a records name/number as a hyperlink. Users can navigate to the record by clicking on the link
  • Text - For showing any standard text, long area, picklist or multi-select picklist fields Note: We do not currently support rich text fields
  • Number - For showing any number or currency fields, any iso code or currency symbol is removed. Select number of decimal places to show
  • Currency - For showing any currency fields, includes iso code or currency symbol. Select number of decimal places to show
  • Date - For showing any date or date/time fields in a date format
  • Time - For showing any time fields in a time format
  • Datetime - For showing datetime fields in a date time format. Select date and time formatting 
  • Percent - For showing any percentage fields. Select decimal places to show
  • Checkbox - For showing any checkbox fields
  • Lookup -  For showing a related records name/number i.e  Owner name 

Note: Once a column has been created, the data type cannot be changed. If you would like to explore this concept further, Our Use Cases provide step by step guides to creating a View from scratch focused on a specific scenario. 

Add Formula Column

Formulas are a unique data type, instead of mapping a field from each object, we select one of our existing columns to reference. Relatable calculates the cumulative total of that column for each row in the View.  The calculator is dependent on how the View is sorted. Click Add Column, and select the ‘formula’ data type, select ‘Rolling Total’ as the formula type, then from the Column dropdown, select the column you want to reference. Rolling Total formulas only work with number or currency columns. Select to show the results ascending or descending. 

Field Mapping

Once you have a minimum of one object and one data column defined, you can start mapping object fields to data columns. Click in the cell to open the dropdown and select a field from the list available. Available fields are defined by the data type of the column selected. If you do not see a field in the list, it’s likely as a result of data type incompatibility. Eg. We currently do not let you map a currency field to a checkbox column, this is to allow your rows to be sorted by column. 

Add Text Styling

You can apply text formatting and text alignment to each column. Click settings in a column header to open the properties panel. Click the Text Style tab and select your preferences. 

Object Filters

Add filters to your object rows to only show records that match certain criteria. Click the setting icon against an object, on the Filters tab select a field, the operator and enter the filter value. Click Add Filter to add an additional filter, click the bin icon to remove. You can add up to 10 filters per row object. Note: AND logic is applied when applying more than one filter criteria. Custom filter criteria is coming soon, see our roadmap for further details. 

Conditional Formatting Rules

There are two ways to apply Conditional Formatting rules, either at row or column level. Row level lets you set object specific rules, and highlights an entire row, column level is a cross object rule that highlights cells in a specific column. Note: Column rules override row rules. 

Add Row Conditional Formatting Rule

Click the ⚙️ icon next to an object to open the object settings panel. Click the Conditional Formatting tab. Select a field from the dropdown, select an operator and enter the criteria. Apply the rule to either the cell background or the text and select a colour. Click Add Condition to add an additional rule, click the bin icon to remove. You can add up to 10 rules per row object. 

Add Column Conditional Formatting Rule

Click the ⚙️ icon in a column header. Click the Conditional Formatting tab. Unlike the row level rule, column rules evaluate based on each object's field mapping. Select the operator and enter the criteria. Apply the rule to either the cell background or the text and select a colour. Click Add Condition to add an additional rule, click the bin icon to remove. You can add up to 10 rules per row object. 

Column Ordering

Drag and drop columns to reorder them, the column position controls the order they appear when viewing on a lightning record page. 

Set Default Sorted By Column

Click the sort icon to set a column as the default. When the Relatable component is first loaded or refreshed, the View will sort by the selected column. If a text column has any multi select or long area fields mapped to it, it cannot be sorted and you will not see the icon. You can choose to sort ascending or descending, click the sort icon again to change your preference. If no column is selected, the first available column will be selected as the default. 

Preview Mode

You can test out your View before activating it using the Preview function. Find a record you want to preview. Paste the Salesforce Id of that record into the preview box and click the eye icon to preview. Note: the Id must be of the same type as the parent object of the View. Certain features are disabled in preview mode

Clone View

Click the Clone button to create a copy of one of your Views.