Reader Directives – Enterprise Geodatabase

These directives are used when connecting to an Enterprise Geodatabase.

CONNECTION_FILE

Required/Optional: Optional

This statement identifies the pathname of a connection file to be used to connect to an Enterprise Geodatabase. A connection file provides the necessary information to connect to the SDE server, such as the server name or the username. The connection file must be a *.sde file and have the proper format for a connection file as defined by Esri. If you specify a connection file, you do not need to specify the directives SERVER, INSTANCE, USER, PASSWORD, VERSION, HISTORICAL_VERSION_NAME and HISTORICAL_VERSION_TIMESTAMP. (If, however, a password was not specified in the connection file, you will be prompted for a password.)

The pathname of the connection file to be used to connect to an Enterprise Geodatabase.

Parameter: <connection_file>

Workbench Parameter: Connection File

Example:

GEODATABASE_SDE_CONNECTION_FILE C:\GeoDB\connect.sde

DATASET

Required/Optional: Required

For Enterprise Geodatabases, this is the name of the dataset from which features are retrieved. In an Enterprise Geodatabase, this dataset is referred to as the DATABASE. Some RDBMS’s, such as Oracle, do not require a value, whereas others, such SQLServer, do. For databases that do not require the value, the value not_used is specified by convention.

Workbench Parameter: Source Esri Geodatabase (ArcSDE) Dataset

Example:

GEODATABASE_SDE_DATASET testdset

SERVER

Required/Optional: Required

The name of the Geodatabase server used to read data from the dataset.

Parameter: <server>

Workbench Parameter: Server

Example:

GEODATABASE_SDE_SERVER dax

INSTANCE

Required/Optional: Required

The Enterprise Geodatabase instance to which FME connects. The usual value for systems with a single ArcSDE instance is esri_sde8.

Parameter: <instance>

Workbench Parameter: Instance Name

Example:

GEODATABASE_SDE_INSTANCE esri_sde8

USERID

Required/Optional: Optional if connecting in OSA mode

User ID of the Enterprise Geodatabase user.

If the userid and password are missing or not set, then the reader will try and connect with AUTHENTICATION_MODE set to OSA (Operating System Authentication).

Parameter: <userid>

Workbench Parameter: User ID

Example:

GEODATABASE_SDE_USERID jacob

PASSWORD

Required/Optional: Optional if connecting in OSA mode

Password for the user account.

If the userid and password are missing or not set, then the reader will try and connect with AUTHENTICATION_MODE set to OSA (Operating System Authentication).

Parameter: <password>

Workbench Parameter: Password

Example:

GEODATABASE_SDE_Password jacobpassword

REMOVE_TABLE_QUALIFIER

Specifies whether to keep or remove the table name prefix. For instance, the table name might appear in the form <owner_name>.<table_name>.

Setting this directive to YES indicates that the reader should return the table name without the owner_name prefix. This is useful when:

• creating a workspace that will be passed on to another organization using the same table names,
• performing a translation to another database format but with a different user name, and
• writing to a file-based format but not wanting the prefix in the name of the feature type.

When this directive is set to YES during the generation of a mapping file or workspace, the source feature types will be the table names without any prefix; otherwise, they will contain the owner name as a prefix. It is recommended that this directive not be changed in value after generating the mapping file/workspace as it is possible for no features to be successfully passed onto the writer (since the writer is expecting feature types with different names).

Notes

• Even when REMOVE_TABLE_QUALIFIER is set to YES, if the table is owned by a user other than the current user, the <owner_name> prefix will not be dropped so that the reader will find the correct table.
• When the underlying database is SQL or DB2, the schema qualifier (<owner_name>) is always dropped, regardless of this setting.

Required/Optional

Optional

Values

YES | NO (default)

Mapping File Syntax

REMOVE_TABLE_QUALIFIER YES

Workbench Parameter

Remove Table Qualifier

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