How to Customize Action Settings in XRL -Release3b
Learn how to apply personalized settings to enhance your experience in XRL.
Introduction
The Salesforce Hypergrid Extended Related List Actions tab allows you to perform various actions on the records displayed in the related list. Some of the actions that can be performed include creating a new record, editing an existing record, deleting a record, mass editing records, and exporting data to a CSV file. The actions available may vary depending on your user permissions and the configuration of the related list.
Limitations in Salesforce Related List
The Salesforce Related Lists offer very limited actions for regular users. They can only create a new record, edit and delete a single record and filter the configured columns. From the users' perspective, there are no options to define or view the custom action. Moreover, defining a custom action is a specialized process that requires extensive coding knowledge and is limited to only certain users in Salesforce who are granted “Customize Application” permission sets.
Customizing Actions Button
The Actions tab in Salesforce HyperGrid XRL provides users with several actions to manage the data displayed in the related lists. By default, there are the following actions that all XRL users can access:
- Reset filters: Allows users to clear all client-side filters applied to the list and show all related records in the Related object.
- Export: Enables users to download the related records as a native Excel file, which can be opened in a spreadsheet program locally. Export action works on the actively displayed Related List View. To download specific records, the user can either apply filters or select specific records through the checkbox.
- Delete: Allows users with appropriate permissions to delete selected related records. This action is visible only when a single or multiple records are selected.
- New: Allows users to create a new record for the Related item.
- Refresh: Allows users to reload the Related List with the latest data.
- Request a feature: Enables users to submit a new feature request to the Salesforce HyperGrid team via mail.
-
Expand view: Allows users to expand the Related List view, making it easier to check every column in each record very clearly.
Prerequisite XRL view is configured and a view is created on a record page. Refer to the articles below to know how XRL is added to the page view and how to create a Related List view in XRL.
|
Which type of user can customize actions in records?
The Power Users have the privilege to define and customize any action in the HyperGrid XRL.
We will work with Cases XRL to walk you through the steps to customize an action.
Step 1: Open the configuration wizard by clicking on the gear icon and selecting Configure option in the XRL view.
Step 2: On the Configuration Wizard, click on the Actions tab and select an Action from the drop-down menu.
Step 2: In the Select Action drop-down, we will select Reset Filters to understand more details about the particular action and how to customize it.
Id of the action
This refers to a unique identifier assigned to each action that is created. The system generates this identifier and it cannot be changed or modified manually. The purpose of this ID is to ensure that each action within the system has a distinct and identifiable reference point. This enables the system to accurately track and manage the actions that are created, ensuring that there are no conflicts or confusion between different actions. As a user, you don't need to worry about specifying an ID for the action because the system will assign a unique identifier to each action you create.
Label of the action
This is a default label that is automatically generated by the system and cannot be altered by the user. This label is used to identify the action within the user interface and cannot be changed to a custom label or wording.
Tip for the action
The option allows you to add a custom message or tip to an action in the related list. This message will appear as a tooltip when the user hovers over the action button in the related list. This can be useful for providing additional information or guidance to users about the action they are performing.
Hide this action
Select this checkbox to hide the action button from the grid. This hides the pre-configured default actions as well as custom actions created by user, thus user can't view/utilize this action in the active grid view.
Action visible only after record selection
This action will be visible only after selecting the record. For example, if you want to see the delete action in the grid view only when user selects at least one of the record through checkbox, enable this option. User will be able to see the delete action only after selecting a row. In the above Reset Filters button, let's activate this setting:
Variant
Variant refers to a style variant that can be applied to the related list's custom actions. The "variant" property lets you specify a style for these custom actions. You can easily customize the look and feel of your related list and ensure that the actions are distinguishable from one another by selecting a specific variant for each action.
Name of the icon to be shown
This refers to the specific icon that will be displayed on the grid. This icon can be chosen from a library of icons provided by Lightning Design System that can be found at “www.lightningdesignsystem.com/icons/”. By choosing a specific icon, users can add visual cues and distinguish between different types of related records.
Refresh Grid after Custom Action Execution
This option allows you to refresh the grid view automatically after a custom action is executed. This means that when you perform a custom action, the grid view will be updated with any changes made by the action without having to manually refresh the page. To enable this option, simply tick the "Refresh Grid after Custom Action Execution" checkbox. Once enabled, the grid view will automatically refresh after executing any custom actions.
Order of the action
This property specifies the order in which the actions appear in the Menu (9 dots) dropdown in XRL view. It is critical to use appropriate values when configuring this property, such as 10, 20, 30, and so on. This is due to the fact that using sequential values like these allows for greater flexibility, as new actions can be easily added between existing ones without disrupting the order of the entire list.
API name of the flow
The "API Name of the Flow" field is optional. This field is only used if you want to run a flow when the user clicks the action button. By entering the flow's API Name in this field, you can allow end users to execute that flow when they click the action button in the extended related list. This field is automatically selected to None by default and cannot be modified.
Advanced Section
This setting allows you to perform customization on actions such as callback, dynamic styling etc. Click here to learn more about specific JSON format to implement these settings.
Step 3: After customizing the action button as per the requirements, click on Save button and you will be able to see the changes reflected in the view as per the customizations done.
Results
The Salesforce Hypergrid Extended Related List (XRL) Actions tab empowers users to streamline workflows and optimize productivity by providing a comprehensive suite of customizable actions. This feature addresses the limitations of standard Salesforce related lists, allowing for greater flexibility and control over actions performed on related records.
In this article
- Introduction
- Limitations in Salesforce Related List
- Customizing Actions Button
- Id of the action
- Label of the action
- Tip for the action
- Hide this action
- Action visible only after record selection
- Variant
- Name of the icon to be shown
- Refresh Grid after Custom Action Execution
- Order of the action
- API name of the flow