LocateXL Server

Top 

TRANSPARENT NEW LOGO

 

LocateXL Server

 

LocateXL Server is a standalone web service providing REST and SOAP Geocoding and Reverse Geocoding endpoints.

 

 

 

You would use it for the following reasons:

 

1.Needing to programmatically validate addresses from any system supporting web API.

 

 

2.Programmatically getting addresses of GPS locations.

 

 

3.Bulk Geocoding and Reverse Geocoding.

 

 

 

 

 

 

Installation

 

Double click SetupPrimeThought.Spatial.LocateIQ.WinService.exe and follow the LocateXL Server Setup Wizard.

 

LOCATE~1_img2

 

To install the Geocode Data, double click on SAData.exe (which is South Africa, or the appropriate country Geocode Data that you received.)

 

LOCATE~1_img3

 

In the window that comes up, click on Browse, and select LocateXL Server as the destination folder.

 

Click OK.

 

LOCATE~1_img4

 

 

The correct path is then inserted into the Destination folder field.

 

LOCATE~1_img5

 

 

Click Extract.

 

 

LOCATE~1_img6

 

 

 

The Data folder has been extracted here.

 

 

 

You will receive a license that looks like this with your applicable data.

 

LOCATE~1_img7

PTSS in the example license above is the company name.

 

LocateIQ is the product.

 

Desktop is the edition.

 

100000 is the maximum number of items that can be Bulk or Reverse Geocoded at a time.

 

wayne is the computer name.

 

20201231 is when the license will expire.

 

Move this license to the correct location (You will need administrator permission to do this):

 

LOCATE~1_img8

 

Ensure that you have File name extensions checked on in your File Explorer to avoid confusion for the next step.

 

 

LOCATE~1_img9

Make sure that this LIC File is selected. Then click once on it to edit the name. Change it to PrimeThought.Spatial.Locator.lic (You will need administrator permission to change the name.)

 

LOCATE~1_img10

 

 

 

Configuration

 

To configure the endpoint for REST, double click PrimeThought.Spatial.LocateIQ.WinService.exe.config

 

 

LOCATE~1_img11

 

 

Change localhost as needed. (You will need administrator permission to save any changes.)

 

LOCATE~1_img12

 

To configure Windows Service, open the Services application. Go to PrimeThought LocateIQ Address Service.

 

LOCATE~1_img13

Double click on it. This service may have automatically started. To ensure the license is loaded correctly for this service, click Stop, and then click Start to start the service again.

 

 

LOCATE~1_img14

 

 

 

Click OK.

 

 

 

Open the Event Viewer application to see PrimeThoughtLocateIQAddressService.

 

 

LOCATE~1_img15

 

 

If you double click on it, you will see that the service has started successfully.

 

 

LOCATE~1_img16

 

 

 

Testing and Output

 

Open your internet browser and type in the following URL to test the Geocode:

 

http://localhost:59602/LocateWeb/geocode?address=203%20gosforth%20crescent%20Kyalami

 

Note: In the CONFIG File noted above, if you changed localhost to another name, you need to put that name in place of localhost in this URL.

 

 

LOCATE~1_img17

The output by default is in JSON format. The Accept Headers can be adjusted if XML is wanted as output.

(“Status

N = Number

S = Street

P = Place

L = Locale

R = Province

C = Postal Code) These are further explained in the section below Adjusting Settings.)

 

 

The 7 best matches are listed here.

 

 

In your Event Viewer application, you can look at this specific event.

 

LOCATE~1_img18

 

200 matches were found as you can see, however the 7 best were only displayed.

 

Open your internet browser and type in the following URL to test the Reverse Geocode:

 

 

http://localhost:59602/LocateWeb/reversegeocode?x=28.0807939&y=-25.989989

 

 

Note: In the CONFIG File noted above, if you changed localhost to another name, you need to put that name in place of localhost in this URL.

 

LOCATE~1_img19

 

 

In your Event Viewer application, you can look at this specific event.

 

LOCATE~1_img20

 

 

 

 

 

Adjusting Settings

 

You can have alias settings which will increase the accuracy of your output.

 

Go to the following location of your Geocode Data and open AliasMaps.csv.

 

LOCATE~1_img21

 

 

LOCATE~1_img22

 

Type in any applicable aliases and names.

 

LOCATE~1_img23

Save your changes.

 

To adjust further settings for your Geocoding, open the Settings.xml file.

 

LOCATE~1_img24

 

 

LOCATE~1_img25

 

The part used in the Geocode Data by default is Street.

 

The various Weight settings set up in the XML file above is the default and is suggested. They can be adjusted as needed.

 

Place refers to Suburb.

 

Locale refers to Town.

 

Code refers to postal codes.

 

MnType refers to Local municipality type as published in the 2011 StatsSA spatial data release. (This field is just returned when geocoding and is not an actual weight to adjust.)

 

Primary refers to Area based primary land use per EA. (This field is just returned when geocoding and is not an actual weight to adjust.)

 

GtiType is another classification type for example Metro Urban, Non-Metro Urban, etc. (This field is just returned when geocoding and is not an actual weight to adjust.)

 

The rest of the fields are self-explanatory.

 

Save your settings when you are done.

 

 

Go to the following location to adjust the maximum number of records that have a match when Geocoding, and the maximum number of records that match that are outputted on the web.

 

Open the PrimeThought.Spatial.LocateIQ.WinService.exe.config file to adjust these settings.

 

LOCATE~1_img26

 

 

LOCATE~1_img27

 

 

The MaxRecords by default is 200. The MaxWebRecords by default is 10. This can be changed and saved.

 

This URL was used for testing and output XML:

 

 

http://localhost:59602/LocateWeb/geocode?address=203%20gosforth%20crescent%20Kyalami

 

 

For a structured Geocode and more accurate output, you would type in this same URL address like this:

 

http://localhost:59602/LocateWeb/geocode?address=Number:203 Street:Gosforth Place:Kyalami

 

Note: The address field name and structure when typing out the URL address, for example ‘Number:’ must be the same as noted in the Settings.xml above.

 

 

 

 

 

Support


 

T: +27871354351

M: +27712415852 or +27742978424

support@primethought.biz - primethought.biz

203 Gosforth Crescent, Kyalami Estate, Midrand, Johannesburg, 1684, South Africa

 LOCATE~1_img29LOCATE~1_img30LOCATE~1_img31