Batch parameter fields explained
What's behind the formula?
A formula text field is used to execute the QB Maps extension. As this is very critical in the way the QB Maps extension operates, it is important that the various areas on this page are understood.
The clist section spells out the content/fields needed for running its respective process.
The following list shows each Batch parameter and a brief description.
Batch Parameter | Description | Sample |
|---|---|---|
Authorization Parameters | ||
clientid | Quickbase Extensions client identifier assigned to your account during the setup process. | clientid=Q2 |
appid | Unique identifier for the Quickbase app. This is used to verify that your app is authorized to use QB Maps. | appid=bdht2xebx |
Geocoding Latitude and Longitude Parameters Indicates to QB Maps which records you want to get the latitude and longitude of. | ||
geoQB_DBID | The table that contains the list of locations that the extension will get the latitude and longitude of. | geoQB_DBID=xxxxxxxxx |
geoquery | The query that is used by the extension to filter the locations from the table pointed to by geoQB_DBID. | geoquery={'6'.EX.'County'} |
geoclist | The list of field IDs that the extension retrieves from the table before geocoding the locations. CLIST ORDER: KeyField.Address.City.State.Zip.Latitude.Longitude OR CLIST ORDER: KeyField.(A)Address.Latitude.Longitude 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 field in the clist. | geoclist=3.8.9.10.11.72.73 OR geoclist=3.A8.72.73 |
geostatusfid | The field id of the status field to update when the process is done. Lets you know if it worked or if there was an error. | geostatusfid=27 |
geokeyfid | The field id of the key field in the geoQB_DBID table. You only need this field if Record ID# is not the key fid. | geokeyfid=6 |
geokey | The value from the key field. | geokey=[Key Field] |
Distance Parameters Indicates to QB Maps which records to use when getting the distance between them. | ||
distdbid | The DBID of the table from which the distance is stored. | distdbid=xxxxxxxxx |
distmsid | The key value from the distdbid table. Likely the Record ID#. | distmsid=[Record ID#] |
distkeyfid | The field id of the key field in the origindbid table. You only need this field if Record ID# is not the key fid. | distkeyfid=6 |
distancefid | The field id of the field that stores the distance. | distancefid=7 |
diststatusfid | The field id of the status field that lets you know if the process ran successfully or not and when it finished. | diststatusfid=8 |
origindbid | The DBID of the table from which the starting location can be retrieved. | origindbid=xxxxxxxxx |
originclist | The list of field IDs that the extension retrieves from the table before calculating the distance. CLIST ORDER: KeyField.Address.City.State.Zip.Latitude.Longitude OR CLIST ORDER: KeyField.(A)Address.Latitude.Longitude 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 field in the clist. | originclist=3.8.9.10.11.72.73 OR originclist=3.A8.72.73 |
originkeyfid | The field id of the key field in the origindbid table. You only need this field if Record ID# is not the key fid. | originkeyfid=6 |
originkey | The value from the originkeyfid field. | originkey=[Key Field] |
destdbid | The DBID of the table from which the ending location can be retrieved. | destdbid=xxxxxxxxx |
destclist | The list of field IDs that the extension retrieves from the table before calculating the distance. CLIST ORDER: KeyField.Address.City.State.Zip.Latitude.Longitude OR CLIST ORDER: KeyField.(A)Address.Latitude.Longitude 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 field in the clist. | destclist=3.8.9.10.11.72.73 OR destclist=3.A8.72.73 |
destkeyfid | The field id of the key field in the destdbid table. You only need this field if Record ID# is not the key fid. | destkeyfid=6 |
destkey | The value from the destkeyfid field. | destkey=[Key Field] |
Miscellaneous Parameters Parameters that are used in different processes. | ||
overridelatlong | Set this to true if you want to update the value currently in the latitude and longitude fields. This value defaults to false if left blank or not passed in. The process does not recalculate the latitude and longitude of records that already have a value. | overridelatlong=true |