Description

The KML Network Link Endpoint allows a user to generate a View-based KML Query Results Network Link. This Network Link can be opened with Google Earth establishing a dynamic connection between Google Earth and

DDF

. The root Network Link will create a Network Link for each configured Source including the local catalog. The individual Source Network LInks will perform a query against the OpenSearch Endpoint periodically based on the current view in the KML client. The query parameters for this query are obtained by a bounding box generated by Google Earth. The root Network Link will refresh every 12 hours or can be forced to refresh automatically view the KML client.

As a user changes their current view, the query will be re-executed with the bounding box of the new view. (This query gets re-executed 2 seconds after the user stops moving the view).

Usage

Once installed the KML Network Link Endpoint can be accessed at:

http://<DDF_HOST>:<DDF_PORT>/services/catalog/kml

After the above request is sent, a KML Network Link document will be returned as a response to download or open. This KML Network Link can then be opened in Google Earth.

Example Output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kml xmlns="http://www.opengis.net/kml/2.2" xmlns:ns2="http://www.google.com/kml/ext/2.2"
    xmlns:ns3="http://www.w3.org/2005/Atom" xmlns:ns4="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0">
    <NetworkLink>
        <name>DDF</name>
        <open xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:boolean">true</open>
        <Snippet maxLines="0"/>
        <Link>
            <href>http://0.0.0.0:8181/services/catalog/kml/sources</href>
            <refreshMode>onInterval</refreshMode>
            <refreshInterval>43200.0</refreshInterval>
            <viewRefreshMode>never</viewRefreshMode>
            <viewRefreshTime>0.0</viewRefreshTime>
            <viewBoundScale>0.0</viewBoundScale>
        </Link>
    </NetworkLink>
</kml>

The KML Endpoint can serve up a KML Style document when configured to do so. The request below will return the configured KML Style document. For more information on how to configure the KML Style document see Configuration.

http://<DDF_HOST>:<DDF_PORT>/services/catalog/kml/style

The KML Endpoint can also serve up Icons to be used in conjunction with the KML Style document. The request below shows the format to return an icon. For more information on how to configure the KML Icons document see Configuration.

http://<DDF_HOST>:<DDF_PORT>/services/catalog/kml/icons?<icon-name>
#NOTE: <icon-name> must be the name of an icon contained in the directory being served up like:
http://<DDF_HOST>:<DDF_PORT>/services/catalog/kml/icons?sample-icon.png

Installation and Uninstallation

The spatial-kml-networklinkendpoint feature is installed by default with the Spatial App.

Configuration

This KML Network Link Endpoint has the ability to serve up custom KML Style Documents and Icons to be used within that document.

The KML Style Document must be a valid XML document containing a KML Style.

The KML Icons should be placed in a single level directory and must be an image type (png, jpg, tif, etc).

The Description will be displayed as a pop-up from the root Network Link on Google Earth. This can contain a general description of the purpose of the network and URL's to external resources.

Configurable Properties

Title	Property	Type	Description	Required
Style Document	styleUrl	String	KML Document containing custom styling. This will be served up by the KmlEndpoint (e.g. file:///path/to/kml/style/doc.kml).	No
Icons Location	iconLoc	String	Location of icons for KmlEndpoint.	No
Description	description	String	Description of this NetworkLink. Enter a short description of what this NeworkLink provides.	No

Known Issues

None