Spatial and Routing Module

Backup Spatial Module named resources and data

Although part of the Spectrum upgrade installation process for the Spatial Module is to automatically back up the data from a previous release before the upgrade continues, it is important to back up custom data sources and resources prior to upgrading using the limrepo export command in the Administration Utility (see the Administration section of the Spectrum Spatial Guide for instructions).

Any data that was installed with the module will be deleted after upgrade. If custom data is located in the same directories, back it up and copy to the same location in the Spectrum™ Technology Platform directories once upgraded. Pay special attention to any data or resources that have been added to default locations within the %install_home%\Spectrum\server\modules\spatial\ directory, as these will be deleted after upgrade. For example, if you have used the default TileCache directory for generating your map tiles, back it up, and copy to the same location once upgraded.

It is also very important to perform a backup of the repository after the Spectrum™ Technology Platform upgrade is successful, to serve as a baseline in case your repository becomes corrupt later on.

Backup Spatial Module configuration files

Although the upgrade process from Spectrum™ Technology Platform will automatically back up configuration files (which are stored in the repository) and properties files for the Spatial Module, as well as merge custom settings, it is still important to back up the files before proceeding with an upgrade.

Follow these instructions if you:

  • Run Spectrum™ Technology Platform server on a port other than 8080.
  • Have made changes to any of these Spatial Module configuration files:
    • Mapping
    • Feature
    • Map Tiling
    • WFS
    • WMS
    • WMTS

Before an upgrade, you should also back up the java.properties and java.vmargs files that reside in %install_home%\server\modules\spatial to preserve any customizations you have made.

To back up user-modified configuration files and properties files:

  1. Use the limrepo export command in the Administration Utility to export the configuration files: limrepo export --s SourceRepositoryPath --o OutputFilePath --a --c --f.
    For example, limrepo export --s /Configuration --o C:\myrepository\configuration --a --c --f
    Note: For instructions on using the Administration Utility, see the Administration section of the Spectrum Spatial Guide. It is strongly recommended that you use the Administration Utility to export and import configuration files instead of WebDAV to ensure the files will comply with the new version of the Spatial Module.
  2. Make a backup copy of \modules\spatial\java.properties and java.vmargs to save any non-default settings.
  3. Perform the Spectrum™ Technology Platform upgrade.

If you have a successful upgrade, back up the new set of configuration files under %install_home%\server\modules. This backup will assist Tech Support should you encounter an issue with your installation. If you did not have a successful upgrade, follow the instructions described in Spatial upgrade backup failure procedure.

Note: If you forgot to back up the configuration, java.properties, or java.vmargs files, you can check the backup zip file that is created by the upgrade process (as long as no failures occurred). This zip file (upgrade_backup_yyyyMMddHHmmss.zip) is located under %install_home%\server\modules.

Spatial upgrade backup failure procedure

Part of the Spectrum upgrade installation process for the Spatial Module is to automatically back up the data from a previous release before the upgrade continues. If the installer encounters an error during the backup, the installer displays a message and stops.

To re-attempt an upgrade after the error, complete these steps:

  1. Go to the <Spectrum installdir>\server\modules and make a backup of the lim_backupx.x folder at some other location (where x.x is the backup version).
  2. Delete the lim_backupx.x folder from the \modules directory.
  3. Re-launch the Spectrum installer and follow the installation steps.

To ensure a successful upgrade process, manually back up your data beforehand. See Backup Spatial Module named resources and data.

Upgrading a clustered environment for the Spatial Module

The upgrade process for a clustered environment in the Spatial Module is documented in the "Cluster" section of the Installation Guide located on support.pb.com. See the topic entitled, "Upgrading a Cluster with the Spatial Module."

Heap memory and pool size

For new installations, the default heap memory is 2048 MB (2GB). An upgrade maintains the existing heap size value. For more information, see the performance tuning topics in the Administration section of the Spectrum Spatial Guide.

A new installation sets the default pool size to 4. An upgrade does not affect pool size expect when it is less than 4. In this case, upgrading resets the value to 4. To change the Remote Component Pool Size value after installing or upgrading the Spatial Module, open the Management Console, and select Resources and then Spatial. Change the pool size value and click Save. For details, see Modifying the Pool Size in the Spectrum Spatial Guide.

Upgrading with ACL

When upgrading to 12.0 SP2 or later, the Access Control List (ACL) model is upgraded to a new security model. The migration script will run as a part of installation but it also can be run independently of the installation procedure.

Note: If you export the command line interface (CLI), it does not alter the permissions. These permission will need to be migrated. For example, the resources from 12.0 SP1 and earlier come with a VIEW permission, but when you upgrade to 12.0 SP2 or later, the migration script changes VIEW to EXECUTE.

The migration script will run the first time Spectrum™ Technology Platform is started after upgrading to 12.0 SP2 or later versions. It will only run once. The migration script will perform the following:

  • All the permissions on folders will be removed.
  • All the permissions on resources will be removed.
  • The new EXECUTE permission will be applied if the VIEW permission existed on any resources.
  • Any existing Deny permissions will be removed.
  • Dataset VIEW permission is removed. Other permissions on Dataset such as CREATE, MODIFY, and DELETE will be preserved if they existed before the upgrade.
  • NamedResourceMetadata resources will have no ACL for now.
Note: Having added the new EXECUTE permission, the Spectrum™ Technology Platform will start over with the new permissions.

Spatial installation directory names and special characters

For Spectrum™ Technology Platform installations that include the Spatial Module, the installation directory names must not contain any of the following characters.

  • & - Ampersand
  • > - Greater Than
  • < - Less Than
  • ' - Apostrophe
  • " - Quote

Routing database memory usage

When loading a large Enterprise Routing database, you might have to increase the memory of the routing remote component. This setting is made in the Management Console after upgrading.

To increase the memory of the routing remote component in the Management Console, select Spectrum Databases from the Resources menu. On the Spectrum Databases page, click on the routing database you want to increase the memory for. On the Edit Database page, increase the Max memory (MB) value.