Grid - Advanced Configuration
Last updated
Last updated
The Config. wizard is an admin tool to easily configure smart grids (GM - RelatedList Grid, GM - ListView Grid, GM - FieldSet Grid...).
With a set of tabs where each tab has a corresponding component property, the wizard produces the property value through a guided configuration process.
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 an admin or a user with GridMate Admin PermissionSet. This PermissionSet is managed by GridMate package.
To configure the Custom Icon property.
Launch the Configuration Wizard by clicking on the Configure icon.
Select the Custom Icon tab.
Select the icon required from the list displayed and scroll to the bottom of the Custom Icon tab.
The string contained in the Custom Icon text box can be used to populate the Custom Icon property value of the component.
To configure the Filter property.
Launch the Configuration Wizard and select the Filter tab.
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.
Step 2 - Define Filter Values. Define the filter values by selecting from the options presented, for example, Priority Equals High
Step 3 - Filter Configuration
The Filter Configuration dialog displays the Filter text as a JSON string.
For date/date time fields, the value could be custom date/date time or relative (TODAY, THIS_MONTH...). The config. wizard makes it easy to configure relative date filters.
To configure the Sort/Order properties.
Launch the Configuration Wizard and select the Sort/Order tab.
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.
Step 2 - Select Sort Order. Define the sort order by selecting from the options presented, for example, Ascending
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.
To configure the Aggregate property.
Launch the Configuration Wizard and select the Aggregate tab.
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.
Step 2 - Define Aggregate Operations. Define the aggregate operations by selecting from the options presented, for example, Sum
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.
To configure the Default Values property.
Launch the Configuration Wizard and select the Default Values tab.
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.
Step 2 - Define Default Values. Define the default values by selecting from the options presented.
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.
To configure the Actions property.
This property can be used to make custom actions available for use on the GridMate component.
Launch the Configuration Wizard and select the Actions tab.
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.
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.
To configure the Search properties.
Launch the Configuration Wizard and select the Search tab.
Step 1 - Select Search Fields. From the Available list select the fields which are searchable, 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.
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.
To configure the ReadOnly Fields properties.
Launch the Configuration Wizard and select the ReadOnly Fields tab.
Step 1 - Select ReadOnly Fields. From the Available list select the fields which should be readonly, for example, Priority and move them to the Selected list.
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.
To configure the Hidden Fields properties.
Launch the Configuration Wizard and select the Hidden Fields tab.
Step 1 - Select Hidden Fields. From the Available list select the fields to hide when creating a new record, for example Account, and move them to the Selected list.
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.
To configure the Custom Labels property.
Launch the Configuration Wizard and select the Custom Labels tab.
Step 1 - Select Fields. From the Available list select the field to be renamed.
Step 2 - Define Labels. Define the label for each selected field.
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.
To configure the Column Style property.
Launch the Configuration Wizard and select the Column Style tab.
Step 1 - Select Fields. From the Available list select the field to be styled.
Step 2 - Define Width. Define the width in pixels for each selected field.
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.
To configure the Cell Coloring property.
Launch the Configuration Wizard and select the Cell Coloring tab.
Step 1 – Coloring Setup
Select the field to color and the color to apply
Select the fields to check for the coloring
Define the field values to check
Click Add Coloring to save the coloring
Repeat this process for any field to color
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.
To configure the Group By properties.
Launch the Configuration Wizard and select the Group By tab.
Step 1 - Select Grouping Fields. From the Available list select the fields which are to be used to group the data, for example, Priority and move them to the Selected list.
Step 2 - Grouping Configuration
The Group By Configuration dialog displays the Group By Fields
The value can be used to populate the Group By property value of the GridMate component.
To configure the Kanban Stages property.
Launch the Configuration Wizard and select the Kanban Stages tab.
Step 1 – Stage Setup
Set the name of the stage
Select the fields to check for the stage
Define the field values to check
Click Add Stage to save the stage
Repeat this process for all the stages
Step 2 – Stage Configuration
The Stage Configuration dialog displays the Kanban Stages text. This value can be used to populate the Kanban Stages property value of the GridMate component.
To configure the Formulas property.
Launch the Configuration Wizard and select the Formulas tab
Step 1 – Formulas Setup
Set the name of the Formulas
Select the Data Type
Choose which fields to use when creating the formula.
Define the formula using the fields and functions from the explorer on the left side
Click Check Syntax for errors
Save the formula
Step 2 – Formulas Configuration