Geopointe

URL Parameters

Geopointe supports using URL parameters to affect functionality in the application.

Note: The majority of these URL parameters do not work with the Salesforce1 mobile application. Parameters supported will state ‘Works with Salesforce1′.

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.

Basic Parameters

The URL will only accept one of these values.

URL Parameter
Description
Versions
Example Usage
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.

 

Works with Salesforce1.

1.0 – Current &id=recordID
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=recordID
center Used to center the map at that location. It acts like an Address/Places search, so it will support addresses (partial and complete), lat/longs, and names of places. 10.0 - Current &center=1 Market St, 94105 &center=37.79391,-122.3949 &center=The White House

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.

URL Parameter
Description
Versions
Example Usage
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 &idArray=recordID1,recordID2
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.

URL Parameter
Description
Versions
Example Usage
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 from Geopointe Setup or in the URL on that same page. Multiple comma separated values may also be provided.

 

If this value is not set, the user’s last searched Data Set will be used.

Multiple data sets can be used at once, with the ids comma separated (filter parameters will not work when more than one data set is used).

1.6.7 – Current &ds=dataSetID
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.7 – 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
runEntireDataSetSearch If set, an Entire Data Set Search will be invoked upon page load.

 

This is typically used in conjunction with URL filter parameters.

3.36.5 – Current &runEntireDataSetSearch=true

URL Filter Parameters

Geopointe supports adding URL filter parameters that will be appended to the Data Set defined with the ‘ds’ url parameter. For a url filter to work you must define the filter field (ff) the filter operation (fo) and the filter value (fv). Url parameters supports multiple filters so each filter parameter should be appended with a matching number starting at 1. For example, to filter on accounts where Industry equals Technology you would build the following url where ds=12825203386670.18644033148613703 is the id for an Account Data Set:

/apex/map?ds=12825203386670.18644033148613703&ff1=Industry&fo1=equal&fv1=Technology

If you supply multiple filters Geopointe also supports filter logic with an ‘fl’ parameter. Details below. These URL filter parameters can also be used the the Map Search parameters above to automatically run searches on the load of the Map page.

URL Parameter
Description
Version
Example
ds The data set Id the URL filter parameters will be appended to. (Required) 3.36 – current ds=dataSetID
ff# The filter field. This should be the API name of the field you would like the filter applied to. (Required) 3.36 – current ff1=Industry
fo# The filter operator. Valid values are: equal, notequal, lessthan, greaterthan, lessorequal, greaterorequal, contains, notcontains, startswith, includes, notincludes.

 

These values are case sensitive.

(Required)

3.36 – current fo1=equal
fv# The filter value for the corresponding filter field. (Required) 3.36 – current fv1=Technology,Aerospace
ft# Field type for the selected filter field. This parameter is optional. URL parameters default to the type of ‘String’ but you may need to override this depending on the filter requirements.

 

Valid values are: double, integer, string, boolean, date, datetime, multipicklist (only works with includes operator)

(Optional)

3.36 – current ft1=string
fl Define custom filter logic to the filters defined with the URL parameters. If the selected Data Set already has filter logic the URL filter logic will be appended to the end of the existing filter logic. (Optional) 3.36 – current fl=(1 OR 2)

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.

URL Parameter
Description
Versions
Example Usage
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 – Current &wbRedir=false