Grid Configuration

Overview

The GridMate grids can be configured to display Related Lists, FieldSet Lists and List Views in a structured data grid format. This configuration is performed through the setting of the component properties.

Quick Configuration

The steps outlined below highlight how to perform a quick configuration of the GridMate component GM - FieldSet Grid by showing how to add it to a lightning page and viewing its results.

  1. From Setup, select Edit Page in the Lightning App Builder.

  2. From the Custom - Managed components list, drag and drop the component.

  3. The grid component is now ready for configuration in the Lightning App Builder.

  4. The property values can be configured to tailor the data grid to the needs of the end-user and display the required data.

  5. To perform a quick configuration, populate required property values: Related Object Name, FieldSet Name

Click Save to save the page. The grid component will be automatically refreshed within the App Builder to display the results of the updates, and the contents of the Field Set.

Advanced configuration

The following section outlines how to use the grid configuration wizard to populate the property values of the components.

The grid configuration wizard comprises a series of tabs that are presented to the user. Each configuration wizard tab has a corresponding grid component property.

The component property values produced by the configuration wizard can be used to populate the corresponding properties.

These values can be populated when the lightning page on which the grid component appears is being edited in the Lightning App Builder.

We suggest opening the same page in the edit mode in a second tab and jump between the two tabs.

Before you begin:

  • The configuration wizard is not available when the lightning page is being edited in the Lightning App Builder.

  • The configuration wizard is a runtime component. It’s available only to run from the component quick actions and when the logged user is a GridMate administrator. A GridMate administrator is Salesforce admin or a user with GridMate Admin PermissionSet. This PermissionSet is managed by GridMate package.

Custom Icon property

To configure the Custom Icon property.

  1. Launch the Configuration Wizard by clicking on the Configure icon.

  2. Select the Custom Icon tab.

  3. Select the icon required from the list displayed and scroll to the bottom of the Custom Icon tab.

  4. The string contained in the Custom Icon text box can be used to populate the Custom Icon property value of the GridMate component.

Filter property

To configure the Filter property.

  1. Launch the Configuration Wizard and select the Filter tab.

  2. Step 1 - Select Filter Fields. From the Available list select the fields which are to be added to the filter, for example, Priority and move them to the Selected list.

  3. Step 2 - Define Filter Values. Define the filter values by selecting from the options presented, for example, Priority Equals High

  4. Step 3 - Filter Configuration

The Filter Configuration dialog displays the Filter text as a JSON string.

Sort/Order property

To configure the Sort/Order properties.

  1. Launch the Configuration Wizard and select the Sort/Order tab.

  2. Step 1 - Select Sort Fields. From the Available list select the fields which are to be used to sort the data, for example, Priority and move them to the Selected list. Note: Multiple fields can be selected for the sort.

  3. Step 2 - Select Sort Order. Define the sort order by selecting from the options presented, for example, Ascending

  4. Step 3 - Sort Configuration

The Sort Configuration dialog displays the Sort and Order text.

These values can be used to populate the Sort and Order property values of the GridMate component.

Aggregate property

To configure the Aggregate property.

  1. Launch the Configuration Wizard and select the Aggregate tab.

  2. Step 1 - Select Aggregation Fields. From the Available list select the field to be aggregated, for example, Employees and move it to the Selected list. Only numeric fields are relevant for aggregations.

  3. Step 2 - Define Aggregate Operations. Define the aggregate operations by selecting from the options presented, for example, Sum

  4. Step 3 - Aggregate Configuration

The Aggregate Configuration dialog displays the Aggregate text.

This value can be used to populate the Aggregate property value of the GridMate component.

Default Values property

To configure the Default Values property.

  1. Launch the Configuration Wizard and select the Default Values tab.

  2. Step 1 - Select Default Fields. From the Available list select the fields to be set with default values, for example, Account Description, Account Name, Account Type, and move them to the Selected list.

  3. Step 2 - Define Default Values. Define the default values by selecting from the options presented.

  4. Step 3 - Default Values Configuration

The Default Values Configuration dialog displays the Default Values text.

This value can be used to populate the Default Values property value of the GridMate component.

The Default Values are used to initialize a record when the user tries to create a new record.

The fields selected for the default values configuration should contain at least all the required fields for the related object.

Actions property

To configure the Actions property.

This property can be used to make custom actions available for use on the GridMate component.

  1. Launch the Configuration Wizard and select the Actions tab.

  2. Step 1 - Select Mass Actions. From the Available list, select the Actions to be made available from the GridMate component, and move them to the Selected list.

  3. Step 2 - Actions Configuration

The Actions Configuration dialog displays the Actions text. This value can be used to populate the Actions property value of the GridMate component.

The actions listed in the available column depend on the quick actions configured as part of the related Salesforce object.

Search property

To configure the Search properties.

  1. Launch the Configuration Wizard and select the Search tab.

  2. Step 1 - Select Search Fields. From the Available list select the fields which are to be used to sort the data, for example, Priority and move them to the Selected list. Note: Multiple fields can be selected for the search and only text fields (Text, PickList, Phone, Email, URL) are supported.

  3. Step 2 - Search Configuration

The Search Configuration dialog displays the Search

The value can be used to populate the Search property value of the GridMate component.

ReadOnly Fields property

To configure the ReadOnly Fields properties.

  1. Launch the Configuration Wizard and select the ReadOnly Fields tab.

  2. Step 1 - Select ReadOnly Fields. From the Available list select the fields which are to be used to sort the data, for example, Priority and move them to the Selected list.

  3. Step 2 - ReadOnly Configuration

The ReadOnly Configuration dialog displays the ReadOnly Fields

The value can be used to populate the ReadOnly Fields property value of the GridMate component.

Hidden Fields property

To configure the Hidden Fields properties.

  1. Launch the Configuration Wizard and select the Hidden Fields tab.

  2. Step 1 - Select Hidden Fields. From the Available list select the fields which are to be used to sort the data, for example, Priority and move them to the Selected list.

  3. Step 2 - Hidden Fields Configuration

The Hidden Fields Configuration dialog displays the Hidden Fields

The value can be used to populate the Hidden Fields property value of the GridMate component.

Custom Labels property

To configure the Custom Labels property.

  1. Launch the Configuration Wizard and select the Custom Labels tab.

  2. Step 1 - Select Fields. From the Available list select the field to be renamed.

  3. Step 2 - Define Labels. Define the label for each selected field.

  4. Step 3 - Custom Labels Configuration

The Custom Labels Configuration dialog displays the Custom Labels text.

This value can be used to populate the Custom Labels property value of the GridMate component.

Column style property

To configure the Column Style property.

  1. Launch the Configuration Wizard and select the Column Style tab.

  2. Step 1 - Select Fields. From the Available list select the field to be styled.

  3. Step 2 - Define Width. Define the width in pixels for each selected field.

  4. Step 3 - Style Configuration

The Style Configuration dialog displays the Column Style text.

This value can be used to populate the Column Style property value of the GridMate component.

Cell Coloring property

To configure the Cell Coloring property.

  1. Launch the Configuration Wizard and select the Cell Coloring tab.

  2. Step 1 – Coloring Setup

  3. Select the field to color and the color to apply

  4. Select the fields to check for the coloring

  5. Define the field values to check

  6. Click Add Coloring to save the coloring

  7. Repeat this process for any field to color

  8. Step 2 – Coloring Configuration

The Coloring Configuration dialog displays the Cell Coloring text. This value can be used to populate the Cell Coloring property value of the GridMate component.

Export the configuration

For inline grids, we have to provide the child grids configuration as a JSON string. GridMate provides a utility action to export the configuration of a given grid. As an administrator, you can leverage the app builder to configure and fine-tune the targeted grid, then export it and use it as an inline grid. To export a configuration:

  1. Click on the Inline Config icon.

  2. The configuration is copied to the clipboard.

  3. Paste the configuration into Record Related Grids property.

As an example:

  1. Configure a related grid of Cases on the Contact page

  2. Export the configuration of this grid

  3. Paste it on a related grid of Contacts on the Account page