The KML Reader processes a number of directives in the mapping file environment. These are all prefixed by the current <ReaderKeyword>_. By default, the Reader Keyword is KML21.
DATASET
Required/Optional: Required
This directive specifies the location of the input KML dataset. The input KML dataset can be a kml file, a kmz file, a folder containing a kml file, or a URL referencing a KML file.
Workbench Parameter: Source OpenGIS KML Encoding Standard File or URL
LOG_VERBOSE
Required/Optional: Optional
Specifies whether or not the reader should increase the logging verbosity. Possible values are Yes and No. The default is No.
Workbench Parameter: Verbose Logging
FAIL_ON_NETWORK_ERROR
Required/Optional: Optional
Specifies whether or not the reader should terminate the translation if a network error occurs. Possible values are 'yes' or 'no'. The default is 'no'.
Workbench Parameter: Fail on Network Errors
DELETE_DOWNLOADED_FILES
Required/Optional: Optional
Specifies whether or not the reader should delete temporary files downloaded as part of the reading process. Possible values are 'yes' or 'no'. The default is 'yes'.
Workbench Parameter: Delete Downloaded Files
RASTER_READ_MODE
Required/Optional: Optional
Specifies whether the images files referenced by Overlay elements should be read as raster geometry. Possible values are 'all', 'groundoverlay', or 'none'. If the option is 'all', all GroundOverlay, PhotoOverlay, and ScreenOverlay images will be read as raster geometry. If the selected option is 'groundoverlay', then only GroundOverlay images will be read.
The default is 'groundoverlay'.
Raster's read from GroundOverlay images will be georeferenced using coordinate values from the GroundOverlay.
Workbench Parameter: Read Overlays As Rasters
PROXY_URL
Required/Optional: Optional
Specifies the url of a proxy server that will be used for all href traversal.
Workbench Parameter: Proxy Url
PROXY_PORT
Required/Optional: Optional
Specifies the port number for the proxy server. Not valid if PROXY_URL is not supported.
Workbench Parameter: Proxy Port
PROXY_USERNAME
Required/Optional: Optional
Specifies the username to use to login to the server for the proxy server. Not valid if PROXY_URL is not supported.
Workbench Parameter: Proxy User Name
PROXY_AUTH_METHOD
Required/Optional: Optional
Specifies the authentication method to use to login to the server for the proxy server. Not valid if PROXY_URL and PROXY_USERNAME are not supported.
Workbench Parameter: Proxy Authentication Method
SCAN_SCHEMA
Required/Optional: Optional
Specifies whether or not the reader should scan the KML files for schema elements. Possible values are 'yes' or 'no'. The default is 'yes'.
If 'no' is specifed, KML elements will be read using the fixed schema. KML datasets using KML 2.1 schema may not be read properly unless this option is set to 'yes'.
Workbench Parameter: Scan Schema
TRAVERSE_NETWORKLINKS
Required/Optional: Optional
Specifies whether or not NetworkLink or schemaUrl references to external KML files should be traversed. I.e. to read the referenced document.
Possible values are 'all', 'local', or 'none'. If 'local' is specified, then references will only be traversed if they refer to a file on the local filesystem.
The default value is 'all'.
Workbench Parameter: Traverse NetworkLinks
MAX_NETWORKLINK_TRAVERSAL_DEPTH
Required/Optional: Optional
Specifies the max depth of the traversal tree.
The traversal depth is the number of links that must be traversed to get from the original file to the root file. For example, if the dataset root refers to DocB, which refers to DocC, the traversal depth is 2.
The default value is 5'.
Workbench Parameter: Maximum NetworkLinks Traversal Depth
MOVE_TO_KML_WORLD_COORDSYS
Specifies whether or not the location metadata in the KML Placemark will be applied to the model geometry.
Required/Optional
Optional
Values
- yes (default): a custom coordinate system with a Azimuth Equal Distance projection will be applied to the feature.
- no: the feature will be output without any coordinate system.
Workbench Parameter
Move to World Coordinate System
APPLY_MODEL_TRANSFORMS
Specifies whether or not scaling and orientation metadata in the KML Placemark will be applied to the model geometry prior to being output.
Required/Optional
Optional
Values
- yes: The transformations will be applied.
- no (default)
SEARCH_ENVELOPE
Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that interact with the bounding box are returned.
If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE <minX> <minY> <maxX> <maxY>
Note: If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled.
Required/Optional
Optional
Workbench Parameter
Minimum X, Minimum Y, Maximum X, Maximum Y
SEARCH_ENVELOPE_COORDINATE_SYSTEM
This directive specifies the coordinate system of the search envelope if it is different than the coordinate system of the data.
The COORDINATE_SYSTEM directive, which specifies the coordinate system associated with the data to be read, must always be set if the SEARCH_ENVELOPE_COORDINATE_SYSTEM directive is set.
If this directive is set, the minimum and maximum points of the search envelope are reprojected from the SEARCH_ENVELOPE_COORDINATE_SYSTEM to the reader COORDINATE_SYSTEM prior to applying the envelope.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_SEARCH_ENVELOPE_COORDINATE_SYSTEM <coordinate system>
Workbench Parameter
Search Envelope Coordinate System
CLIP_TO_ENVELOPE
This directive specifies whether or not FME should clip features to the envelope specified in the SEARCH_ENVELOPE directive.
Values
YES | NO (default)
Mapping File Syntax
<ReaderKeyword>_CLIP_TO_ENVELOPE [yes | no]
Workbench Parameter
Clip To Envelope
EXPOSED_ATTRS
This directive allows the selection of format attributes to be explicitly added to the reader feature type.
This is similar to exposing format attributes on a reader feature type once it has been generated; however, it is even more powerful because it enables schema-driven applications other than Workbench to access and leverage these attributes as if they were explicitly on the schema as user attributes.
The result of picking a list of attributes is a comma-separated list of attribute names and types that will be added to the schema features. Currently all reader feature types will receive the same set of additional schema attributes for a given instance of the reader.
Required/Optional
Optional
Mapping File Syntax
Not applicable.
While it is possible for FME Objects applications to invoke this directive, the required format is not documented.
This directive is intended for use in our GUI applications (for example, Workbench) only.
Workbench Parameter
Additional Attributes to Expose