Reader Directives

The suffixes listed are prefixed by the current <ReaderKeyword> in a mapping file. Unless otherwise specified, the <ReaderKeyword> for the ArcGISMap reader is ARCGISMAP.

DATASET

The file from which data is to be read.

Required/Optional: Required

Workbench Parameter: Source Esri ArcGIS Map File(s)

IDs

Required/Optional: Optional

Specifies the layers/tables from which features are to be retrieved. This directive is used in conjunction with the DEF directive. If both DEF and IDs are specified, then the intersection is taken from both of these directives. The layers that are read are subject to use of the READ_INVISIBLE_LAYERS keyword. If the layer name is blank for a particular layer, then the feature class name must be used instead.

Workbench Parameter: Feature Types to Read

DEF

Describes layers/tables. Normally these lines are automatically generated within a mapping file using FME. This directive is used in conjunction with the IDs directive. If both DEF and IDs are specified, then the intersection is taken from both of these directives. The layers that are read are subject to use of the READ_INVISIBLE_LAYERS directive. If the layer name is blank for a particular layer, then the feature class name must be used instead.

Required/Optional: Optional

IGNORE_MAP_EXTENTS

Specifies whether to read only those features that are within the extents of the map document, or to ignore the extents and read all the features in the layer. (This directive does not affect the reading of features from tables.)

Required/Optional: Optional

Value: YES | NO

Default Value: NO

Workbench Parameter: Ignore Map Extents

READ_INVISIBLE_LAYERS

Specifies whether to read features from an invisible layer. (This directive does not affect the reading of features from tables.)

Required/Optional: Optional

Value: YES | NO

Default Value: NO

Workbench Parameter: Read Invisible Layers

USE_SELECTION_SET

Specifies whether or not to only read the selected features. It is used in conjunction with the directives READ_INVISIBLE_LAYERS and IGNORE_MAP_EXTENTS since it is possible that some of the selected features are currently invisible and/or outside the current extents of the map. If set to YES and there are no features in the selection set, all the features from the specified layers will be read. When the layer name of a layer is blank, the feature type is set to the feature class name of the layer, rather than using the blank layer name. When using the IDs directive, the name of the feature class should be specified when setting up to read from the layer with the blank layer name. (This directive does not affect the reading of features from tables.)

Required/Optional: Optional

Value: YES | NO

Default Value: NO

Workbench Parameter: Use Selection Set

RESOLVE_DOMAINS

This directive specifies whether to resolve attributes that have a default coded value domain (i.e., the domain was not set up through a subtype) associated with them. This means that when an attribute of a feature has a coded value domain associated with it, another attribute will also be added that represents the textual description of the coded attribute. The new attribute will be <attribute-name>_resolved, where <attribute-name> is the name of the attribute containing the code.

Required/Optional: Optional

Value: YES | NO

Default Value: NO

Workbench Parameter: Resolve Domains

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