How to Configure a KML Map Layer

This section explains how to configure layers based on maps in KML (Keyhole Markup Language) format, which are used to display additional geographic information on the main map.

Note that, for improved system performance, KML files can be copied directly to the App_CCM/AppData/KML/ folder so that, when configured as layers in the configuration file, the system can access the files directly instead of having to retrieve them through an external link.

Alternatively, KML files can be imported and used to generate layers automatically through the Export/Import Layers section of this solution. For details, see Appendix -> Layers for the Integration Map -> How to Export and Import Layers.

Each KML layer is configured in a KmlLayer node, as in the example below.

 

 <KmlLayer>
    <id>Example1</id>
    <Name>KML Example 1</Name>
    <Local>True</Local>
    <Icon id="icon1" />
    <Path>KML_Samples.kml</Path>
    <AutoRefresh>15</AutoRefresh>
  </KmlLayer>

 

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.

Local

Yes

Indicates whether the KML file is stored on the application server (value = "True") or if it will be retrieved from an external link (value = "False").

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.

Path

Yes

For local files (copied directly to the installation folder or imported to the system), this parameter must be completed with the name of the file. For external files, the link to the file must be entered.

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.