Reader Directives

The directives processed by the FDO reader are listed below. The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file.

DATASET

Required/Optional: Required

The value for this directive is the reader connection string. The connection string is a comma-delimited sequence of properties, each specified by a name/value pair. The first name/value pair specifies the FDO Provider. Next are the FDO Provider specific properties required to establish a connection with an FDO Datastore through the Provider.

The connection string is encoded with an XML-like encoding. By entering the connection information into the format settings box dialogs, Workbench will automatically encode the connection string properly. To encode the connection string manually within a mapping file or FME Objects, contact Safe Software.

Mapping File Syntax

FDO_DATASET FDO_PROVIDER_NAME,OSGeo.SDF.3.7,FDO_SDF_File,file.sdf,FDO_SDF_ReadOnly,TRUE,FDO_SCHEMAS,

Workbench Parameter: Source FDO Provider Connection String

DEF

Required/Optional: Optional

This optional specification is used to limit the available and defined feature classes that will be read. If no IDs are specified and if the underlying format of the FDO Provider is file-based, then all defined and available feature classes are read. If the underlying format of the FDO Provider is a database, then at least one ID must be specified. The syntax of the IDs keyword is:

FDO_IDs <featureType1> 	\
	<featureType2>	\
	<featureTypeN> 

The feature types must match those used in DEF lines.

The example below selects only the ROADS feature class for input during a translation:

FDO_IDs ROADS

RETRIEVE_ALL_SCHEMAS

This parameter is applicable only when generating a mapping file, generating a workspace, or when retrieving schemas in an FME Objects application.

When set to yes, schemas for all of the tables and feature classes in the database are returned.

When set to no (or missing), and if RETRIEVE_ALL_TABLE_NAMES is similarly set to no (or missing), only schemas requested by the IDs parameter are returned.

Required/Optional

Optional

Values

YES | NO (default)

NO: The reader will return the schemas for the feature types specified in the IDs. If no features are specified in IDs, then FME returns the schema features for all the tables.

If this value is not specified, then it is assumed to be No.

YES: Indicates to the reader to return all the schemas of the tables in the database.

Mapping File Syntax

Not applicable.

FME Objects applications would include RETRIEVE_ALL_SCHEMAS followed by “YES” in the parameters array passed to IFMEUniversalReader::open().

Workbench Parameter

Not applicable

RETRIEVE_ALL_TABLE_NAMES

This parameter is only applicable when generating a mapping file, generating a workspace or when retrieving schemas in an FME Objects application.

When set to yes, and if RETRIEVE_ALL_SCHEMAS is set to no (or missing), names for all of the tables and feature classes in the database are returned. When set to no (or missing), and if RETRIEVE_ALL_SCHEMAS is similarly set to no (or missing), the schemas requested by the IDs directive are returned.

Note: If RETRIEVE_ALL_SCHEMAS is also set to Yes, then RETRIEVE_ALL_SCHEMAS takes precedence.

Required/Optional

Optional

Values

YES | NO (default)

Mapping File Syntax

Not applicable.

FME Objects applications would include RETRIEVE_ALL_TABLE_NAMES followed by “YES” in the parameters array passed to IFMEUniversalReader::open().

Workbench Parameter

Not applicable (used when you browse a Table List)

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