Formula URL fields explained

Authorization Parameters

clientid

Quickbase Extensions client identifier assigned to your account during the setup process.

clientid=Q2

appid

Unique identifier for your Quickbase app. This verifies that your app is authorized to use QB Maps.

appid=bdht2xebx

DBID

This is the table ID for the QB Maps table created in your app. It's required for getting legend properties.

DBID=haqui23va

Map Records Parameters

Indicates to QB Maps which records you want to show on the map.

QB_DBID<num>

The table that contains the list of locations that the extension will plot on the map.

Replace the <num> with a number value. ex: QB_DBID1

QB_DBID1=xxxxxxxxx

query<num>

The query used by the extension to filter the locations from the table pointed to by QB_DBID<num>.

Replace the <num> with a number value. ex: query1

query1={'6'.EX.'County'}

clist<num>

The list of field IDs that the extension retrieves from the table before plotting the locations.

Replace the <num> with a number value. ex: clist1

CLIST ORDER: Record ID#.Latitude.Longitude.Name.Marker.Address.City.State.Zip.URL.U1.U2.U3

OR

CLIST ORDER: Record ID#.Latitude.Longitude.Name.Marker.(A)Address.URL.U1.U2.U3

To pass in the entire address in the clist, remove the City, State, and Zip from the clist, and put an A in front of the address in the clist.

clist1=3.71.70.6.7.8.9.10.11.72.12.47.35

OR

clist1=3.71.70.6.7.A8.72.12.47.35

Central Pin Location Parameters

Indicates to QB Maps to get only the records around a central location within a radius of that location.

QB_DBIDR

The DBID of the table from which a central location can be retrieved.

QB_DBIDR=xxxxxxxxx

queryR

The query condition used to filter the records in the QB_DBIDR table. This query should be set up to only get one record.

queryR={'6'.EX.'Juiced'}

clistR

The list of fields that are retrieved from the QB_DBIDR table.

clistR=3.71.70.6.7.8.9.10.11.72.12.47.35

dist

Tells QB Maps to only get the pins around the central pin.

dist=Y

rad

QB Maps only displays pins that are within the radius of the given number of miles from the center pin.

rad=2.5

directionR

Sets the center pin's latitude and longitude as either the start or end location in the directions.

Accepts either start or dest as values.

directionR=start

directionR=dest

Central Pin Circle Parameters

Displays a circle around the central pin. The parameters in Central Pin Location are required to display the circle.

circleRad

Displays a circle around the central pin with a radius of that many miles.

If you include a %, the circle uses that percentage of the rad parameter's radius.

circleRad=2

circleRad=50%

circleColor

Enter either a hex value (#00FFFF) or a color name (Blue). See the list of supported color names.

If this parameter isn't included in the URL, the color defaults to blue.

circleColor=Crimson

circleColor=#dc143c

circleFill

When this parameter has a value of false, the circle isn't filled in with the color.

circleFill=False

Current Location Parameters

Indicates to QB Maps to show a pin at the user's current location.

showCurrLocation

Places a pin at the user's current location. You also need to change qbmaps.aspx to ShowLocation.aspx in the URL.

showCurrLocation=true

locdbid

The DBID of the table where you want to store the current location's latitude and longitude.

locdbid=dbid()

locrecid

The Record ID# of the record where you want to store the current location's latitude and longitude.

locrecid=[Record ID#]

qbuserid

The email of the current user.

qbuserid=UserToEmail(User())

locclist

A clist of the latitude, longitude, and user fields that you want filled in.

locclist=11.12.34

Miscellaneous Parameters

W,H,zoom

These values set the display width and height of the maps division in the browser, and set the default zoom level.

These values aren't used in version 6.0 and later, and don't need to be passed as parameters in the URL.

w=1000&h=500&z=10

multiselect

Lets you select multiple pins and get the fastest route between all of them.

multiselect=True

ddShowAll

If ddShowAll is true, the map continues to display the other pins not included in the driving directions.

ddShowAll=True

legrecid

This is the record ID of the record that triggers the button. It's required for getting legend properties.

legrecid=[Record ID#]

legendfid

The field ID of the legend properties field in the master table.

legendfid=19

hidelegend

Determines if the legend is shown when the map first opens.

If false, blank, or not included, the legend is already open. If true, the legend isn't shown.

hidelegend=false

numoftables

This specifies the number of tables from which the locations need to be queried. QB_DBIDR isn't included in this number.

numoftables=2

type

Sets what style of map is displayed by default.

Available options are roadmap, terrain, hybrid, and satellite. If blank or not included, it defaults to roadmap.

type=hybrid

clickzoom

If true, blank, or not included, pins zoom in when selected. If false, the pin is focused, but the screen doesn't zoom in on it.

clickzoom=true

apptoken

If you have app tokens turned on in your app, include this parameter and the token. If you have tokens turned off, you can leave this parameter off.

apptoken=xxxxxxxxxxxxx

preqbaction

Pre Quickbase Action lets you edit the record the button is clicked on before the document is generated. In the past, to do this, you had to make the API edit record call and then redirect to our extension to generate the document. Using this parameter eliminates the need to redirect, since you're passing the API edit record command into the extension itself.

Base64Encode the API edit record command as well. See the corresponding sample in the Sample column.

In this sample, when the button is selected, the record is edited before the document is created:

"&preqbaction=" & Base64Encode(
URLRoot() & "db/" & Dbid() & "?act=API_EditRecord"
& "&rid=" & URLEncode([Record ID#])
& "&_fid_121=" & ToText(Now())
& "&_fid_122=Updated by: " & UserToName(User())
& "&apptoken=bbbbbbbbbbbbbbbbbbbb"
)
)