How to Configure a WMS Map Layer

This section explains how to configure a layer based on a map using WMS (Web Map Service). These map layers can display additional geographic information on the main map.

WMS map layers are configured in WmsLayer nodes, as in the example below.

  <WmsLayer>

    <id>WMSExample1</id>

    <Name>WMS Example</Name>

    <Icon id="icon1" />

    <Url>https://example.com/map</Url>

    <Layers>SIDS:BASE_MAP</Layers>

    <Format>image/png</Format>

    <Transparent>True</Transparent>

    <AutoRefresh>15</AutoRefresh>

  </WmsLayer>

In the XML structure of the layer, the following elements can be configured:

Parameter	Required?	Description
id	Yes	Unique identifier for the layer in the configuration. This value cannot be the same as any other layer ID.
Name	Yes	Name of the layer to be displayed in the Layers window in the interface.
Icon	Yes	Icon used to identify the layer in the Layers window. Note that this icon must have been previously configured, as detailed in Appendix -> Layers for the Integration Map -> How to Configure an Icon for a Layer.
URL	Yes	Path of the WMS server to be used.
Layers	Yes	If the server is providing more than one map as layers, use this parameter to specify which layers should be retrieved.
Format	Yes	Format of the images provided by the server. This parameter should be completed with "image/" before the name of the format.
Transparent	Yes	Defines whether the layer will have a transparent background or not. Valid values: "True" and "False".
AutoRefresh	No	Indicates the frequency, in seconds, with which the layer will be automatically updated to match the latest information available from its data source.