Gisgraphy configuration

Import Data

To import data, you must use the admin interface. See the admin interface section for more information

Debug Mode

Each Gisgraphy service is a servlet. Each servlet can be run in debug mode. It enables the error message (exception message) to be output to the end user. To do so, just declare the servlet init parameter "debugMode" to true (in the web.xml) as shown :


<servlet>
		<servlet-name>address parser service</servlet-name>
		<servlet-class>
			com.gisgraphy.servlet.AddressParserServlet
		</servlet-class>
		 <init-param>
		 <!-- if true the output field error will contains the exception message.
			 Default to false -->
			<param-name>debugMode</param-name>
			<param-value>true</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>

<servlet>
		<servlet-name>geocoding service</servlet-name>
		<servlet-class>
			com.gisgraphy.servlet.GeocodingServlet
		</servlet-class>
		 <init-param>
		 <!-- if true the output field error will contains the exception message.
			 Default to false -->
			<param-name>debugMode</param-name>
			<param-value>true</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
</servlet>


<servlet>
		<servlet-name>street service</servlet-name>
		<servlet-class>
			com.gisgraphy.servlet.StreetServlet
		</servlet-class>
		 <init-param>
		 <!-- if true the output field error will contains the exception message.
			 Default to false -->
			<param-name>debugMode</param-name>
			<param-value>true</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>


<servlet>
		<servlet-name>geoloc service</servlet-name>
		<servlet-class>
			com.gisgraphy.servlet.GeolocServlet
		</servlet-class>
		 <init-param>
		 <!-- if true the output field error will contains the exception message.
			 Default to false -->
			<param-name>debugMode</param-name>
			<param-value>true</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
</servlet>
	
	
<servlet>
		<servlet-name>fulltext service</servlet-name>
		<servlet-class>
			com.gisgraphy.servlet.FulltextServlet
		</servlet-class>
		<init-param>
		 <!-- if true the output field error will contains the exception message.
			 Default to false -->
			<param-name>debugMode</param-name>
			<param-value>true</param-value>
		</init-param>
		<load-on-startup>2</load-on-startup>
</servlet>

Options and environment-specific settings

All the options and environment-specific settings are located in the env.properties file. The env.properties is located in the /webapps/ROOTWEB-INF/classes directory

Take care of white spaces in properties file : MyProperties=bar is not the same as MyProperties= bar (whitespaces after the equals sign are taken into account)

importer.geonames.dir

This option determines the directory where the GeoNames files are located. It must end with / or \ according to the operating system path separator. It is also the directory where the GeoNames files will be downloaded from the importer.geonames.downloadURL URL . On Windows, the '\' character must be escaped as in the example below. The path can be absolute or relative (from the directory where you've launch Gisgraphy). It is not recommended to put space in the path.
. This option is case sensitive if the underlying file system is case sensitive (e.g : Linux / Unix).

Examples on Linux :
importer.geonames.dir=./data/prod/
importer.geonames.dir=/home/user/data/prod/

Example on Windows
importer.geonames.dir=.\\data\\prod\\

importer.openstreetmap.dir

This option determines the directory where the OpenStreetMap files are located. It must end with / or \ according to the operating system path separator. It is also the directory where the OpenStreetMap files will be downloaded from the importer.openstreetmap.downloadURL URL . On Windows The '\' character must be escaped as in the example below. The path can be absolute or relative (from the directory where you've launch Gisgraphy). It is not recommended to put space in the path.
. This option is case sensitive if the underlying file system is case sensitive (e.g : Linux / Unix).

Examples on Linux :
importer.openstreetmap.dir=./data/prod/
importer.openstreetmap.dir=/home/user/data/prod/

Example on Windows
importer.openstreetmap.dir=.\\data\\prod\\

importer.geonames.zipcode.dir

This option determines the directory where the GeoNames zipcode files are located. It must end with / or \ according to the operating system path separator. It is also the directory where the GeoNames zipcode files will be downloaded from the importer.geonames.zip.downloadURL URL . On Windows The '\' character must be escaped as in the example below . The path can be absolute or relative (from the directory where you've launch Gisgraphy). It is not recommended to put space in the path.
. This option is case sensitive if the underlying file system is case sensitive (e.g : Linux / Unix).

Examples on Linux :
mporter.geonames.zipcode.dir=./data/prod/
mporter.geonames.zipcode.dir=/home/user/data/prod/

Example on Windows
mporter.geonames.zipcode.dir=.\\data\\prod\\

importer.geonames.enabled

Whether the importers related to GeoNames will be processed (it enable the zipcode importer too). If 'true' the importers will be executed. This option should be in lower case.

Examples :
importer.geonames.enabled=true
importer.geonames.enabled=false

importer.openstreetmap.enabled

Whether the importers related to OpenStreetMap will be processed. If 'true' the importers will be executed. This option should be in lower case.

Examples :
importer.openstreetmap.enabled=true
importer.openstreetmap.enabled=false

importer.openstreetmap.housenumber.enabled

Whether the importers related to house numbers OpenStreetMap will be processed. If 'true' the importers will be executed. This option should be in lower case.

Examples :
importer.openstreetmap.housenumber.enabled=true
importer.openstreetmap.housenumber.enabled=false

importer.quattroshapes.enabled

Whether the importers related to Quattroshapes will be processed. If 'true' the importers will be executed. This option should be in lower case.

Examples :
importer.quattroshapes.enabled=true
importer.quattroshapes.enabled=false

importerConfig.openstreetmap.fill.isin.field

Whether we search for the nearest city in GeoNames data to fill the is_in field. This will increase the run time of the importer but strongly increases the relevance of the geocoder. Default to true. This option should be in lower case.

Examples :
importerConfig.openstreetmap.fill.isin.field=true
importerConfig.openstreetmap.fill.isin.field=false

DON'T MODIFY this option after importer is done.

importer.geonames.downloadURL

This option determines the URL of the server to download the GeoNames files to be processed (typically, the GeoNames download server). This option is case sensitive.

Example :
importer.geonames.downloadURL=http://download.geonames.org/export/dump/