Reader Directives

The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the GeoRSS reader is GEORSS.

DATASET

Required/Optional: Required

The location of the XML file containing the feed. This can be the path to a local or network file, or a URL.

Examples:

GEORSS_DATASET c:\atomsample.xml
GEORSS_DATASET \\path\to\network\file.xml
GEORSS_DATASET http://earthquake.usgs.gov/eqcenter/recenteqsww/catalogs/eqs7day-M5.xml
GEORSS_DATASET ftp://192.168.80.2/tests/geometry/gml.atom.geomtest.xml

Workbench Parameter: XML Feed

URL_PARAMETERS

Required/Optional: Optional

The value of this directive is only used if the reader is accessing a dataset which is a URL. The value of the directive should be a space-separated list of space-separated name-value pairs. The name-value pairs will be added to the dataset URL. A value must be provided for each parameter name. An empty string ( ““ ) can be used to provide an empty parameter value.

Example:

GEORSS_DATASET http://localhost/trafficdata.xml
GEORSS_URL_PARAMETERS province bc city vancouver 

This example will result in the reader accessing the following url:

http://localhost/trafficdata.xml?province=bc&city=vancouver

Workbench Parameter: Additional URL Parameters

READER_MODE

Required/Optional: Optional

Specifies which mode the reader should run in. This directive must be set to UPDATE to make the reader run in update mode. If it is set to any other value, or if the directive is not present, the reader will run in normal mode.

Example:

GEORSS_READER_MODE UPDATE

Workbench Parameter: Reader Mode

FEEDSTORE_DB_DIR

Required/Optional: Optional

This directive specifies the filesystem folder which contains the databases storing information about the feeds that the GeoRSS reader has processed. This directive is only read from the mapping file if the reader is running in update mode. If no value is set, the FME temp folder will be used.

Example:

GEORSS_FEEDSTORE_DB_DIR c:\georss_feeds

Workbench Parameter: Feed Database Location

FEEDSTORE_MAX_ENTRY_AGE

Required/Optional: Optional

This directive specifies the age in days at which entries will be deleted from a feed’s database. When the reader is run in update mode, the reader will delete any entries from the database for this feed which are older than the specified value. This ensures the feed database does not become arbitrarily large. If the value of this directive is not specified, or is 0, no entries will be deleted.

Example:

GEORSS_FEEDSTORE_MAX_ENTRY_AGE 30

Workbench Parameter: Max FeedStore Entry Age

FEEDSTORE_ID

Required/Optional: Optional

This directive allows the user to specify which feeds should be treated as coming from the same source. It only has an effect if the reader is run in update mode. When this directive is set, the input file/URL is treated as identical to any other previous read input which has the same feedstore identifier. If no value for this directive is set, it is the same as setting it equal to the DATASET directive.

Example:

GEORSS_FEEDSTORE_ID http://www.safe.com/company/news/rss/rss.xml

Workbench Parameter: FeedStore key id

PROXY_URL

Required/Optional: Optional

Specifies a proxy server that the reader will be use when accessing a URL dataset. The port number of the proxy server can be set in the URL, or by using the PROXY_PORT directive.

Example:

GEORSS_PROXY_URL www.someproxy.net
GEORSS_PROXY_URL www.someproxy.net:8080

Workbench Parameter: Http Proxy URL

PROXY_PORT

Required/Optional: Optional

Specifies the port number of the proxy server indicated by the PROXY_URL directive. This directive should only be used if the port number was not indicated in the PROXY_URL directive. This directive is ignored if the PROXY_URL directive has no value.

Example:

GEORSS_PROXY_PORT 8080

Workbench Parameter: Http Proxy Port

PROXY_USERNAME

Required/Optional: Optional

Specifies the username to use when accessing a password protected proxy server. This directive is ignored if any of the PROXY_URL, PROXY_PASSWORD or PROXY_AUTH_METHOD directives have no value.

Example:

GEORSS_PROXY_USERNAME someusername

Workbench Parameter: Proxy Username

PROXY_PASSWORD

Required/Optional: Optional

Specifies the password to use when accessing a password protected proxy server. This directive is ignored if any of the PROXY_URL, PROXY_USERNAME or PROXY_AUTH_METHOD directives have no value.

Example:

GEORSS_PROXY_PASSWORD password1234

Workbench Parameter: Http Proxy Password

PROXY_AUTH_METHOD

Required/Optional: Optional

Specifies the authentication method to use when accessing a password protected proxy server. This directive is ignored if any of the PROXY_URL, PROXY_USERNAME or PROXY_PASSWORD directives have no value. Acceptable values for this directive are ‘Basic’ or ‘Digest’.

Example:

GEORSS_PROXY_AUTH_METHOD Basic

Workbench Parameter: Http Proxy Authentication Method

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