Reader Directives

The suffixes listed are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the FME Server Stream reader is FMESERVERSTREAM.

DATASET

The DATASET directive for FME Server Stream reader is not used.

FME_SERVER_HOST

This specifies the machine running an FME Server instance to read as a host name.

The FME Server must have proper permissions and be set up correctly to accept connections from a remote machine.

Required/Optional

Required

Mapping File Syntax

FME_SERVER_HOST myfmeserver

FME_SERVER_PORT

When connecting remotely, this specifies the TCP/IP port through which to connect to the FME Server.

The default port is 7071.

Required/Optional

Optional

Mapping File Syntax

FME_SERVER_HOST myfmeserver

FME_SERVER _USERNAME

This directive contains the name of user who will access the FME Server. The named user must exist with appropriate permissions.

Required/Optional

Required

Mapping File Syntax

FME_SERVER_USERNAME admin

FME_SERVER _PASSWORD

This directive contains the password of the user accessing the FME Server.

Required/Optional

Required

Mapping File Syntax

FME_SERVER_PASSWORD password

REPOSITORY_NAME

This directive is the name of FME Server repository containing the target workspace.

Required/Optional

Required

Mapping File Syntax

REPOSITORY_NAME repository

WORKSPACE_NAME

This directive is the name of the target workspace which contains an FME Server Stream writer.

Required/Optional

Required

Mapping File Syntax

WORKSPACE_NAME workspace

DEF

This specification is used to define the files read.

Required/Optional

Optional

Mapping File Syntax

The syntax of the DEF directive is:

<ReaderKeyword>_DEF <baseName>  [<attrName> <attrType>]+

Note: This directive is not used when the dataset is a file.

Example

The example below defines a roads feature type during a translation:

<ReaderKeyword>_DEFs roads

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