Geographic Data

Installing Geographic Data

ServicePlanner will only work for countries where appropriate geographic data has been installed. Customers will be supplied with an installer for each geographic dataset that they have licensed.

To install each geographic data set, simply run the installer and click Next on every window.

Each geographic dataset is installed in its own directory, under the ServicePlanner\data directory, with a sub-directory called properties that will contain two files:

• <geo>.properties (e.g. uk.properties for the UK) which configures this geography for use by ServicePlanner. It should not be edited.
• <geo>.mdf (e.g. uk.mdf for the UK), which is a "Map Definition Format" file.

FRU-Geography Mapping

ServicePlanner needs geographic data in order to create map images. Customers that operate in multiple countries may require multiple geographic datasets. In this case ServicePlanner needs to know which FRUs are associated with which geographic dataset. Customers that have only one geographic dataset will not need to provide an FRU-geography mapping.

To configure the FRU-geography mapping, edit the service_planner.properties file, which is located in the sm_properties folder of the ServiceManager installation directory:

# map.data.<geo>.fru - comma-separated list of responsibility unit refs for all
# the FRUs whose regions lie in the geography <geo>. <geo> is the name of
# the sub-directory of the geographic data under the directory map.data.root 
map.data.canada.fru=WPEG,QBEC
map.data.ndl.fru=NL-1,NL-2 
map.data.uk.fru=ENG,SCOT,WAL,NIRL
map.data.us_cbg.fru=CAL,WASH,ORI,NYK

Other Configurable Properties

There are a number of properties in the service_planner.properties file that can be changed to configure ServicePlanner's functionality. These are given below with a description as given in the properties file:

# layer.unit is the linear unit used for mapping. Can be mile, miles, km, kms.
layer.unit=mile
# jobdensity.days - the number of days that planner will by default look over
# when collating jobs to plot the density of.
jobdensity.days=14 
# download.image.width, download.image.height is the width and height of the map
# image when planner is asked to create a printable map
download.image.width=2378
download.image.height=1682 
# map.scale.default - the default minimum width/height of the map when trying
# to map a single location. The map can subsequently be re-scaled to higher
# and lower magnifications.
map.scale.default=5 
# map.shade - semi-colon list of rgb colours that are used by planner to shade
# map areas
# map.line - semi-colon list of rgb colours that are used by planner to shade
# lines and text on the map
map.shade=255,0,0; 0,255,0; 0,0,255; 255,255,0; 255,0,255; 255,128,64
map.line=128,128,255; 162,0,192; 0,128,255; 0,255,255; 0,205,98

Configuring GPS for use in ServicePlanner

If ServicePlanner has been installed with geographic data, and a GPS service provider solution is available, then the GPS components for ServicePlanner can be configured.

To configure the GPS, add the following entry to the service_manager.properties file:

gps.implAs=SOAP