Overview

ServicePlanner is a value-added module available within ServiceManager.

ServiceAnalytics uses a 3rd party product, MapXtreme for Java, to provide mapping functionality, which is run as a module bundled with ServiceScheduling.

The use of MapXtreme requires additional geographic data licensing, to cover the geographic datasets required.

Check Pre-requisites

ServicePlanner is installed as part of the ServiceManager installation process. As a result, the pre-requisites for ServicePlanner are the same as the ServiceManager Pre-requisites.

Components

ServicePlanner is a module of ServiceManager. It exists to enhance the feature-set that ServiceManager provides. The installed components related to ServicePlanner are shown in Figure 1 below.

Figure 1: Deployed ServicePlanner components

Geographic Datasets

Licensing

ServicePlanner comes bundled with MapXtreme content that is licensed from MapInfo. However, MapXtreme can only produce maps covering areas of the world (usually countries) for which it has geographic data. This geographic data resides on a file system that is visible to ServicePlanner. It is possible for multiple geographic datasets (i.e. countries) to be licensed if required.

Each geographic dataset is separately licensed and comes with its own installer.

ServicePlanner will not work without at least one licensed geographic dataset.

Updating Geographic Datasets

Geographic datasets are updated regularly - in particular, to include new postcodes and regions. It is therefore important that geographic datasets are updated in a timely manner.

Failure to do so can cause ServicePlanner to present inaccurate information, and for operative local knowledge to be inaccurately updated when changed.

Integrating with ServiceManager

Whenever a ServiceManager module is installed, upgraded or uninstalled, the appropriate process must be followed as described in the following sections. The ServiceManager application will then need to be restarted twice, to ensure that the correct ServiceManager modules are fully installed and initialised.

Unpacking

ServicePlanner is bundled as part of the ServiceManager release package.

The following diagram represents the directory structure installed on the target machine, underneath the "root" directory (i.e. \ServiceManager) created as part of the ServiceManager package.

It is not comprehensive; only files and directories of interest are highlighted.

/modules [1]
	/SERVICEPlanner
		/data [2]
		/WEB-INF [3]
			/lib
				*.jar

[1]	The `modules` directory as created inside the ServiceManager root directory, when ServiceManager is installed.
[2]	Geographic data is placed in this directory. There is typically one directory for each geography dataset that has been licensed. It should be noted that this directory is configurable and as such, may be located elsewhere.
[3]	This directory contains MapXtreme Java files that ServiceManager will copy to its web container deployment directory at run-time.

Browser not supported