Grid Actions Library

Overview

The quick actions are a set of actions that can be performed by the end-user to configure the grid and manipulate the data displayed.

The quick actions can be configured using the component properties and the configuration wizard.

There are three different types of quick actions:

  • Configuration action: This action displays the configuration wizard which enables the configuration of the runtime behavior of the component.

  • Global action: These actions affect all records displayed in the data grid.

  • Record action: These actions only apply when records are selected in the data grid. Records are selected by using the checkboxes which are displayed on the left-hand side column of the data grid.

The quick action icons are visible at the top of the grid in the toolbar 👇

Grid* Toolbar

Label

Description

Type

Select Filter

Enables the user to create a new filter or apply an existing filter to the data displayed.

Global

Pin/Unpin Filter

Enables the user to pin or unpin the selected filter.

Global

Edit Filter

Enables the user to edit the selected filter.

Global

Clone Filter

Enables the user to clone the selected filter.

Global

Search Input

Enable the user to search for a specific word in the grid.

Global

Reload Items

Reload the entire grid

Global

Load more Items

Loads more items based on page size defined on the grid.

Global

Freeze Columns

Enables the user to define a set number of columns to freeze.

Global

Export Items

Enables the data displayed in the grid to be exported to an Excel or CSV file.

Global

Edit items

Enables inline editing of the data displayed.

Global

Create Record

Enables the user to add a new record.

Global

Clone Items

Clones selected records.

Record

Delete Items

Enables a record to be deleted.

Record

Actions

Dropdown list enabling access to the GridMate provided and also user-created custom actions.

Record

Create a filter

To create a new filter.

  1. Click on the drop-down Select Filter and select New

  2. The Filter Wizard screen is displayed.

  3. To create a filter to show only the cases which have been closed. In Select Filter Fields highlight the Status field from the available list and click on the right arrow to move it to the selected list.

  4. In Define Filter Values select Equal and Closed.

  5. In Filter Configuration provide a name for the newly created filter. By default, the junction is ‘AND’ between all the selected fields. Update the filter conditions using ‘OR’/’AND’ if necessary in the Filter Value field.

  6. Select if you wish to make the filter global and then click Save.

  7. When the filter is saved successfully, a confirmation dialog will be displayed.

  8. Reload the lightning page for the changes to be effective.

  9. To use the new filter, reload the lightning page and select the filter list drop-down. The new filter name is displayed.

  10. Click the filter name and the data grid will refresh to show the now filtered data.

If selecting to make a filter global, the filter will be available across all lightning pages.

Edit a filter

To edit an existing filter.

  1. Select the filter name from the drop-down list of filters and click on the Edit Filter button.

  2. The Filter Wizard is presented with the existing filter fields visible.

  3. To edit the filter, adjust the filter fields or filter values as required, and click Save. The updates to the filter will be saved.

Clone a filter

To clone an existing filter.

  1. Select the filter name from the drop-down list of filters and click on the Clone Filter button.

  2. The Filter Wizard is presented with the existing filter fields visible.

  3. To edit the filter, adjust the filter fields or filter values as required, update the name and click Save. The cloned filter will be saved as a new record.

Delete a filter

To delete an existing filter.

  1. Select the filter name from the drop-down list of filters and click on the Edit Filter icon.

  2. The Filter Wizard is displayed with the existing filter fields visible.

  3. To delete the filter, click Delete, a confirmation dialog will be displayed.

  4. Click OK to confirm to delete the filter, the filter is deleted.

Pin/Unpin a filter

To pin/unpin an existing filter.

  1. Select the filter name from the drop-down list of filters

  2. Click on the Pin/Unpin icon.

When a filter is pinned, it gets applied each time the grid is loaded. Pinned filters are defined per grid and managed by the end users not by the admin

Freeze Columns

To set the number of columns to freeze in the displayed data grid.

  1. Click on the Freeze columns icon.

  2. The Freeze Column dialog is displayed.

  3. Enter the number of columns to freeze.

  4. Click Save.

Columns will be frozen starting from the left-hand side.

Export Items

Export the displayed data to an Excel or CSV file. All eligible records are exported not only the displayed ones. GridMate can export till 5K records!

  1. Click on the Export icon.

  2. This will open a dialog allowing the user to select the format and the name of the generated file.

  3. Click Export to download the data.

Edit Items

The Edit Items function allows the end-user to perform inline editing of the data displayed on the data grid.

  1. Click on the Edit Items icon.

  2. The GridMate data grid will enter edit mode and the user will be able to directly edit the data fields displayed.

  3. As the data fields are edited the border of each displayed data field will be highlighted to show it has changed.

  4. To save the updates made to the data click Save, to cancel the updates click Cancel. If the updates are saved a confirmation dialog is displayed.

All changes that are made during the inline editing are handled like a transaction. There are no changes that are saved into the server including record creation and deletion. When a grid is saved, all the changes are applied:

  • Create brand new objects

  • Update the edited objects

  • Delete records marked for deletion

The page is not refreshed when an inline grid is saved. Only the saved grid is reloaded to keep the master grid state the same.

All types of fields are supported except compound fields like addresses. Also, we provide a nice UI component for Multi PickList, Long Text, and Rich Text fields.

🚀To enhance the performance and the search relevance, we use SOSL instead of SOQL for lookup fields.

🚀During the inline editing, the end-user can add multiple records at a time. Put the number of the records to add, and hit Create New Record.

☝️GridMate handles well dependant picklist fields. The dependent fields should be displayed on the grid.

☝️We support lookup filters for lookup fields and recent items as well. When a lookup field gets the focus, the recent records list is displayed if the user doesn’t enter a search term.

☝️Vertical navigation is available during the inline editing. You can go from up or down using the keyboard shortcuts below:

Windows

Linux

  • Down : ALT + k

  • Up: ALT + SHIFT + k

  • Down : CTRL + k

  • Up: CTRL + SHIFT + k

☝️Multi copy paste is available during the inline editing. You can copy paste multiple values on the same column at one time. Almost all the data types are supported including lookup fields. This feature is a must for data capture from Excel files for instance. For lookup fields, GridMate will fetch the id(s) based on the lookup record name.

Create Record

The Create Record function allows the end-user to create a new record.

Note: When this function is available from the toolbar, please ensure the GridMate component property “Default Values” is set to include the required fields for the object.

  1. Click on the Create Record icon.

  2. The New Record dialog is displayed, with the default values presented.

  3. Enter the new record data.

When Submit is clicked the component creates a new record, populates it with the default values, stores it on the Salesforce back end, and displays it to the user. When the new record has been created, a confirmation dialog is presented.

Clone Items

The Clone Items function enables the cloning of records from the data grid.

  1. From the displayed data grid, select at least one record to clone.

  2. Click on the Clone Items icon.

  3. The Clone selected items dialog is displayed.

  4. Click Yes to proceed with the cloning of the selected records

  5. When the records have been cloned, a confirmation dialog is displayed.

  6. The cloned records are visible on the data grid.

Mass Update

The Mass Update function enables the mass update of records from the data grid.

  1. From the displayed data grid, select at least one record to mass update.

  2. Click on the Mass Update icon.

  3. The Mass Update dialog is displayed.

  4. Select the appropriate fields to update and set the new value for each field

  5. Click Yes to proceed with the update of the selected records.

When the records have been updated, a confirmation dialog is displayed.

Delete Items

The Delete Items function enables the removal of records from the data grid.

  1. From the displayed data grid, select the records to delete.

  2. Click on the Delete Items icon.

  3. The Delete selected items dialog is displayed.

  4. Click Yes to proceed with the deletion of the selected records.

When the records have been deleted, a confirmation dialog is presented.

Custom Actions

The Actions function enables access to custom quick actions associated with the object to be called and applied to the selected records.

  1. From the displayed data grid, select at least one record.

  2. Click on the Actions icon.

  3. The list of available actions is displayed.

  4. Select the appropriate action as required, for example Update Account. The user defined action will be presented using the same layout of the quick action.

  5. Click Submit to apply the quick action.

Custom action configuration

[
{
"name": "Case.gmpkg__Esclate",
"label": "Esclate",
"icon": "utility:close",
"attributes": {
"density": "comfy"
}
}
]
  • name: the API name of the action.

  • label: the label of the the action.

  • icon: the SLDS icon of the action. Only utility family is supported.

  • attributes: Extra attributes to control the action. Only density is supported as of today. The density is used to override the density of the layout ("auto", "compact", "comfy").

Mass Email action

GridMate also provides a default custom action called Mass Email. This action can be added to the Actions menu and made available to the end-user. When the Mass Email action is selected the following dialog is displayed. The user can select from the options presented and click the Send button to send the email.

Mass Email action

Mass Email action can be configured to preset attributes like Recipient and template to use. You can leverage this feature to configure predefined email actions. The action below is an example to send a case response to the contact.

{
"label": "Send Case Response",
"name": "SendCaseResponse",
"component": "gmpkg:DataGridSendEmailComponent",
"attributes": {
"recipient": "ContactId",
"templateName": "SupportCaseResponse"}
}

Create Contact Role

GridMate provides a default custom action to create contact roles from Contact Roles grid. This action can be added to the Actions menu and made available to the end-user. When the Create Contact Role action is selected the following dialog is displayed. The user can select from the contact, assign the right role, and click the Save button to save the record.

Create Contact Role action

Submit for Approval

  1. From the displayed data grid, select at least one record to submit.

  2. Click on the Submit for Approval action.

  3. The submission dialog is displayed.

  4. Add your comment and click Submit to proceed with the selected records.

GridMate provides a default custom action to submit a list of records for approval. This action can be added to the Actions menu and made available to the end-user.

Action configuration

{
"label": "Submit for Approval",
"name": "SubmitForApproval",
"component": "gmpkg:DataGridSubmitForApprovalComponent"
}

Approve/Reject Records

GridMate provides a default custom action to approve or reject a list of records. This action can be added to the Actions menu and made available to the end-user. The decision of the approval is defined on the action itself.

  1. From the displayed data grid, select at least one record to process.

  2. Click on the Approve or Reject action.

  3. The approval dialog is displayed.

  4. Add your comment and click Approve or Reject to proceed with the selected records.

Approve action configuration

{
"label": "Approve Contacts",
"name": "Approve",
"component": "gmpkg:DataGridSetApprovalComponent",
"attributes": {
"approvalStatus": "Approve"
}
}

Reject action configuration

{
"label": "Reject Contacts",
"name": "Reject",
"component": "gmpkg:DataGridSetApprovalComponent",
"attributes": {
"approvalStatus": "Reject"
}
}

Call Flow

GridMate provides a default custom action to call a flow on the selected records. This action can be added to the Actions menu and made available to the end-user. The flow to trigger and its parameters mapping is defined on the action itself.

  1. From the displayed data grid, select at least one record to process.

  2. Click on the $FlowAction action.

  3. The flow dialog is displayed.

  4. Run your flow as usual.

  5. The grid is refreshed once the flow is executed

Record action configuration

{
"label": "Mass Convert",
"name": "MassConvert",
"component": "gmpkg:DataGridCallFlowComponent",
"attributes": {
"flowName": "GM_Mass_Lead_Convert",
"idListParam": "idList",
"itemListParam": "itemList"
"autolaunched": false
}
}

The attributes property are used to define the mapping between the flow parameters and the grid properties:

  • recordIdParam: the id of the current record

  • idListParam: the list of selected id(s)

  • itemListParam: the list of selected items

  • autolaunched: flag to indicate if the flow is an auto launched process. Auto-launched flows are run in the background and no screen is displayed to the end-user.

At runtime, GridMate will instantiate the flow, populate its attributes based on the mapping, and display it to the end-user.

Global action configuration

{
"label": "New Task",
"name": "newTask",
"component": "gmpkg:DataGridCallFlowComponent",
"global": true,
"attributes": {
"flowName": "GM_CreateTask",
"recordIdParam": "accountId",
"autolaunched": false
}
}

Mass Convert Lead

GridMate provides a flow to mass convert à list of leads. This flow is available in GridMate extensions.

  1. From the displayed data grid, select at least one record to convert.

  2. Click on the Mass Convert action.

  3. Complete the lead conversion properties (Account/Contact/Opportunity creation, Record Owner).

  4. Submit the flow to convert all the selected leads

Action configuration

{
"label": "Mass Convert",
"name": "MassConvert",
"component": "gmpkg:DataGridCallFlowComponent",
"attributes": {
"flowName": "GM_Mass_Lead_Convert",
"idListParam": "idList",
"itemListParam": "itemList"
}
}