• From Setup, go to Data Integration Rules
• Enable the following
  • Geocodes for Account Billing Address
  • Geocodes for Account Shipping Address
  • Geocodes for Contact Mailing Address
  • Geocodes for Lead Address

FirmWorks Geo has multiple components that can be used to facilitate showing users what they need to see.

Entity Locator

The Entity Locator includes all components: FirmWorks Geo Search, FirmWorks Geo List, and FirmWorks Geo Map. It is the most comprehensive and versatile component. Just drop it and go.

See below for more information on each individual component.

FirmWorks Geo Search Component

This component allows you to reference the various configurations you have set up to search for addresses within the chosen location.

I am looking for—Here you will choose a configuration build by an admin to set the addresses you want to find.

Filtered to—This allows you to reference filters that are part of that configuration.

With in—Set a number and a distance unit for your search radius.

Of—Enter an address or use your current location. *Note: If you are using the out of box US Census Geo Code data, the address will need to be a full address and cannot be address parts.

i.e. 111 N. Green St Wiltlen, CA 81919, NOT 111 Green Street

Search—Enter an Address or use your current location. *Note: If you are using the out of box US Census Geo Code data, the address will need to be a full address and cannot be address parts.

FirmWorks Geo List Component

The List Component will display a list of the records found based on the criteria set in the search component.

• • Clicking the Download button will download the list of records returned in an Excel document.
  • Clicking on the radio button on the left will center your FirmWorks Geo Map component on that address.
  • Clicking View on the right will navigate you to the record in a new tab.

The columns can be set in the configuration you choose in the ‘I am looking for’ section of the search component.

FirmWorks Geo Map Component

The FirmWorks Geo Map component will show the items from the FirmWorks Geo List based on the search criteria in the FirmWorks Geo Search. When the component loads, it will show a blue circle for the radius of your search.

It can be moved by clicking and dragging, and can be re-centered by clicking on an item on the FirmWorks Geo List component.

You can also switch between Map and Satellite by clicking the buttons on the top left.

FirmWorks Geo Configurator Component

This component can be used to access FirmWorks Geo Configuration wherever you add it. This can be helpful when you need to quickly add a column or change the mapped address fields.

NOTE: Not everyone should have access to the FirmWorks Geo Configuration, only Admins and team members who are familiar with how geocode mapping works. You can conditionally hide the component on pages and lightning apps. Please use the article HERE to understand how.

BACK TO TOP

Interact with any Geocode API using Custom Providers Setups and your own APEX.

Works with standard data integrations in just seconds.

BACK TO TOP

Can be set up for a custom object using APEX to import the geocode data from a provider.

BACK TO TOP

Easily set up multiple configurations for address fields and filters for easy address targeting.

BACK TO TOP

Export list of data for customer visits or plan a specific sales route. 

BACK TO TOP

Customize insights by choosing the data you see on the map and search list.

BACK TO TOP

Back to Documentation

Google API Key Provider

Using a Google API key is recommended to provide users with the optimum experience for searching arbitrary addresses, postal codes, cities and more.

The base provider requires a full non-typed address to get results – Google provides a more “fuzzy” matching experience.

Google provides (as of 1/1/2023) 200 dollars per month credit to a Google cloud account. This entails that your organization can use up to 20,000 api calls a month free of charge.

Obtaining a Google API Key

• • Getting Started with Google Maps Platform
  • Get Google Maps API Key

Using Google API Key

Paste API Key into the Google box in the FirmWorks Geo Configuration screen. 

Back to Documentation

Back to Documentation

• Flow support for components

• Due to unforseen issues with the original FirmWorks Geo package (namespace firmworks)—We have re-released FirmWorks Geo as “FirmWorks-Geo” with it’s own firmworksGeo namespace. The new package and the old package can be installed concurrently (although confusing as many things are named the same). The removal of the FirmWorks Geo package with the namespace “firmworks” is neccessary to use any other FirmWorks products.

• Support searching from geo coordinates – easily get coordinates from a provider like Google Maps and enter it into the address field – this bypasses API call outs to geocode the address. The accepted values – are valid decimal latitudes and decimal longitudes separated by a comma.
  • 32.80979973546311, -116.906332705415
  • 38.483378, -109.681333
  • 45.019120, -76.898557
  • 0.5, 0.5

• Added ability to limit results returned – helpful for areas where thousands of results causing performance degradation.

• Updated all metadata to v59.0
• Modified firmworks__Nearby_Setting__mdt from Package Protected to public
• Modified Permission Sets to include Custom Metadata
• Introduced Interop – Component Group Alias
  • Because the search, list and map components work via client side events – adding multiple components (via tabs or other layout) resulted in inconsistent behavior.
  • The design time configuration can be set with a unique arbitrary custom value so that the search/list/map and other components can subscribe to the same group that have the same setting.
• List component now can show a driving directions button which can be turned on/off in design – this feature opens a google.com directions screen for the first 23 addresses in the list component. The url can be subsequently shared to a phone for drive navigation.
• List component can now hide the download button
• Introduced contextId in search – If adding the search component to a record layout – a filter can be set to provide subsets
  • for example the search component can be added to an account layout, it can be configured to show a contacts map and list
  • Create a filter on the Contacts Mailing Configuration – Add ‘(AccountId = :contextId)’
  • From within the configuration for the search component on the account layout – set the default filter list and set the filter to the one you created

• Rebrand from “Nearby” to “FirmWorks Geo”

Enhancement

• Map component and List components can now be placed in tabs or other deferred rendering sections aiding with dynamic and smaller page layouts

Fixes

• Support for specifying parent relationships in configuration screen
• Minor fix for using Geo fields on a page layout

• FirmWorks Geo application supports:
  • Multiple ways to set searching from-
    • Built-in Geo Encoding using full address
    • Support for Google API key
    • Using device location
    • Record based from layout
  • List of results with ‘Download as CSV’ option
  • Graphical map showing multiple markers
• Extensible support for contextual record selection for custom LWC and Aura components