Home  >   Articles   >  Configuration - Maps
Articles in this section

Configuration - Maps

This article will guide you through using Maps in Vtiger CRM, configuring Google Maps, and a lot more. Start reading...
Rashmi Kashyap
21 May, 2021 - Updated 8 months ago
Table of Contents


Maps in Vtiger CRM is available in both Vtiger 360 and Vtiger CRM mobile applications.

Using the built-in Maps feature, you can perform the following map-related actions:

  • View leads’, contacts’, or organizations’ addresses on the map.
  • Search for an address by typing the business name on the map.
  • Update the address or event location.
  • Route mapping to the event location (for onsite events). 
  • Navigate and check-in for onsite events.

Working of Maps

The Maps feature in Vtiger CRM might look tricky, but you will realize that it is a simple process once you understand it. So let us start from scratch.

Firstly, you need to know what Maps can do. Vtiger CRM provides the following map-related features:

  • Search for an address from the map view in the app.
  • View nearby Leads, Contacts, and Organizations in the app.
  • Navigate to their location.
  • Schedule your day based on route mapping.
  • Do a check-in with geofencing for onsite meetings. 

Did you know?

Geofencing is a technique where you can create a virtual geographic boundary, enabling the app to respond when a mobile device enters or leaves a particular area.


Secondly, to deliver these features, Vtiger converts the street address in Lead, Contact, or Organization records to latitude and longitude values. This process is referred to as Geocoding. Through geocoding, Maps will take you to your preferred location. With the help of route mapping, you can find the shortest route to cover all your meetings in a day.



  • Addresses must be valid to get a latitude or longitude value.
    • They should have UTF-8 characters only.
    • They should have a known location.
  • You can go to the lead, contact, or organization record in Maps, and the Navigate button in the record will take you directly to the location. The address in the record is automatically converted to the latitude and longitude values. 
  • You can also update the lead, contact, or organization address on the map directly and go to the location.

Accessing Maps Settings in the CRM

Follow these steps to view Maps settings in the CRM:

  1. Log in to your CRM account.
  2. Click the User Menu on the top right corner of the screen.
  3. Select Settings.
  4. Go to Configuration.
  5. Click Maps.

In the Maps settings, Vtiger CRM offers the following services:

  • Maps Service - used to convert the address in a record to latitude and longitude values (geocoding) and perform reverse geocoding.
  • Route service - used to calculate the shortest route between different meeting locations in a day.

Setting up Maps in the CRM

You can set up Maps in your CRM account only if you are an administrator.

Maps Service

The Maps Service is required for geocoding. It supports two location services that enable you to reach your destination smoothly. They are: 

  1. OpenStreetMap - It is used to search for addresses and get the geocode of an address to store in the database (The geocode shows nearby contacts from any given Lead, Contact, or Organization record). This is a free service and is selected by default in the CRM.
  2. Google Maps - It performs the same tasks as OpenStreetMap but is more accurate. To enable the Google Maps service, you must activate Geocoding API, Maps JavaScript API, and Places API in the Google Cloud Console, copy the API key and paste it in the Google API Key field. Refer to this section for more information.

Note: Limits for Geocoding are:

  • OpenStreetMap - 10,000 addresses per day.
  • Google Maps - Up to 40,000 addresses per month for free. You get $200 per month free credit. Any usage over that will be chargeable. To know more about Google Maps’ pricing, click here.

Route Service

You must set up Route service for route mapping.

The Route service supports two location services that will help you find the nearby clients and calculate the shortest route between two or more meeting locations. They are:

  1. OpenRouteService - This service is selected by default in the CRM. To use this service, you must generate an API key by going to this link. Once you have the API key, copy and paste it to the OpenRouteService API Key field. You are allowed to use only 500 requests per day.
  2. Google - To use this service, you must activate Directions API in the Google Cloud Console, copy the API key and paste it in the Google API Key field. Refer to this section for more information.

To know more about using Maps in the mobile app, click here.


Note: When you switch between maps’ services from the Settings page, the records that failed to geocode using the previous map service are retrieved with the newly selected map service.

Configuring Google APIs

If you want better search results and accurate addresses of your contacts, you can switch to Google Maps. Before activating Google Maps, you have to first register for a Google Maps API key. 

Follow these steps to get the API key:

Step 1: Logging into Google API

  1. Click here to go to the Google APIs dashboard.
  2. Sign in using your Google account.
  3. Agree to all the terms and conditions.

You are logged in to your Google Cloud Platform.

To enable Google APIs, you must select an existing project or create a new project.

Step 2: Creating a Project

  1. Click the Create Project button on the dashboard.
  2. Enter the Project name, Organization name, and location of the organization.
  3. Click the Create button.

A new project is created.

Step 3: Enabling Google APIs

  1. Click the Navigation Menu icon on the top left corner of the screen.
  2. Select the APIs & Services option.
  3. Click the +ENABLE APIS AND SERVICES button on the dashboard.
  4. Search for Geocoding API.
  5. Click Geocoding API.
  6. Click the ENABLE button.
  7. Follow steps 10, 11, and 12 to enable the other three APIs - Maps JavaScript API, Places API, and Directions API.

Step 4: Creating the Credentials

  1. Click the Navigation Menu icon on the top left corner of the screen.
  2. Select the APIs & Services option.
  3. Click Credentials in the left menu.
  4. Click the +CREATE CREDENTIALS button. You need credentials to use the API.
  5. Click the API key option.
  6. A pop-up saying ‘API key created’ will be displayed.
  7. Click the Copy icon beside the API key and copy it.
  8. Click RESTRICT KEY to prevent unauthorized use of your key.
    • Click CLOSE to finish the configuration.
  9. Select the APIs in the dropdown that you have enabled in Step 3.
  10. Click Save.

You must enter the API Key details in Vtiger CRM’s Maps settings to finish the configuration.

Generating Geocoding Reports

Did you know you can view geocoding reports for the Leads, Contacts, Organizations, and Events modules?

Yes, Vtiger CRM provides you an option to do so. You can either enable report delivery or check the reports in Maps settings to generate reports.


Note: You can enter the frequency of generating a report in the Send GeoCode Report field. It can be Do Not Send, Daily, Every Monday, or First Day of the Month.


Follow these steps to view the reports in Vtiger CRM:

  1. Log in to your CRM account.
  2. Click the User Menu on the top right corner of the screen.
  3. Click the Settings button.
  4. Go to the Configuration section.
  5. Click Maps.
  6. Click the View Geocoding Report button. The reports of Contacts, Organizations, Leads and Events are displayed.
  7. Click the Hamburger icon to print the report or save it as an image.

Was this article helpful?
0  out of  0  found this helpful.
Comments 0
Be the first to comment
© Copyright 2022 Vtiger. All rights reserved.