Background

AWLRS can be configured to use public Open Street Map (OSM), WMS or ArcGISRest tile services to be used as background layers.

Steps to Accomplish

These layers are configured through “[AWLRS Web Api]\Scripts\configs\MapBaselayers.json” file on the application server, for example

C:\inetpub\wwwroot\AWLRSWebAPI\scripts\configs\MapBaselayers.json

This is an excerpt from this file:

Each entry in the file has following properties:

• Name: The Name to be displayed in the map legend.
• Type: Should be one of the following
  • “OSM” – OSM tile server.
  • “WMS” – OGC compliant WMS server.
  • “ArcGISRest” – ArcGIS Tile server.
• Url: The URL of the service, this may be an array of URLs in the case of a tile server. The service will be called from within the client browser so the URL should be publicly accessible.
• Parameters: This property only applies to WMS services and allows the following parameters to be added to the WMS request issued by the client browser:
  • “LAYERS” – A list of layers to be included in the image returned by the service.
  • “BGCOLOR” – The background color to be used by the service when rendering the requested image.
  •  “FORMAT” – The format of the image returned, generally this should be “image/png” unless the service does not support this format.
• Options: “Attribution” Any acknowledgment or Copyright message that the service provider requires to be displayed in the map.
• IsActive:
  • true – the layer is displayed in the map legend
  • false – the layer is not displayed in the map legend
• IsShown:
  • true – the layer is displayed at startup
  • false – the layer is not displayed at startup
• MinimumScale: integer value, the minimum scale at which the base layer is enabled.
• MaximumScale: integer value, the maximum scale to which the base layer is enabled. Should be set to 0 if there is no restriction in maximum scale.
• Projection: The projection to be requested from the Tile\WMS server. The projection should be defined in EPSG notation i.e. EPSG: {epsg_code}. For example EPSG:3857

NB. If AWLRS is deployed to several load balanced servers the contents of this file must be consistent across ALL of them.