Skip to content

Setting up geocoding


Anindita Basu    Feedback

Geocoding is the process of converting an address expressed in human language to a latitude-longitude pair that can be shown on a map. You need geocoding so that addresses of leads, partners, and your team members can be shown on a map.

Why should geocoding matter?

If you don't have the exact coordinates of a person or a place, you can't pin them on a map. When they're pinned, you can also see which other lead or team member is nearby, get possible routes to that place, or give suggestions about the next course of action. See Planning your day's route to nearby leads and partners and Giving location-based suggestions to your team

Addresses in the Vymo app are geocoded automatically when you do these things:

  • When you pin a location on the map in the app. When you do that, the address is automatically converted into a geographical latitude-longitude pair.
  • When you upload a list of leads, where each lead has one or more address field. If the geocoding feature is enabled for that module, the lead's address is automatically converted into a geographical latitude-longitude pair.

Default behavior

Geocoding works on those fields in an attribute set that are designated as address fields. By default, the standard address fields are these:

  • Address line 1
  • Address line 2
  • City
  • State
  • Pin code

The process of geocoding an address to a specific location runs in the following sequence:

  1. Search for the location using all the standard address fields.
  2. If no match is found, remove one of the fields and search again.
  3. Repeat the previous step till a location is found. The fallback location is the postal code. With every step, the accuracy of the location decreases as the detected area grows into an ever-widening area.

Geocoding for standard address fields

For the standard address fields, geocoding is enabled by default. You don't need to do anything further if your lead attributes or partner attributes use only these fields for addresses.

Geocoding for custom address fields

If you create your own set of address fields, and want geocoding to work, use JSON. The default JSON array, which you can use a guide for creating your custom address fields, is at Example configuration.

Use the same fields during bulk upload

The custom address fields that you create must be the same as the fields that you use during bulk upload. Otherwise, the geocoding process won't be able to validate the data and convert them into location coordinates.

You can define the geocoding criteria for each one of your modules. Only those modules that have workflows (and states) can have geocoding. Things that you can configure are these:

  • The address fields (custom fields)
  • Which of these fields are mandatory
  • Which of the states in a workflow contain addresses that are to be geocoded (by default, geocoding works for the first state of a lead workflow)

Before you begin

You need the following information:

  • At least 1 address object
  • At least 1 field as an attribute for the address object
  • At least 1 of the fields in the address object as a mandatory attribute

Steps

  1. Go to Customize > Module Settings.
  2. Select the module for which to create the custom address fields.
  3. Scroll down to Advanced Settings and click JSON View.
  4. Locate the geoCodingConfig JSON array and specify the fields. For guidance, use Example configuration.
  5. When done, click Save. You see a message that the changes are now placed in a Draft condition.
  6. In the message box, click Go To Release Management so that you can move the changes permanently to the live configuration.
  7. Click Create a UAT release. Specify the release details and make sure to enter your own email ID because that's where you receive a one-time password (OTP) to continue with the process. Click Proceed.
  8. Enter the OTP you received in the email, and click Submit. Wait for a while till you see a confirmation message saying the process is complete.
  9. To see the changes, log out and log in again.

Results

After geocoding is enabled for the custom address fields, the next time that any address fields are uploaded, they're automatically converted to location coordinates. These addresses can then be placed on a map. The process of converting an address to a map location is asynchronous. This means that the conversion process doesn't happen simultaneously with the creation of a lead, partner, or user but only in the background, after the record is already created.

Example configuration

Use these examples to create custom address fields and enable them for geocoding. At a minimum, you need at least 1 address object, and at least 1 field as an attribute for the address. Also, you must designate at least 1 of the fields in the address object as a mandatory attribute.

The following JSON array shows a basic configuration, with one address (called gc_contact) that has 1 field as an attribute. To enable this field to be geocoded, specify gc_contact to be the field to use in the geocodingLocationMappings object.

  • Line 5: The address
  • Line 8: The address attribute
  • Line 26: The address to use as the default for geocoding
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "code": "geo_config",
  "deleted": false,
  "geoCodingLocations": {
    "gc_contact": {
      "code": "gc_contact",
      "deleted": false,
      "locationAttribute": "contact_location",
      "addressAttributes": [
        {
          "disabled": false,
          "attribute": "address"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "attribute": "address"
        }
      ],
    }
  },
  "geoCodingLocationMappings": [
    {
      "disabled": false,
      "geoCodingLocation": "gc_contact"
    }
  ],
  "defaultGeoCodingLocation": {
    "disabled": false,
    "geoCodingLocation": "gc_contact"
  },
  "stateMappings": null
}

The default configuration for geocoding is in the form of the following JSON array. It contains 6 addresses, each of which have the same set of fields (attributes) but with different values.

  • Line 5: The gc_secondary_location address
  • Line 91: The gc_office_location address
  • Line 177: The location address
  • Line 263: The gc_alternate_location address
  • Line 349: The gc_home_location address
  • Line 435: The gc_primary_location address
  • Lines 522 through 551: The priority for reckoning which address to pick for geocoding, because there's more than one address
  • Line 557: The default address to use for geocoding
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
{
  "code": "geo_config",
  "deleted": false,
  "geoCodingLocations": {
    "gc_secondary_location": {
      "code": "gc_secondary_location",
      "deleted": false,
      "locationAttribute": "secondary_location",
      "addressAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "secondary_address_line_1"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "secondary_address_line_2"
        },
        {
          "disabled": false,
          "order": 30,
          "attribute": "secondary_house_no"
        },
        {
          "disabled": false,
          "order": 40,
          "attribute": "secondary_building"
        },
        {
          "disabled": false,
          "order": 50,
          "attribute": "secondary_street"
        },
        {
          "disabled": false,
          "order": 60,
          "attribute": "secondary_area"
        },
        {
          "disabled": false,
          "order": 70,
          "attribute": "secondary_taluk"
        },
        {
          "disabled": false,
          "order": 80,
          "attribute": "secondary_city"
        },
        {
          "disabled": false,
          "order": 90,
          "attribute": "secondary_district"
        },
        {
          "disabled": false,
          "order": 100,
          "attribute": "secondary_state"
        },
        {
          "disabled": false,
          "order": 110,
          "attribute": "secondary_country"
        },
        {
          "disabled": false,
          "order": 120,
          "attribute": "secondary_pincode"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "secondary_pincode"
        }
      ],
      "latlngAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "secondary_latitude"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "secondary_longitude"
        }
      ]
    },
    "gc_office_location": {
      "code": "gc_office_location",
      "deleted": false,
      "locationAttribute": "office_location",
      "addressAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "office_address_line_1"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "office_address_line_2"
        },
        {
          "disabled": false,
          "order": 30,
          "attribute": "office_house_no"
        },
        {
          "disabled": false,
          "order": 40,
          "attribute": "office_building"
        },
        {
          "disabled": false,
          "order": 50,
          "attribute": "office_street"
        },
        {
          "disabled": false,
          "order": 60,
          "attribute": "office_area"
        },
        {
          "disabled": false,
          "order": 70,
          "attribute": "office_taluk"
        },
        {
          "disabled": false,
          "order": 80,
          "attribute": "office_city"
        },
        {
          "disabled": false,
          "order": 90,
          "attribute": "office_district"
        },
        {
          "disabled": false,
          "order": 100,
          "attribute": "office_state"
        },
        {
          "disabled": false,
          "order": 110,
          "attribute": "office_country"
        },
        {
          "disabled": false,
          "order": 120,
          "attribute": "office_pincode"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "office_pincode"
        }
      ],
      "latlngAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "office_latitude"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "office_longitude"
        }
      ]
    },
    "gc_location": {
      "code": "gc_location",
      "deleted": false,
      "locationAttribute": "location",
      "addressAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "address_line_1"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "address_line_2"
        },
        {
          "disabled": false,
          "order": 30,
          "attribute": "house_no"
        },
        {
          "disabled": false,
          "order": 40,
          "attribute": "building"
        },
        {
          "disabled": false,
          "order": 50,
          "attribute": "street"
        },
        {
          "disabled": false,
          "order": 60,
          "attribute": "area"
        },
        {
          "disabled": false,
          "order": 70,
          "attribute": "taluk"
        },
        {
          "disabled": false,
          "order": 80,
          "attribute": "city"
        },
        {
          "disabled": false,
          "order": 90,
          "attribute": "district"
        },
        {
          "disabled": false,
          "order": 100,
          "attribute": "state"
        },
        {
          "disabled": false,
          "order": 110,
          "attribute": "country"
        },
        {
          "disabled": false,
          "order": 120,
          "attribute": "pincode"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "pincode"
        }
      ],
      "latlngAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "latitude"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "longitude"
        }
      ]
    },
    "gc_alternate_location": {
      "code": "gc_alternate_location",
      "deleted": false,
      "locationAttribute": "alternate_location",
      "addressAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "alternate_address_line_1"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "alternate_address_line_2"
        },
        {
          "disabled": false,
          "order": 30,
          "attribute": "alternate_house_no"
        },
        {
          "disabled": false,
          "order": 40,
          "attribute": "alternate_building"
        },
        {
          "disabled": false,
          "order": 50,
          "attribute": "alternate_street"
        },
        {
          "disabled": false,
          "order": 60,
          "attribute": "alternate_area"
        },
        {
          "disabled": false,
          "order": 70,
          "attribute": "alternate_taluk"
        },
        {
          "disabled": false,
          "order": 80,
          "attribute": "alternate_city"
        },
        {
          "disabled": false,
          "order": 90,
          "attribute": "alternate_district"
        },
        {
          "disabled": false,
          "order": 100,
          "attribute": "alternate_state"
        },
        {
          "disabled": false,
          "order": 110,
          "attribute": "alternate_country"
        },
        {
          "disabled": false,
          "order": 120,
          "attribute": "alternate_pincode"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "alternate_pincode"
        }
      ],
      "latlngAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "alternate_latitude"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "alternate_longitude"
        }
      ]
    },
    "gc_home_location": {
      "code": "gc_home_location",
      "deleted": false,
      "locationAttribute": "home_location",
      "addressAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "home_address_line_1"
       },
        {
          "disabled": false,
          "order": 20,
          "attribute": "home_address_line_2"
        },
        {
          "disabled": false,
          "order": 30,
          "attribute": "home_house_no"
        },
        {
          "disabled": false,
          "order": 40,
          "attribute": "home_building"
        },
        {
          "disabled": false,
          "order": 50,
          "attribute": "home_street"
        },
        {
          "disabled": false,
          "order": 60,
          "attribute": "home_area"
        },
        {
          "disabled": false,
          "order": 70,
          "attribute": "home_taluk"
        },
        {
          "disabled": false,
          "order": 80,
          "attribute": "home_city"
        },
        {
          "disabled": false,
          "order": 90,
          "attribute": "home_district"
        },
        {
          "disabled": false,
          "order": 100,
          "attribute": "home_state"
        },
        {
          "disabled": false,
          "order": 110,
          "attribute": "home_city"
        },
        {
          "disabled": false,
          "order": 120,
          "attribute": "home_pincode"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "home_pincode"
        }
      ],
      "latlngAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "home_latitude"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "home_longitude"
        }
      ]
    },
    "gc_primary_location": {
      "code": "gc_primary_location",
      "deleted": false,
      "locationAttribute": "primary_location",
      "addressAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "primary_address_line_1"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "primary_address_line_2"
        },
        {
          "disabled": false,
          "order": 30,
          "attribute": "primary_house_no"
        },
        {
          "disabled": false,
          "order": 40,
          "attribute": "primary_building"
        },
        {
          "disabled": false,
          "order": 50,
          "attribute": "primary_street"
        },
        {
          "disabled": false,
          "order": 60,
          "attribute": "primary_area"
        },
        {
          "disabled": false,
          "order": 70,
          "attribute": "primary_taluk"
        },
        {
          "disabled": false,
          "order": 80,
          "attribute": "primary_city"
        },
        {
          "disabled": false,
          "order": 90,
          "attribute": "primary_district"
        },
        {
          "disabled": false,
          "order": 100,
          "attribute": "primary_state"
        },
        {
          "disabled": false,
          "order": 110,
          "attribute": "primary_country"
        },
        {
          "disabled": false,
          "order": 120,
          "attribute": "primary_pincode"
        }
      ],
      "mandatoryAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "primary_pincode"
        }
      ],
      "latlngAttributes": [
        {
          "disabled": false,
          "order": 10,
          "attribute": "primary_latitude"
        },
        {
          "disabled": false,
          "order": 20,
          "attribute": "primary_longitude"
        }
      ]
    }
  },
  "geoCodingLocationMappings": [
    {
      "disabled": false,
      "order": 10,
      "geoCodingLocation": "gc_location"
    },
    {
      "disabled": false,
      "order": 20,
      "geoCodingLocation": "gc_alternate_location"
    },
    {
      "disabled": false,
      "order": 30,
      "geoCodingLocation": "gc_primary_location"
    },
    {
      "disabled": false,
      "order": 40,
      "geoCodingLocation": "gc_secondary_location"
    },
    {
      "disabled": false,
      "order": 50,
      "geoCodingLocation": "gc_home_location"
    },
    {
      "disabled": false,
      "order": 60,
      "geoCodingLocation": "gc_office_location"
    }
  ],
  "defaultGeoCodingLocation": {
    "disabled": false,
    "order": 10,
    "geoCodingLocation": "gc_location"
  },
  "stateMappings": null
}

See also


Did this page help? No help at allYes, totally!
Back to top