Knowledge Base - Tutorial : Radius Search Application

Configuration

There is some options you need to configure :

sobipro_radius_search_008

  • Order ID: please enter here your order number, this will register the plugin. Plugin will not function without this.
  • Enable: this option will enable or disable the plugin in the search form.
  • Radius field label: Allows admin to enter custom label for field
  • Unit to use: Defines the unit to be used for the radius calculation. You can use kilometers (km), miles (mi) or nautical miles (nm).
  • List of distances: Enter the list of distances you want to appear in the front-end search form in the drop-down box, separated by commas. Example : “10,20,50,100” (without the quotes) will display in the front-end a list of these 4 distances. If no valid entry is provided by the user in the search form, a default value is used witch corresponds to the first number in this list.
  • Calculate Distance For VCards: enables the background calculation for determining distance from start point of search. Only needed if you display distance on vcards so it can be disabled to save resources if not needed.
  • Order Results By Distance: Option to sort vcards by increasing distance when doing a search.
  • Google Logo: options for displaying Google logo on search form. It is required by the Google terms of use so use at your own risk. Note since last google API the logo come automatically in the list (*see note 2).
  • Input Width (optional): This is an optional parameter that allows the user to specify the width of the starting point input box. it also controls the width of the dropdown box that opens for the autosuggestions.
  • Use “Locate Me” Button: enables the option on the search form to locate users based on their browser location. It can be off, text or an icon. Works with mobile devices as well. *see note 1.
  • Number style in vCard: Here you can define how to display distances in vCards and lists, for example : 1000,00 or 1,000.00 or 1 000.0 or 1'000 or ...
  • Locate me on page load: Populate the center point with the current user's (browser) position on page load or leave empty (*see note 1).
  • Geocode mode: There 2 main methods of geocoding the center point of the search radius: 
    • The Autocomplete (preferred) consists of a list of predictions that populate below the search box as you type. If you type "Par" the predictions are Paris, France, ... The preferred choice can be made using the mouse or by using the arrows to select the desired option. With this method you have many settings in the next section of the admin page and are described here:
      • Limit search by area : This option allows the user to limit the search in a certain geographical area. This area is defined with 2 points. See this article.
      • Inputbox text : By default the input box contains a light text "Enter a location...". This text is localised (translated) based on the user's browser. You can customize it by entering what you want, enter a space to have no text, or leave empty for default text.
      • Country : You can enter a ISO 3166-1 Alpha-2 country code. Like fr for france, it for italy, de for germany. This will limit the autocomplete suggestions to locations ONLY within the specified country. (currently only one country code is allowed at a time)
      • Google Map variable : This optional setting allow you to link a google map with the current center point geocode. Then the location they are visible on the map will be predicated in priority. You can use any google map or use the Geocode Factory Sobi2 search map. Here you need to display the search page HTML code in your browser and locate the variable name used to define the map (usualy is map). In Geocode Factory, simply activate the debug mode to see the map name!
    • During input method is "on the fly" (durring input), and geocoding the user entry when the focus quit the input box. It can take several seconds (from 0.01 to 2 secs ... during this time the search button is hide), but the user can enter what he want. When the user clicks the Sobipro search button the search will return entries in the defined radius.
    • Hybrid method is the mix of the 2 previous methods. If the user type 3 letters of New York, and select the New York, NY item of the list, this value is used. Otherwise, if the user the user dont select one proposed value of the list, then the addresse is geocoded from the input.
  • Default Center: this is an optional setting that will override the Geocode Factory map settings on the search page and allow you to specify a default starting point for the search input field centerpoint on page load. You can of course manually enter any point you want after that to run a different search as well. This setting will ALSO center the displayed map on that entered, default location. this of course will also change if you alter the search parameters.
  • Sales area field: define the Sobipro custom field you want to use for the entry radius. See bellow to understand of the sales area concept work. 

    Sales area display mode : define the format to display the distance on the vCards for the search result list. If the distance from center is in the radius, then the distance is displayed (depending the formatting settings) like 8,5km. But if the entry is in results because the sales area radius is intersecting the radius search, you can select if you want to display the real distance (can be higher regarding the radius search), the radius distance (maximum value) like 5km, even if entry is at 8,5, or the maximum and the difference : 5km + 3,5km.

  • Exclusion field and filter:To select a range of records that will appear even if they are not within the searched radius, select a field to test, and parameters to test it with. Please note that this field must be set up already, and it can be a single input box, a select box or even a multi-select box or checkbox group. There are a number of conditions that you can test for:
    • A set value – to do so, enter an equals sign, followed by the value in single quotes (eg: =’featured’)
    • Greater than or less than a given value – to do so, enter a greater than or less than sign, followed by a number, without quotes (eg: >400)
    Note for the Geocode Factory users only - entries selected by the exclusion field cannot be displayed on the map if they are not also within the radius. This is a limitation of Geocode Factory. To display them, you need to create a separate markerset in Geocode Factory.
  • Geo-Exclusion field and value:To select a range of “nearby results” - which are within the same area (country, state, locality, etc.) as a radius search, without actually being within the bounds of the search - select a field to test, and a Google geocode value to match it with. There are a number of different fields that Google produces:
    • “Locality – Long” and “Locality – Short” (eg: “Miami”)
    • “Administrative Level 1 – Long” (eg: “Florida”)
    • “Administrative Level 1 – Short” (eg: “FL”)
    • “Administrative Level 2 – Long” (eg: “Miami-Dade”)
    • “Administrative Level 2 – Short” (eg: “Miami-Dade”)
    • “Country – Long” (eg: “US”)
    • “Country – Short” (eg: “United States”)

Applies To

Sobipro Radius Search - Application