Most methods of providing access to a Grid require you to generate a Grid URL. A simple version of the Grid URL is generated for you on page 1 of the Grid Wizard. Below are some URL parameters that the Grid supports. Including these parameters provides more control over how a Grid initially loads.
The first row that loads on the Grid. For example, the first row of the second page of a Grid with a page size of 10 is “11”.
| Parameter | Description |
| desktopView | This parameter allows you to view a grid in the desktop view while on a mobile device. A value of 1 will load a grid in desktop view; a value of 0 will load a grid in mobile view. This parameter only applies when viewing grids on mobile devices. Adding this parameter with a value of 1 to the Grids page will make all grids accessed through the Grids page load in desktop view. |
| ea |
“Expand All” option. A value of 1 shows all child related lists expanded by default. A value of show_related_objects shows all child related lists collapsed by default. A value of 0 hides all child related lists by default. Passing a list of object API names shows just those child related lists expanded by default, i.e. ea=Contact,Opportunity. This parameter only applies to multi-object grids.
|
|
expand_ groupings |
A value of 1 will show all group by headers; a value of 0 will hide group by headers after the first level grouping. This parameter only applies to grids that have two or more group by fields configured on page 3 of the Grid Wizard.
|
| fpf |
“Filter by Parent Field” option. Specify the API name of a field on the grid parent object or on a parent of the grid parent object. If the field is on the parent of the grid parent object, specify its relationship name (usually ends with “__r” if it’s a custom relationship), a dot “.”, and the API name of the field. For example, fpf=”Custom_Lookup__r.Custom_Field__c”. Note, filter conditions defined in Grid Wizard 3 and in the user-defined filter widget will be applied in addition to the criteria specified by the fpf/fpv parameters. This parameter is only supported for fields with the following data types: id, lookup, text, picklist, email, URL, and phone.
|
|
fpf2-fpf5 Unlimited Only |
Additional “Filter by Parent Field” options. These can be added to grid URLs to filter grids further. For example: fpf=Stage&fpf2=CloseDate&fpf3=ForecastCategoryName&fpf4=LeadSource&fpf5=Type.
|
| fpv |
“Filter by Parent Value” option. The value that the fpf parameter should evaluate to. Records that have this value for the fpf field will be displayed on the grid. Note, filter conditions defined in Grid Wizard 3 and in the user-defined filter widget will be applied in addition to the criteria specified by the fpf/fpv parameters. This parameter is only supported for fields with the following data types: id, lookup, text, picklist, email, URL, phone, boolean, date (literal and relative), and datetime (using relative dates). Example of filtering by Opportunity Close Date to show Opportunities closing this quarter: /apex/gblite__Grid?gname=Oppties&fpf=CloseDate&fpv=THIS_QUARTER If the data type is ID, Lookup, or text-based (not date, datetime, or boolean), you can specify a comma separated list of values for the parameter. For example: /apex/gblite__Grid?gname=Accounts with Oppties&fpf=Id&fpv=001i000000MK5DA,001i000000JM,001i000000FPH5r /apex/gblite__Grid?gname=Accounts with Oppties&fpf=BillingState&fpv=CA,NY Note: if specifying a comma separated list, the fpv URL parameter value can support up to 900 characters, or up to 50 Salesforce ID values.
|
|
fpv2-fpv5 Unlimited Only |
Additional “Filter by Parent Value” options. Example of filtering by Opportunity Close Date to show Opportunities closing this quarter with a Lead Source of Web: /apex/gblite__Grid?gname=Oppties&fpf=CloseDate&fpv=THIS_QUARTER&fpf2=LeadSource&fpv2=Web Example of filtering where Opportunity Stage is Prospecting or Qualification, Close Date is this month, and the opportunity owner’s Role is Channel Sales. /apex/gblite__Grid?gname=Accounts with Oppties&fpf=StageName&fpv=Prospecting,Qualification&fpf2=CloseDate&fpv2=THIS_MONTH &fpf3=Owner.UserRole.Name&fpv3=Channel Sales
|
| fpo |
“Filter Parent Operator” option. This optional filter parameter is specified in conjunction with the fpf/fpv parameters, and will result in a partial versus exact match. The only acceptable value for this parameter is the word “contains”. This parameter is only supported for fields with the following data types: text, lookup fields, email, picklist, phone, string and URL. Example of filtering Opportunity by Stage that returns records where the Stage contains the text “Closed” /apex/gblite__Grid?gname=Oppties &fpf=StageName&fpv=Closed&fpo=contains
|
|
fpo2-fpo5 Unlimited Only |
Additional “Filter Parent Operator” options. These can be added to grid URLs with the corresponding fpf2-5 and fpv2-5 parameters to filter grids further. For example /apex/gblite__Grid gname=Oppties&fpf=StageName&fpv=closed&fpo=contains&fpf2=Name&fpv2=apple&fpo2=contains
|
| gname |
The name of the Grid. It is okay to include spaces for the value of this parameter.
|
| id |
Specify the ID of the parent record you want to filter child results by (see Detail Page Related Lists above). This ID must be a valid Salesforce record ID matching the object type of the parent object you defined in page 1 of the Grid Wizard. When this parameter is specified, the “ea” parameter is automatically set to 1 and the “sh” and “ssb” parameter are automatically set to 0, expanding all records, and hiding the header and sidebar.
|
| ps |
The Grid page size. By default this is 20. For multi-object Grids, possible values are: 5, 10, 20, 30, 40, 50. For single object grids, possible values are: 5, 10, 20, 40, 60, 80, 100, 150, 200.
|
| ro |
This parameter specifies whether the grid loads in read-only mode or not. Specify a value of 1 to load the grid in read-only mode. To automatically load a grid in edit mode (that has the edit option enabled in the Grid Wizard), leave this parameter blank.
|
|
sbb deprecated |
“Show Bottom Buttons” option. A value of 1 forces the bottom buttons to be displayed. Any other value hides the bottom buttons. If not specified, the bottom buttons will be hidden for grids in the record detail screen, and displayed when outside the record detail screen. Note, this parameter only applies to GridBuddy version 4.11 and earlier. In GridBuddy 5.0 and later this parameter has no affect.
|
| sfname |
“Saved Filter Name” option. The name of the filter to load the grid with. The filter name can be a user-defined filter, or an admin-defined filter. To load the grid with the default filter, use “default” as the parameter’s value. To load the grid with any other admin-defined filter, use “admin_[filter name]” as the parameter value.
|
| sh |
“Show Header” option. A value of 1 shows the standard Salesforce header by default; a value of 0 hides it.
|
|
show_record _details |
A value of 1 will show grid data rows; a value of 0 will hide grid data rows. This parameter only applies to grids that have group by fields configured on page 3 of the Grid Wizard.
|
| ssb |
“Show Sidebar” option. A value of 1 shows the standard Salesforce sidebar by default; a value of 0 hides it.
|
Examples: /apex/gblite__Grid?gname=Accounts with Oppties&sh=1&ssb=0&ea=1&ps=50
The URL above loads a Grid called “Accounts with Oppties” (must be defined), will show the standard Salesforce header, will not show the standard Salesforce sidebar, will automatically expand all child records on load, and will show up to 50 Account records per page.
/apex/gblite__Grid?gname=Accounts with Oppties&id=0015000000HtRNX
The URL above only loads a grid of child records for an Account with an ID of 0015000000HtRNX. Note, the “ea” parameter is automatically set to 1 and the “sh” and “ssb” parameter are automatically set to 0 when the “id” parameter is specified. This Grid also launches in edit mode since no “ro” parameter is specified.
