GM - Flow View Grid

(gmpkg:FlowViewGridComponent)

Documentation

GM - Flow View Grid component is used to view and select records from a data grid inside a flow.

Use case: Display a grid of contacts to add them as opportunity contact roles in a screen flow. See Flow Tutorial.

Specification

The following properties use JSON syntax as part of their configuration: Filter, Custom Field Labels, Cell Coloring.

Property	Type	Description
recordId	String	recordId to use. Keep this empty if you want to use the current record.
Related Object Name *	String	The name of the related object to display
FieldSet Name *	String	The Field Set name of the related object to display
Row Limit *	Integer	The maximum number of rows to fetch.
Page Size *	Integer	The number of rows to fetch per step.
Custom Label	String	Override the title of the data grid.
Custom Icon	String	Customize the data grid icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/
Grid Height	Integer	Set the grid height. Set this property if you want to control the height and show up components after the grid. The user has to scroll vertically to see more records.
Column Style	String	JSON string to override the column's style. See GM - RelatedList Grid
Candidates	String	The list of records to display. The collection should be a JSON string. See Flow Tutorial. Within GM - Flow View Grid you can use either Candidates or Filter. We use only the list of Id(s) to get the records.
Filter	String	JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid
Sort	String	The field list to sort the data grid. This field is used only for the initial load. Don’t forget __c for custom fields. See GM - RelatedList Grid
Order	String	Ascending or descending order for sorting. For ascending enter the value asc. For descending enter the value desc
Show Border	Boolean	Check this option if you wish to add a border to the grid.
Show Column Border	Boolean	Check this option if you wish to add a border to the grid columns.
Custom Field Labels	String	A JSON string to override column label. See GM - RelatedList Grid
Cell Coloring	String	JSON conditions for cells coloring. You can define for each field displayed in the grid the coloring and the corresponding condition. See GM - RelatedList Grid
Lookup Fields Options	String	JSON string to customize lookup fields. You can define different aspects for each lookup field. See GM - RelatedList Grid
Show Record Details	Boolean	Check this option to allow the end-user to view the record details in the grid
Required	Boolean	Check this option to make a record selection required before moving to the next step.
Single Record Selection	Boolean	Check this option to make a single record selection.
Selected Records	String	The list of selected records as JSON string. Set this property only if you want to assign the output manually.
Selected Id(s)	String	The list of selected recordId. Set this property only if you want to assign the output manually.
Selected Record	String	The selected record as JSON string. Set this property only if you want to assign the output manually. This property is valid only if Single Record Selection is checked.
Selected Id	String	Selected record id. Set this property only if you want to assign the output manually. This property is valid only if Single Record Selection is checked.
Group By	String	',' separated list of fields to group by. Don’t forget __c for custom fields. When an aggregation is defined, the Grid will display the intermediate aggregations at the group level. The configuration wizard can be used to set this property.
Enable Explorer	Boolean	Check this option if you want to use the Grid Explorer. When this option is active, the end user will be able to explore the grid through the Explorer by filtering the records, hiding or reordering the columns and also by setting the grouping.
Search Fields	String	',' separated list of fields to search in. If the list is empty, the search input is hidden in action. Only text fields (Text, PickList, Phone, Email, URL) are supported. The configuration wizard can be used to set this property.
Wildcard Search	Boolean	Check this option if you wish to use a wildcard search. If this option is activated, the end user doesn’t have to add ‘*’ to the search query.
No Card Header	Boolean	Check this option to hide the grid header. Only the table will be displayed.
View Only Mode	Boolean	Check this option to display the grid in a view mode only. No checkbox is available. This mode is usefull to display a summary table for instance.
Aggregate	String	JSON string to define the aggregate field. Use __c for custom fields. The supported functions are "sum", "min", "max", "avg" and "avgnotnull". See GM - RelatedList Grid
Collapse Groups	Boolean	Check this options to collapse groups by default. This option is relevant only it the records are grouped. The user can still expand a group. When a group is expanded, the user can select/unselect the whole group records using the checkbox at the group level.
Preserve Selection	Boolean	Check this option to preserve the user selection. This option is useful when the search fields are configured or the explorer is enabled. When the candidates are refreshed, the selected records that are no longer valid will be appended to the top of the grid.

Property

Type

Description

recordId

String

recordId to use. Keep this empty if you want to use the current record.

Related Object Name *

String

The name of the related object to display

FieldSet Name *

String

The Field Set name of the related object to display

Row Limit *

Integer

The maximum number of rows to fetch.

Page Size *

Integer

The number of rows to fetch per step.

Custom Label

String

Override the title of the data grid.

Custom Icon

String

Customize the data grid icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/

Grid Height

Integer

Set the grid height. Set this property if you want to control the height and show up components after the grid. The user has to scroll vertically to see more records.

Column Style

String

JSON string to override the column's style. See GM - RelatedList Grid

Candidates

String

The list of records to display. The collection should be a JSON string. See Flow Tutorial. Within GM - Flow View Grid you can use either Candidates or Filter. We use only the list of Id(s) to get the records.

Filter

String

JSON string to define filter criteria. Don’t forget __c for custom fields. See GM - RelatedList Grid

Sort

String

The field list to sort the data grid. This field is used only for the initial load. Don’t forget __c for custom fields. See GM - RelatedList Grid

Order

String

Ascending or descending order for sorting. For ascending enter the value asc. For descending enter the value desc

Show Border

Boolean

Check this option if you wish to add a border to the grid.

Show Column Border

Boolean

Check this option if you wish to add a border to the grid columns.

Custom Field Labels

String

A JSON string to override column label. See GM - RelatedList Grid

Cell Coloring

String

JSON conditions for cells coloring. You can define for each field displayed in the grid the coloring and the corresponding condition. See GM - RelatedList Grid

Lookup Fields Options

String

JSON string to customize lookup fields. You can define different aspects for each lookup field. See GM - RelatedList Grid

Show Record Details

Boolean

Check this option to allow the end-user to view the record details in the grid

Required

Boolean

Check this option to make a record selection required before moving to the next step.

Single Record Selection

Boolean

Check this option to make a single record selection.

Selected Records

String

The list of selected records as JSON string. Set this property only if you want to assign the output manually.

Selected Id(s)

String

The list of selected recordId. Set this property only if you want to assign the output manually.

Selected Record

String

The selected record as JSON string. Set this property only if you want to assign the output manually. This property is valid only if Single Record Selection is checked.

Selected Id

String

Selected record id. Set this property only if you want to assign the output manually. This property is valid only if Single Record Selection is checked.

Group By

String

',' separated list of fields to group by. Don’t forget __c for custom fields.

When an aggregation is defined, the Grid will display the intermediate aggregations at the group level.

The configuration wizard can be used to set this property.

Enable Explorer

Boolean

Check this option if you want to use the Grid Explorer. When this option is active, the end user will be able to explore the grid through the Explorer by filtering the records, hiding or reordering the columns and also by setting the grouping.

Search Fields

String

',' separated list of fields to search in. If the list is empty, the search input is hidden in action. Only text fields (Text, PickList, Phone, Email, URL) are supported. The configuration wizard can be used to set this property.

Wildcard Search

Boolean

Check this option if you wish to use a wildcard search. If this option is activated, the end user doesn’t have to add ‘*’ to the search query.

No Card Header

Boolean

Check this option to hide the grid header. Only the table will be displayed.

View Only Mode

Boolean

Check this option to display the grid in a view mode only. No checkbox is available. This mode is usefull to display a summary table for instance.

Aggregate

String

JSON string to define the aggregate field. Use __c for custom fields. The supported functions are "sum", "min", "max", "avg" and "avgnotnull". See GM - RelatedList Grid

Collapse Groups

Boolean

Check this options to collapse groups by default.

This option is relevant only it the records are grouped.

The user can still expand a group. When a group is expanded, the user can select/unselect the whole group records using the checkbox at the group level.

Preserve Selection

Boolean

Check this option to preserve the user selection. This option is useful when the search fields are configured or the explorer is enabled.

When the candidates are refreshed, the selected records that are no longer valid will be appended to the top of the grid.

API Reference

<design:component label="GM - Flow View Grid">
    <design:attribute name="recordId" label="01. recordId" 
                      description="recordId to use. Keep this empty if you want to use the current record"/>        
    <design:attribute name="relatedObjectName" label="02. Related Object Name" 
                      description="The name of the related object to display. Ex. Opportunity"/>    
    <design:attribute name="fieldSetName" label="03. FieldSet Name" 
                      description="The fieldSet name of the related object to display"/>                            
    <design:attribute name="rowLimit" label="04. Row Limit" 
                      description="The maximum number of row to fetch"/>     
    <design:attribute name="customLabel" label="05. Custom Label" 
                      description="Override the label of data grid"/> 
    <design:attribute name="customIcon" label="06. Custom Icon" 
                      description="Customize the data grid icon. All lightning icons are supported. You can get the icon name from https://lightningdesignsystem.com/icons/"/> 
    <design:attribute name="height" label="07. Grid Height" 
                      description="Set the grid height"/>  
    <design:attribute name="columnStyles" label="08. Column Style" 
                      description="Json string to define column's style. Don’t forget __c for custom fields. Ex. {'StageName':'width:200px'} to set the width for Stage column"/>     
    <design:attribute name="candidates" label="09. Candidates" 
                      description="The list of candidates to display"/>    
    <design:attribute name="filter" label="10. Filter" 
                      description="Json string to define filter criteria. Don’t forget __c for custom fields. Ex. {'StageName':'Needs Analysis'} to see only 'Needs Analysis' Opportunities"/>    
    <design:attribute name="sort" label="11. Sort" 
                      description="The field list to sort the data grid. This field is used only for the initial load. Don’t forget __c for custom fields. Ex. Amount to sort opportunities by amount"/>
    <design:attribute name="order" label="12. Order" 
                      description="Asc or Desc order for sorting"/>         
    <design:attribute name="showBorder" label="13. Show Border" 
                      description="Show Border"/>
    <design:attribute name="showColumnBorder" label="14. Show Column Border" 
                      description="Show Column Border"/>        
    <design:attribute name="fieldLabels" label="15. Custom Field Labels" 
                      description="{name:label} custom field labels map"/>    
    <design:attribute name="coloring" label="16. Cell Coloring" 
                      description="JSON conditions for cells coloring"/>
    <design:attribute name="lookupOptions" label="17. Lookup Fields Options" 
                      description="JSON options for lookup fields {apiName : {titleField : value, subTitleField : value}}"/>            
    <design:attribute name="recordDetail" label="18. Show Record Details" 
                      description="Show Record Details"/>            
    <design:attribute name="required" label="19. Required" 
                      description="Set the selection as required"/>                
    <design:attribute name="singleRecord" label="20. Single Record Selection" 
                      description="Single record selection only"/>                               
    <design:attribute name="selectedJsonRecords" label="21. Selected Records" 
                      description="The list of selected records as JSON string"/>                                 
    <design:attribute name="selectedIds" label="22. Selected Id(s)" 
                      description="The list of selected id(s)"/>           
    <design:attribute name="selectedJsonRecord" label="23. Selected Record" 
                      description="The selected record as JSON string"/>                                 
    <design:attribute name="selectedId" label="24. Selected Id" 
                      description="Selected record id"/>                                 
    <design:attribute name="groupBy" label="25. Group By" 
                      description="',' separated list of fields to group by"/>                       
    <design:attribute name="canExplore" label="26. Enable Explorer" 
                      description="Check this option if you want to use the Grid Explorer"/>                           
    <design:attribute name="jsonSearchFields" label="27. Search Fields" 
                      description="',' separated search fields"/>   
    <design:attribute name="wildCardSearch" label="28. Wildcard Search" 
                      description="Use Wildcard Search"/>
    <design:attribute name="tableOnly" label="29. No Card Header" 
                      description="Hide Card Header"/>   
    <design:attribute name="viewOnly" label="30. View Only Mode" 
                      description="View only mode without record selection"/>                        
    <design:attribute name="aggregate" label="31. Aggregate" 
                      description="Json string to defined the aggregate fields. The components are supporting 'sum', 'minx' and 'max'. Don’t forget __c for custom fields. Ex. {'Amount':'sum'} to aggregate the amount of opportunities"/>        
    <design:attribute name="collapseGroups" label="32. Collapse Groups" 
                      description="Collapse groups"/>
    <design:attribute name="preserveSelection" label="33. Preserve Selection" 
                      description="Preserve Selection"/>   
    <design:attribute name="recordRelated" label="34. Record Related Components" 
                      description="Json string to initialize related components"/>                                               
</design:component>

PreviousGM - FieldSet Pivot NextGM - Flow Edit Grid

Last updated 5 months ago