Knowledge Base - Main documentation


Step 1 - How to create a new Map

The first operation is to obtain a APIkey from Google. You can find more information about this key and obtain it on this page of the google maps api. You need to create a 'Javascript Google maps Api Key'. Once you have your APIkey, simply open the Geocode Factory 'Component configuration' from the control panel, and enter your APIkey in the Google Apikey input.

From th Geocode Factory control panel click on "Create a New Map" or you can go to "Maps Manager" and click on "New" to create a new map.

You'll see the following:

Minimal settings

For the map to work you will need to complete a minimum amount of fields. All mandatory fields are marked by an asterisk (*), but some already have a default value assigned. You will have to give a value to at least the following fields:

On the "Basic Map Settings" tab:
  • Map name: to identify the map, this will not appear in frontend (ex:My Map), this name is used in plugins, markersets, module to identify the map to be displayed.
  • Default center point: This is the pair of coordinates, that will represent the default center of the map. You can enter the coordinate values manually in their proper fields. Or you can simply click on "Load Map" and then select a point on the map that appears or enter an address and click the search button. Select a point by moving the map marker to the desired location using the map controls (zoon in/out) if needed. The coordinate field will then automatically be populated.


On the "Template" tab:
  • Template: by default, Geocode Factory will display a blank page. By using the template system, you will need to define where and what you want to display. The minimal needed setting here is to integrate at least the map placeholder {map} (see the templating article for more details). To do this click the “select” button to bring up the placeholders generator and then click on “{map}” button.

template placeholder selection

Remember that you can use html in the template. Have a look at the sample which is provided under the tab “Sample template”.

You can also use the "Auto-Template" option, by setting it to "Yes". This is the first option found on the "Map Controls" tab of the Map Manager.

Optional settings:

Optionally you may want to configure the various optional map settings available. For each of these options, placing your mouse cursor on the item name will reveal a pop-up explanation of what the field is and/or how to use it.

After you set the minimal and the optional settings, save your new map.


What is it

Geocode Factory 5 introduces a new concept named assignment “pattern". A “pattern” defines the relationship between Geocode Factory version and the data to be used from each of the third party extension (Joomla content, Sobipro, Jomsocial, etc). In other words, a pattern will determine which fields of the selected 3rd party extension will be used by GF 5 for the task of “geocoding”.

Specifically, you can create a pattern and select which 3rd party extension fields will be used for determining the address (city, postcode, street, country, etc), and in some cases, which will be used for the coordinates.  Both address and coordinate fields will then be used by Geocode Factory 5 for geocoding the items you wish to place on maps.

You can create multiples patterns for each application. For example you can create a pattern for a primary address and an additional pattern for a secondary address. Depending on the third party extension, you may also use multiple coordinates fields (like in CB).

Applies To

Geocode Factory 5