URL Parameters
Geopointe supports using URL parameters to affect functionality in the application.
Map
The following are the URL parameters available for the Map page. This is the main page used in the application and is found, by default, within the Map tab.
| URL Parameter | Description | Versions | Example Usage |
|---|---|---|---|
| Basic Parameters - the URL will only accept one of these values. | |||
| id | Used to set the context for the page. The system will set the context as the location of the record with that ID value. This parameter is used with the Map button that comes with the application for use on your Page Layouts | 1.0 - Current | &id=0013000000i4f8n |
| routeId | Used to open a Saved Route. Routes are saved in the Route__c object and this value will hold the Id of the record being opened. A route can be opened by any Geopointe user. If a user is not the "owner" of a route, their view will be limited and will not allow overwriting or deleting of that route. | 1.4 - Current | &routeId=a1930000000PEx1AAG |
| Mapping specific records - all these parameters must be used together and are used to plot specific records onto the map. This feature is currently used by the Map Records button on List Views. Use those buttons as an example of how to use this feature. | |||
| idArray | A comma separated list of record IDs that should be mapped. The records must have already been geocoded to appear on the map. Starting in Geopointe version 2.0.29, the IDs can come from different objects. Prior to version 2.0.29, they must come from the same object. The value can be sent via a GET or POST request. | 1.5 - Current | &idArray0013000000i4f8n,0013000000LEFf4,0013000000c9aUi |
| obj | The object of all the IDs in the idArray parameter. The value here should be the API name for the object. This was deprecated as of version 2.0.23. The object is interpreted dynamically from the ID value. | 1.5 - 2.0.22 | &obj=account |
| iconColor | The color (HEX value) the map icons should appear. If no value is set, a default value will be selected by the system. For standard objects, the color should match the color for that object. For custom objects, all will use a default color. | 1.5 - Current | &iconColor=236FBD |
| idArrayAddToRoute | If set, all of the records identified in the idArray will be added to the Current Route list. Acceptable values are: yes, true, 1. If not set, no action will be taken by the page upon load. | 2.0.26 - Current | &idArrayAddToRoute=1 |
| Map Searches - These parameters impact how a user will be searching the Map page. These parameters can be used independently of one another. See our blog post for more detail on this feature. | |||
| units | Sets units to either Miles or Kilometers. Acceptable values for Miles are: m, mi, mile or miles. Acceptable values for Kilometers are: k, km, kilometer,kilometers. If this value is not set, the user's last used value will be set. | 1.6.7 - Current | &units=m |
| range | Sets the range value for a radial search. The value must be numeric and decimal values are acceptable. If this value is not set, the user's last used value will be set. | 1.6.7 - Current | &range=10.5 |
| ds | The Data Set to select. This value needs to contain the unique ID for the Data Set. This value can be found on the Data Set page when editing the Data Set or in the URL on that same page. If this value is not set, the user's last used Data Set will be set. | 1.6.7 - Current | &ds=12825203386670.18644033148613703 |
| driveCalc | Affects the Calculate Drive Distance? parameter on the page. To set it to true, acceptable values are: yes, true, 1. To set it to false, acceptable values are: no, false, 0. If this value is not set, the user's last used value will be set. | 1.6.9 - Current | &driveCalc=true |
| runRadialSearch | If set, a Radial Search will be invoked upon page load. Acceptable values are: yes, true, 1. If not set, a search will not be performed. | 1.6.7 - Current | &runRadialSearch=true |
| colorBy | Coming soon | N/A | |
| filters | Coming soon | N/A | |
| Map As Lookup - Adds a button in the Info Windows for the map pins to "write back" a value to an originating record. See our blog post for more detail on this feature. All of these parameters must be used together to invoke the feature. | |||
| wbRecordId | Identifies the record ID of the record that will be updated. For example, maybe we are updating a Case with the Technician Contact associated to a case. This value would be the Case Id. | 1.4 - Current | &wbRecordId={!Case.Id} |
| wbField | Specifies the field to populate on the record we are updating. Using the example above, this would be a Lookup field to Contacts that exists on the Case object. | 1.4 - Current | &wbField=Technician_Contact__c |
| wbLookupObject | The object we are looking up. This lets Geopointe know whether to include a button with the map pins. Using our example above, we'd only want the button added if we find Contacts on the map because we are populating a Contact lookup field. | 1.4 - Current | &wbLookupObject=Contact |
| wbButtonText | The text we want to appear on the button in map pin. It is important to URLENCODE the free-text you put in this parameter. | 1.4 - Current | &wbButtonText={!URLENCODE("Relate to Case #" & Case.CaseNumber)} |
| wbRedir | Whether or not you want the page to redirect back to the originating record. To set it to true, you can either not include the parameter or use on of the following: yes, true, 1. To set it to false, acceptable values are: no, false, 0. | 2.1.11 | &wbRedir=false |
