The directives processed by the WFS reader are listed below. The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the WFS reader is WFS.
DATASET
The value for this directive is the URL for the WFS server.
A typical URL specifying a WFS server looks like:
WFS_DATASET http://www.mywfs.com/wfs_service_path/
Required/Optional
Required
Workbench Parameter
Web Feature Service URL
DEF
Mapping File Syntax
The syntax for a WFS DEF line is the same as a GML DEF line:
<ReaderKeyword>_DEF <elementName> \ xml_type <xml_type> \ [<attrName> <attrType>]*
Required/Optional
Optional
HTTP_AUTH_USER
This optional directive specifies the user name when accessing a password protected HTTP server.
The directive has no default value.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_AUTH_USER someusername
Workbench Parameter
Http Authentication User
HTTP_AUTH_PASSWORD
This optional directive specifies the password when accessing a password protected HTTP server. The directive has no default value.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_AUTH_PASSWORD my123secret
Workbench Parameter
Http Authentication Password
HTTP_AUTH_METHOD
This optional directive specifies the authentication method when accessing a password protected HTTP server.
Values
Basic (default) | Digest | NTLM
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_AUTH_METHOD Digest
Workbench Parameter
Http Authentication Method
HTTP_PROXY
This optional directive specifies the HTTP proxy to be used for network fetches. The port number may be specified at the end the proxy by appending :[port number] or through the HTTP_PROXY_PORT directive.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_PROXY www.someproxy.net
or
<ReaderKeyword>_HTTP_PROXY www.someproxy.net:8081
Note: Users may bypass the HTTP_PROXY and HTTP_PROXY directives and still have http proxy support by specifying the http_proxy environment variable.
Note: The value for this environment variable should be of the form [protocol://][user:password@]machine[:port], where components within [] are optional.
Note: An example value for the http_proxy environment variable is: www.someproxy.net:8081.
Workbench Parameter
Http Proxy Address
HTTP_PROXY_PORT
This optional directive is used if the HTTP proxy port was not specified in the HTTP_PROXY directive.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_PROXY_PORT 8081
Workbench Parameter
Proxy Port
HTTP_PROXY_USER
This optional directive specifies the user name when accessing a password protected proxy server. The directive has no default value.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_PROXY_USER someusername
Workbench Parameter
Proxy User
HTTP_PROXY_PASSWORD
This optional directive specifies the password when accessing a password protected proxy server. The directive has no default value.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_HTTP_PROXY_PASSWORD my123secret
Workbench Parameter
Proxy Password
HTTP_PROXY_AUTH_METHOD
This optional directive specifies the authentication method when accessing a password protected proxy server.
Required/Optional
Optional
Values
Basic (default) | Digest | NTLM
Mapping File Syntax
<ReaderKeyword>_HTTP_PROXY_AUTH_METHOD Digest
Workbench Parameter
Proxy Authentication Method
CONNECTION_TIMEOUT
This optional directive allows the user to set the number of seconds to wait for a connection to be established with the server.
Required/Optional
Optional
Values
An integer greater than 0
Mapping File Syntax
<ReaderKeyword>_CONNECTION_TIMEOUT 90
Workbench Parameter
Connection Timeout Length (seconds)
TRANSFER_TIMEOUT
This optional directive allows the user to set the number of seconds allowed for a connection to stop transferring data.
Required/Optional
Optional
Values
An integer greater than 0
Mapping File Syntax
<ReaderKeyword>_TRANSFER_TIMEOUT 90
Workbench Parameter
Transfer Timeout Length (seconds)
XSD_DOC
This optional directive allows the reader to bypass the WFS DescribeFeatureType operation by allowing the user to explictly specify a locally stored GML application schema.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword> XSD_DOC c:\gml\schemas\roads.xsd
Workbench Parameter
Application Schema
PREFER_POST
This optional directive instructs the reader to use HTTP POST for the WFS DescribeFeatureType and GetFeature operations if available.
Required/Optional
Optional
Values
Yes | No (default)
Mapping File Syntax
<ReaderKeyword>_PREFER_POST Yes
Workbench Parameter
Prefer HTTP Post, if Available
PREFERRED_VERSION
This optional directives lets the user choose the preferred WFS version.
Required/Optional
Optional
Values
1.1.0 (default) | 1.0.0
Mapping File Syntax
<ReaderKeyword>_PREFERRED_VERSION 1.1.0
Workbench Parameter
WFS Version
FILTER_EXPRESSION
This directive allows the reader to send a custom OGC XML fragment filter for the GetFeature operation.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_FILTER_EXPRESSION <Filter><PropertyIsEqualTo><PropertyName>NAME </PropertyName><Literal>Swan Lake</Literal></PropertyIsEqualTo></Filter>
Workbench Parameter
XML Filter Expression
MAX_RESULT_FEATURES
This optional directive is used to limit the number of features that a WFS GetFeature request retrieves.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_MAX_RESULT_FEATURES 200
Workbench Parameter
Max Features
OUTPUT_FORMAT
This optional directive is used to specify the desired output format for the DescribeFeatureType and GetFeature operations.
The valid values are the values listed in the WFS capabilities document. A drop-down list is filled with the available and supported mime-types from the capabilities document when the “Feature Types” selection GUI is used to query the available layers.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_OUTPUT_FORMAT text/xml; subtype=gml/3.2.1
Workbench Parameter
WFS Output Format
FME_FEATURE_IDENTIFIER
This directive may be used when the WFS reader is used in a third-party application that requires each feature in a layer be identified by a numeric identifier.
The directive allows the user to specify the attribute name for this numeric identifier.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_FME_FEATURE_IDENTIFIER feature_id
Workbench Parameter
Numeric Identifier Attribute
SRS_AXIS_ORDER
This optional directive overrides the axis order when reading a coordinate tuple in a GML <pos> or <posList> element.
Values
1,2 | 2,1 | 1,2,3 | 2,1,3
The default value, blank, uses the coordinate system's axis order.
Required/Optional
Optional
Mapping File Syntax
For example, if the srsName is set to "urn:ogc:def:crs:EPSG:6.6.4326", and the user is sure that the coordinate order in the document is lon-lat and not lat-lon order, then this directive should be set to "1,2" so that the reader reads the data in lon-lat order:
<ReaderKeyword>_SRS_AXIS_ORDER 1,2
Workbench Parameter
SRS Axis Order
MAP_PREDEFINED_GML_PROPERTIES
This directive specifies whether the default and optional GML feature properties, name and description, should be read.
Values
YES | NO (default)
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_MAP_PREDEFINED_GML_PROPERTIES YES
Workbench Parameter
Map Predefined Properties
COMPLEX_PROPERTIES_AS
This directive specifies whether GML properties that are defined as a complex type with complex content (that is, those that have embedded children elements) should be mapped as nested attributes or XML fragments within FME features.
Some complex properties, such as those that are recursively defined, cannot be mapped as nested attributes. These complex properties will always be mapped as XML fragments, regardless of the value of this directive.
Values
NESTED_ATTRIBUTES (default) | XML_FRAGMENTS
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_COMPLEX_PROPERTIES_AS XML_FRAGMENTS
Workbench Parameter
Map Complex Properties as
XML_FRAGMENTS_AS_DOCUMENTS
This directive specifies whether GML properties that are mapped as XML fragments should be converted into XML documents.
The conversion will add missing namespace declarations to the fragments, it will maintain CDATA sections, and it will also prefix an XML header declaration to the fragment. Converting the XML fragments into XML documents allows XML-based parsers, e.g., XSLT and XQuery based processors, to further process the fragments.
Values
YES (default) | NO
Required/Optional
Optional
Mapping File Syntax
<Reader_Keyword>_XML_FRAGMENTS_AS_DOCUMENTS NO
Workbench Parameter
Include XML Declaration in XML Fragments
FLATTEN_XML_FRAGMENTS
This directive specifies whether GML properties that are mapped as XML fragments should be flattened into nested attributes.
The flattening will only be applied to the data features carrying the XML fragments, hence the new flattened nested will not be reflected in the FME feature type schema definitions.
Values
YES (default) | NO
Required/Optional
Optional
Mapping File Syntax
<Reader_Keyword>_FLATTEN_XML_FRAGMENTS YES
Workbench Parameter
Flatten XML Fragments
MAP_GEOMETRY_COLUMNS
This directive specifies whether the GML geometric properties should be represented as individual, and possibly multiple, geometry columns in FME feature type definitions.
A geometric column in an FME data feature is represented either as a single named geometry, or, if multiple geometry columns are present, as an aggregate geometry with multiple named geometry components, this aggregate geometry will also have its “Contains Individual Geometries” interpretation flag set.
A new attribute type has also been introduced for specifying the order and/or position of a geometric column in the feature type definition. If an attribute X has its type set to “xml_geometry” then this attribute X becomes a placeholder in the feature type definition. It is a placeholder because actual data features for the feature type definitions will not have this attribute; instead, the data features will have a geometry named “X”.
Required/Optional
Optional
Values
YES (default) | NO
Mapping File Syntax
<Reader_Keyword>_MAP_GEOMETRY_COLUMNS NO
Workbench Parameter
Map Geometry Columns
USE_OLD_READER
This optional directive instructs the GML reader to use the older GML v3.1.1 code base to read GML v3.1.1 and v2.1.2 documents.
Required/Optional
Optional
Values
YES | NO (default)
Mapping File Syntax
<Reader_Keyword>_DISABLE_XML_NAMESPACE_PROCESSING YES
Workbench Parameter
Use Old Reader for GML v3.1.1 and v2.1.2 Documents
DISABLE_XML_NAMESPACE_PROCESSING
This directive disables XML Namespace processing for the underlying XML parser. Note that this may cause reading errors if the GML schema and the GML data use different prefixes for the same namespace URI.
The directive may be useful for datasets that are not XML Namespace valid.
Required/Optional
Optional
Values
YES | NO (default)
Mapping File Syntax
<Reader_Keyword>_DISABLE_XML_NAMESPACE_PROCESSING YES
Workbench Parameter
Disable XML Namespace Processing
DISABLE_AUTOMATIC_READER_TYPE_SELECTION
Values
YES | NO (default)
Required/Optional
Optional
Mapping File Syntax
<Reader_Keyword>_DISABLE_AUTOMATIC_READER_TYPE_SELECTION YES
Workbench Parameter
Disable Automatic Reader Type Selection
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
MINX, MINY, MAXX, MAXY
These optional directives are used to specify the value of the rectangular bounding box parameter value that is submitted during a request for feature information.
Required/Optional
Optional
Mapping File Syntax
The syntax for the values of these directives is:
<ReaderKeyword>_MINX <value>
<ReaderKeyword>_MINY <value>
<ReaderKeyword>_MAXX <value>
<ReaderKeyword>_MAXY <value>
All values must be specified in decimal, integer or scientific notation.
If all values for MINX, MINY, MAXX and MAXY have a value of 0, then no bounding box parameter will be submitted in the WFS server feature request.
Workbench Parameter
Search Envelope Min X, Search Envelope Min Y, Search Envelope Max X, Search Envelope Max Y
BBOX_COORDINATE_SYSTEM
This optional directive specifies the coordinate system for the search envelope. If not specified then the search envelope is assumed be in LL84.
Required/Optional
Optional
Mapping File Syntax
<ReaderKeyword>_BBOX_COORDINATE_SYSTEM <value>
The value must be a valid FME coordinate system name, if the value is left empty then LL84 is assumed.
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
LOCAL_CACHE_EXPIRY
This directive specifies the duration (in minutes) of validity for the locally-stored feature cache. When the cache validity time has expired, then features are read from the live WFS URL so that a fresh locally-stored cache may be established. This directive is honored only by a WFS connection made in the ArcGIS Data Interoperability extension or the FME Extension for ArcGIS; this directive is ignored by all other FME applications.
Required/Optional
Required only by a WFS connection in the Data Interoperability extension and FME Extension for ArcGIS; ignored elsewhere.
Mapping File Syntax
Not applicable. This directive is honored only in a WFS connection made by the ArcGIS Data Interoperability extension or the FME Extension for ArcGIS.
Values
The duration in minutes, defaulting to 60.
Workbench Parameter
Not applicable.