Understanding the XRL Interface Release 3a
Gain insight into how the HyperGrid XRL Interface works, and how to make the most of it.
XRL
HyperGrid Extended Related Lists (or XRL) allows Salesforce Users to define and optimize the Related List views as required by the user.
Although the HyperGrid XRL interface is straightforward to use, you should be aware of a few less obvious navigational options. The layout is divided into the following parts:
- Name of the XRL: The name of the XRL which is currently displayed in the Related List view. Such as Cases XRL for a Test_account.
- Summary of Records: Total no. of records in the active Related List view.
- Grid: Consists of records in XRL and column-level actions such as Column-filter, Sort, and Editing
- Global Actions: Default and Custom actions in the Related List view.
Therefore, the quicker you can find the information you're looking for or want to update, the more efficiently you can navigate the system.
Prerequisites
Make sure that you log in to your Salesforce account, install, and configure HyperGrid XRL. Refer to the links below for more detailed instructions.
Once you have configured the HyperGrid XRL, let us understand how to navigate the HyperGrid XRL interface.
Related Tab
TEXT/ ICON/LINK | TASK |
This part displays the Record type and name that user is currently viewing | |
Name of the Related object/Related List for any parent record. For eg- Cases is a Related object for Account. | |
This is Global Search functionality that allows you to search for a particular keyword or text and it will result in the records having the columns with that keyword/text. For those columns which have been configured but hidden from the view are also searched using Global search feature. | |
This dropdown shows the name of the Related List view of an XRL currently visible on the page. It also allows you to switch among multiple XRL views by selecting a specific Related List view name from the dropdown list | |
This icon - 9 dots - dropdown is Action Menu in HyperGrid XRL which consists of multiple default and user-defined actions that you can use to view, manipulate or download the data. These are typically the actions that you can view in the default configuration of XRL. | |
The reset filter button is used to reset any active client-side applied filter or filters on the columns. Learn more. | |
This button is used to delete the selected records from the database. This button is visible only to the users with “XRL_admin” permission sets or Power Users by default and only when t least one of the record is selected. To customize the any action in XRL view, go through the “Customize Action” article |
|
The download button is used to export ad-hoc Related List views into native Excel. It exports the filtered records in excel format. If there are certain records selected in the Grid view, only those records will get downloaded to Excel. | |
This button is used to add a new record of the Related object in the database. | |
This button is used to do server-side refresh of the XRL view, if any changes have been made to it, such as adding/editing/deleting records. Since only the current list view is updated rather than the entire page, this updates the data faster. | |
Click on this button to request a new feature/functionality or enhance existing ones in XRL. The request will be added to our feature request portal. To learn more about this feature, click here. | |
Click on this button to view the XRL view in full-screen mode without switching to a new tab or screen. | |
|
Click on the gear icon to Configure or customize HyperGrid XRL. Clcik on Help to access the help documentation from your SF org directly. |
The Grid Interface |
This Grid is the list of records with configured columns in the XRL view. At the top left of the Grid, you can see the total no. of records available in configured XRL. Click on a particular record to view more details about it. Select the checkboxes for one or more records to perform bulk actions such as edit/delete records |
Pagination for fast browsing |
Pagination is a very important feature in HyperGrid XRL. You can view up to 200 records at a time by clicking on the numbered drop-down. Click on the right arrow to go to the next page. Click on the previous arrow to go to the previous page. Access thousands of records in fast and efficient manner without infinite scrolling |
Filter Columns |
Click on the filter icon next to a column name to filter the records Select the required filter criteria such as Contains, Is Equal, or Not Is Equal,a an etc. Select the appropriate value: Choose from the picklist, enter the keyword, or select the date depending on the column data type. |
Sort Column records
|
To sort by a field column, click the header for that column. An arrow appears to indicate how the list is sorted: from the column's first record (Up Sort icon) (alphanumerically) or its last record (Down Sort icon) (Down Sort icon). |
Configuration Wizard Overview
The Configuration Wizard within HyperGrid is your key to tailor the Extended Related List (XRL) view to suit your unique needs. It empowers you - the HyperGrid users to unleash the full potential of Related List through user-defined, scalable and flexible user-defined Related List views (XRL views) by customizing it in a variety of ways.
A broad overview of functionalities enabled through configuration wizard are as follows:
Field Selection
The Field selection tab allows you to configure, re-configure fields, server-side filters, column sequence and sort order of columns. It also allows you to configure the reference or the lookup fields in XRL view. Click here for detailed article on configuration.
1. Configure: Configure tab in Field selection lets you choose what to display in your XRL view, You have the option to configure fields (including lookup fields) under Available Fields on left hand side. All the chosen fields are displayed on right side under Selected fields.
To configure lookup fields, click on > sign adjacent to field name. You can select upto 5 level of lookups.
You can configure upto 20 fields in a single view, change sequence of columns through drag and drop and delete any previously configured or wrong selection by using delete icon next to selected field name.
You can create new views or apply these changes to existing view through Save As/ Save button.
2. Apply Conditions:
You can utilize Apply conditions tab to configure server-side filters or remove or edit existing filters to scale up or scale down the data in the Grid. You can also control the logical relationship among multiple filters using AND/OR Logic. You can apply filters to look up fields, upto 5 level of lookups.
3. Apply Ordering:
You can select a default sorting order for records based on any field in Apply Ordering Tab.
Field Settings
Field Settings is a collection of various functionalities through which you get to control the columns appearance and actions in XRL. Power users in XRL control this setting. For standard users in XRL to be able modify view as per the settings, they need to share the view with Power users. The various important functionalities in Field Settings are as:
1. Field Label: This input is used to label the name of the field as it will appear in the Grid. For example, You can label the Case Origin as Case Origin or Origin itself.
2. Hiding this Colum: Hiding column allows you to hide any configured column from the active Related List view.
3. Is column Filterable: This checkbox allows you to enable or disable column filter functionality in the Grid. By default, the column-filters are available on the Grid for every field. Using column filters allows you to filter the important data based on certain criteria in real-time and helps in finding right data quickly, especially in conjunction with server-side filters and global search.
4. Is column Sortable: This allows you to enable/disable the real-time sort in individual columns to arrange and view records in a particular order. Sorting for columns is enabled in the Grid by default.
5. Is column Editable: With this functionality, you can enable inline editing for that particular column. This option appears only when a field is editable. For instance a system generated field such as Case Id is not an editable field so for Case Id, this check box will not appear under “Field Settings”. By default, this functionality is not enabled in the Grid.
6. Wrap Column Content: This setting allows you to decide whether you want to see the full text of individual column or clipped text. Accordingly text will be displayed in cells of corresponding column.
7. Width: This setting allows you to fix a specific width for desired column.
Table Settings
1. Enable Numeration: You can enable numeration on the Grid view, which can be useful for tracking and managing records.
2. Enable Checkboxes: This function allows checkboxes to enable manipulation/editing of data through inline/bulk/standard edit or delete etc.
3. Enable Global Search: You can enable global search on the Related list view, which allows you to search for data across all the records with an input string.
4. Enable Pagination: With top and bottom pagination, you get to browse thousands of records in a quick and efficient way, controlling number of clicks and endless scrolling to navigate through data.
5. Enabling column header text wrap: You can enable column header text wrap on the Related List view, which prevents long column headers from being truncated.
6. Enabling standard edit: This functionality allows you to edit any record in similar fashion as standard salesforce edit functionality. Thus, allows you to modify all the fields of a single record in a go. Please note that Standard Edit only works when initially the inline edit is enabled for at least one column in the Related List view.
7. Setting the chunk size for save and delete actions: Users can set the chunk size for save and delete actions, which controls the number of records that are processed at a time.
8. Setting the list size to display options: Users can set the list size to display options, which controls the number of options that are displayed in the list view.
9. Grouping of Records: By enabling this functionality, you are able to view the records grouped together on the basis of specified column.
Locked Fields