OGC/Google KML Reader Parameters

General

Specifies whether or not the reader should increase the logging verbosity.

Values: Yes, No (default)

Specifies whether the images files referenced by Overlay elements should be read as raster geometry.

  • All – All GroundOverlay, PhotoOverlay, and ScreenOverlay images will be read as raster geometry.
  • GroundOverlay – Only GroundOverlay images will be read.
  • None – Image files will not be read.

Specifies whether or not the reader should scan the KML files for schema elements.

  • No – KML elements will be read using the fixed schema.
  • Yes – KML datasets using the KML 2.1 schema may not be read properly unless this option is set to Yes.

Specifies whether or not the reader should terminate the translation if a network error occurs.

Specifies whether or not the reader should delete temporary files downloaded as part of the reading process.

Specifies whether or not NetworkLink or schemaUrl references to external KML files should be traversed (that is, to read the referenced document).

If Local is specified, then references will only be traversed if they refer to a file on the local filesystem.

Specifies whether or not scaling and orientation metadata in the KML Placemark will be applied to the model geometry prior to being output.

Specifies the maximum 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.

Forces the reader to use the specified encoding when parsing the dataset. This parameter should only be used if errors occur when adding a reader and you know the encoding of the input dataset.

If not specified, the reader determines the encoding.

Schema Attributes

Use this parameter to expose Format Attributes in FME Workbench when you create a workspace:

  • In a dynamic scenario, it means these attributes can be passed to the output dataset at runtime.
  • In a non-dynamic scenario, this parameter allows you to expose additional attributes on multiple feature types. Click the browse button to view the available format attributes (which are different for each format) for the reader.

Spatial

Coordinate systems may be extracted from input feature data sources, may come predefined with FME, or may be user-defined. FME allows different output and input coordinate systems, and performs the required coordinate conversions when necessary.

How FME Processes Coordinate Systems in the Workspace

If a coordinate system is specified in both the source format and the workspace, the coordinate system in the workspace is used. The coordinate system specified in the source format is not used, and a warning is logged. If a source coordinate system is not specified in the workspace and the format or system does not store coordinate system information, then the coordinate system is not set for the features that are read.

If a destination coordinate system is set and the feature has been tagged with a coordinate system, then a coordinate system conversion is performed to put the feature into the destination system. This happens right before the feature enters into the writer.

If the destination coordinate system was not set, then the features are written out in their original coordinate system.

If a destination coordinate system is set, but the source coordinate system was not specified in the workspace or stored in the source format, then no conversion is performed. The features are simply tagged with the output system name before being written to the output dataset.

For systems that know their coordinate system, the Coordinate System field will display Read from Source and FME will read the coordinate system from the source dataset. For most other input sources, the field will display Unknown (which simply means that FME will use default values). In most cases, the default value is all you'll need to perform the translation.

You can always choose to override the defaults and choose a new coordinate system. Select More Coordinate Systems from the drop-down menu to open the Coordinate System Gallery.

Changing a Reprojection

To perform a reprojection, FME typically uses the CS-MAP reprojection engine, which includes definitions for thousands of coordinate systems, with a large variety of projections, datums, ellipsoids, and units. However, GIS applications have slightly different algorithms for reprojecting data between different coordinate systems. To ensure that the data FME writes matches exactly to your existing data, you can use the reprojection engine from a different application.

Note  To use this feature, you must have a supported GIS application installed on your system (for example, Esri ArcGIS®).

To change the reprojection engine, Select Workspace Parameters > Spatial > Reprojection Engine. In the example shown, you can select Esri (but the selection here depends on your installed applications):

For more information, see the links below:

If the value of this parameter is Yes, the companion .prj and .wld/.wld3 files (having the same name as the .obj file) will be read to acquire the coordinate system and the data necessary to convert points to the world coordinate system.

Note  In the absence of a companion .wld/.wld3 file with the same name as the .obj file, the reader will look for a file named global.wld or global.wld3 in the same folder. For the companion .prj file, the reader will look for a file named global.prj.

A search envelope (also known as a bounding box) is a rectangular area that defines a geographic area. In FME, the easiest way to define a search envelope is to use search envelope parameters.

Defining a search envelope is the most efficient method of selecting an area of interest because FME will read only the data that is necessary – it does not have to read an entire dataset. Search Envelope parameters apply to both vector and raster datasets and can be particularly efficient if the source format has a spatial index.

Most FME readers have parameters to define the search envelope of data that is being read:

Screenshot with blank search envelope min and max x and y parameters

The parameters include the x and y coordinates of the bounding box as well as a parameter that defines the coordinate system.

How to Define the Bounding Box

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 intersect with the bounding box are returned. Note that the bounding box intersection is not a full geometry intersection (based on spatial relationships) that would be returned by a transformer like the SpatialFilter.

Note  If all four coordinates of the search envelope are left at 0, the search envelope will be disabled even if this option is checked.

Search Envelope Coordinate System

Specifies the coordinate system of the search envelope if it is different than the coordinate system of the data. The coordinate system associated with the data to be read must always be set if this parameter is set.

If this parameter is set, the minimum and maximum points of the search envelope are reprojected from the Search Envelope Coordinate System to the reader’s coordinate system prior to applying the envelope.

Clip to Search Envelope

The underlying function for Use Search Envelope is an intersection; however, when Clip to Search Envelope is checked, a clipping operation is also performed.

  • When left unchecked (set to No), features that overlap the boundary will be included in their full (unclipped) form.
  • When checked (set to Yes), this option instructs FME to clip features to the exact envelope boundary. FME removes any portions of imported features being read that are outside the search envelope.

Clip to Search Envelope: No

Clip to Search Envelope: Yes

Any features that cross the search envelope boundary will be read, including the portion that lies outside of the boundary.

Any features that cross the search envelope boundary will be clipped at the boundary, and only the portion that lies inside the boundary will be read.

The search envelope includes the bounding box and the extent of the raster.

The search envelope includes only the area within the bounding box.

The raster size will still match the bounding box, but the area without data will be filled with Nodata values to represent the absence of data, if the source raster has them.

Raster Nodata may be a single value across all bands, a single value per band, or a separate alpha or transparency band that indicates the lack of data values (this is more common in images than other types of rasters).

Use Network Authentication

Note  This parameter is always visible in some formats, and visible in other formats only when the dataset is a URL.

Authentication Method

Specify the authentication method to use when accessing a password-protected server.

  • Basic (default) – Basic access authentication is designed to allow a client to provide credentials to a server on the assumption that the connection between them is trusted and secure. Note that any credentials passed from client to server can be easily intercepted through an insecure connection.
  • Digest – Digest authentication is one of the agreed-upon methods a web server can use to negotiate credentials, such as username or password, with a user's web browser.
  • NTLM – A challenge-response protocol that is used to provide compatibility with versions of Windows earlier than the Windows 2000 operating systems.
  • Web Connection – Web connections provide a convenient and secure way to store and reuse previously established connection parameters. See Web Connection below.
  • Single Sign-on – FME will use the credentials of the current user to authenticate the HTTP request. This authentication method currently works only on the Windows operating system.
Note  To access datasets using a proxy server, use the Network tools in FME Options. From the FME Workbench menu, select Utilities > FME Options > Network Proxy. For more information, see Network Proxy in FME Workbench Help.

Web Connection

Using Web Connections

FME Options: Web Connections