Configuring a base mapping layer

To visualize network topology overlaid onto a contextual map, configure the base mapping layer that you want to use.

About this task

The base layer provides the geographical base upon which the devices are overlaid. Devices and event status are contained within the topology layer and status layer, which are automatically calculated and are always visible.

V4.2 Fix Pack 4: You can define one or more base layers for each mapping provider. One base layer is defined as the default. Users can select a different base layer for their session in the geographical views.

To add or change a custom layer, see Adding custom map layers.

To add or change a base layer, complete the steps below:

Procedure

Ensure that you have the correct licenses for any mapping provider that you intend to use.
No licenses for any mapping providers are included with Network Manager. The default mapping base layer is OpenStreetMap, which does not require a license.
Back up and edit the following file: $JazzSM_HOME/profile/installedApps/JazzSMNode01Cell/isc.ear/ncp_gis.war/resources/config.json

Edit the mapProvider section.

The following code extracts show an example section.

"mapProvider": {
        "baseMapLayerName": "IBM Network Management",       
		"baseLayer": "OpenStreetMap",
		"baseLayersDefn": [
			{
				"baseLayerName": "OpenStreetMap",
				"baseLayerType": "osm"
			},
			{
				"baseLayerName": "Microsoft Bing",
				"baseLayerType": "bing",
				"imagerySet": "Road",
				"key": "INSERT_YOUR_MICROSOFT_KEY"
			},
			{
				"baseLayerName": "OpenLayer XYZ Format",
				"baseLayerType": "xyz",
				"urls": ["https://api.mapbox.com/styles/v1/mapbox/streets-v9/tiles/256/{z}/{x}/{y}?access_token=INSERT_YOUR_KEY"]
			},
			{
				"baseLayerName": "My Custom GeoServer WMS Layer",
				"baseLayerType": "wms",
				"url": "https://localhost:8443/geoserver/wms",
				"params": {
				}
			},
			{
				"baseLayerName": "My Custom GeoServer WMTS Layer",
				"baseLayerType": "wmts",
				"capabilities": {
				}
			}
		],

Configure a new or existing base layer. Edit the existing section for a supported map provider or copy and edit it. You can include multiple base layers for one mapping provider. For example, you can define multiple base layers that all use the OpenStreetMap provider by editing the baseLayer value.

Important: Do not delete any empty sections from the configuration file. Missing sections can cause errors.
1. Specify any unique descriptive name for the baseLayerName.
  
  In the preceding example, the baseLayerName value for the first base layer is set to OpenStreetMap on line 3.
2. Specify the mapping provider for this base layer in the baseLayerType parameter.
  You can specify only one of the following defined keywords for the baseLayerType value:
  - bing for Bing Maps
  - osm for Open Streetmap
  - wms for Web Map Service
  - wmts for Web Mapping Tile Service
  - xyz for OpenLayer XYZ format
Configure any mapping provider-specific parameters necessary.
Mapping providers might support additional parameters, however, only those parameters that are listed in the default configuration are supported by Network Manager. Refer to the mapping provider documentation for information about what values are acceptable for these parameters.
Ensure that the baseLayer parameter exactly matches one of the baseMapLayerName values.
The baseLayer parameter defines the default base layer. You can only specify one baseLayer parameter.
Save and close the file.
If you are using a map layer server that is different from the Network Manager GUI server, configure the server details.
1. Back up and edit the file $NMGUI_HOME/profile/etc/tnm/tnm.properties.
2. Update the tnm.contentSecurityPolicyImgSrc property.
  The property value must include 'self' as well as zero, one, or more map layer hosts.
3. If you are not using Open Streetmap, delete https://*.tile.openstreetmap.org from the property value.
4. Add one or more hosts for your map servers to the property value. Include the protocol (http:// or https://) and the port, if the port differs from the default (80 for HTTP and 443 for HTTPS).
  The property value can be any valid img-src attribute of a Content-Security-Policy header. See here for the specification for this attribute: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/img-src
Close and reopen the geographical views so that users can see changes to base layers.