Zephr User Guide

GeoSync

5 views 0

The Zephr GeoSync Extension maps detected values from Zephr’s Geo IP database to nominated User Attributes when a new authenticated session is created for a user – typically on registration or sign in.

The extension currently supports mapping State and Country values.

Pre-Requisites

You must have a Zephr User Attribute schema with text fields where you wish to store the State and/or Country information.

Behaviour

After a new, authenticated session has been created for a user, the extension will map values found by dereferencing the user’s IP against Zephr’s Geo IP database to chosen schema fields.

There is a toggle for each field to specify whether the extension will always overwrite any existing value, or whether it will only populate the field if it was previously unpopulated.

NOTE: whilst Zephr endeavours to regularly update the Geo IP database it uses, such databases are never 100% accurate. Furthermore, this extension cannot detect a user’s real location, should that user be using a technology such as a VPN or other means to change their IP.

Configuring the GeoSync Extension

To enable the GeoSync Extension within Zephr, navigate to Settings > Extensions > GeoSync. If you cannot see the GeoSync option in your list of Extensions, email support@zephr.com.

Once on the configuration screen, you’ll see two sections – Choose User Attributes to Sync and Activate Plugin.

Choose User Attributes To Sync

The Choose User Attributes To Sync section allows you to specify the User Attribute you would like GeoIP data to be mapped to for Country and State Information.

This will need to be in line with the User Attributes you have created under Identity > User Attributes.

Once added, specify if you would like the field to be overwritten when new data is available by checking the ‘Should existing data in the above User Attribute for [x] be overwritten?’ box.

Once complete, click Done.

Activate Plugin

Once you’ve input the relevant details, you will need to confirm which of your Sites the extension should be active on. To do this, use the toggles for each site under the Activate Plugin section, or choose Select All Sites.

Plugin Activation

Once completed, click Save. Your plugin is now enabled.

Notes

When deciding whether fields should be overwritten, or existing values left in place, please consider whether your audience will typically access your site from similar locations, or whether they will often access from different locations around the world.

For most use cases, it is not recommended to have differing overwrite settings for mapped location fields: this is as a risk could arise of mismatched geographic locations stored against your user.

For example, if the state field was set to only be populated if previously blank, but the country field is always to be overwritten a user could end up with a state attribute that does not represent a state contained within the current value of their country field.