Reader Directives

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

DATASET

The location of the ESRIJSON file to be read. This can be the path to a local or network file, or a URL.

Required/Optional

Required

Mapping File Syntax

ESRIJSON_DATASET c:\json_sample.json

ESRIJSON_DATASET \\path\to\network\file.json

ESRIJSON_DATASET http://mysite.com/esrijson

Workbench Parameter

Source ESRIJSON File or URL

DELETE_DOWNLOAD_FILE

If the value of this directive is set to Yes, when the reader has finished reading downloaded ESRIJSON text, it will delete the local file that the text was downloaded to.

Values

Yes (default) | No

The value of this directive is only meaningful if the dataset is a URL.

Required/Optional

Optional

Mapping File Syntax

ESRIJSON_DELETE_DOWNLOAD_FILE No

Workbench Parameter

Delete downloaded file

MAKE_DONUTS

If this directive is set to Yes, the reader will attempt to create donut geometries for any feature containing multiple polygon geometries. This allows the reader to recover donut geometries that were output from the ESRIJSON writer.

If this directive is set to No, the geometry will be unchanged.

Required/Optional

Required

Mapping File Syntax

ESRIJSON_MAKE_DONUTS Yes

Workbench Parameter

Create donuts from areas

MAKE_PATHS

If this directive is set to Yes, the reader will attempt to create path geometries for any feature containing multiple line geometries. This allows the reader to recover path geometries that were output from the ESRIJSON writer. Only continuous consecutive lines will be merged into a path. New path segments will not be created.

If this directive is set to No, the geometry will be unchanged.

Required/Optional

Required

Mapping File Syntax

ESRIJSON_MAKE_PATHS Yes

Workbench Parameter

Create paths from connected lines

SIMPLIFY_MULTIS

The default geometry on many feature types is a multi-geometry.

If this directive is set to Yes, the reader will simplify any multi-geometries which only contain a single part. The multi-geometry will be replaced with the part.

Required/Optional

Required

Mapping File Syntax

ESRIJSON_SIMPLIFY_MULTIS No

Workbench Parameter

Simplify multi-geometries containing only one part

HTTP_AUTH_USERNAME

Required/Optional

Optional

Specifies the username to use when accessing an Esri-JSON file on a password protected server. This directive is ignored if either of the HTTP_AUTH_PASSWORD or HTTP_AUTH_METHOD directives have no value.

Mapping File Syntax

ESRIJSON_HTTP_AUTH_USERNAME someusername

Workbench Parameter

Http Username

HTTP_AUTH_PASSWORD

Required/Optional

Optional

Specifies the password to use when accessing an Esri-JSON file on a password protected server. This directive is ignored if either of the HTTP_AUTH_USERNAME or HTTP_AUTH_METHOD directives have no value.

Mapping File Syntax

ESRIJSON_HTTP_AUTH_PASSWORD password1234

Workbench Parameter

Http Password

HTTP_AUTH_METHOD

Required/Optional

Optional

Specifies the authentication method to use when accessing an Esri-JSON file on a password protected server. This directive is ignored if either of the HTTP_AUTH_USERNAME or HTTP_AUTH_PASSWORD directives have no value. Acceptable values for this directive are ‘Basic’, ‘Digest’ or ‘NTLM’.

Mapping File Syntax

ESRIJSON_HTTP_AUTH_METHOD Basic

Workbench Parameter

Http Authentication Method

PROXY_URL

Specifies a proxy server that the reader will 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.

Required/Optional

Optional

Mapping File Syntax

ESRIJSON_PROXY_URL www.someproxy.net

ESRIJSON_PROXY_URL www.someproxy.net:8080

Workbench Parameter

Http Proxy URL

PROXY_PORT

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, and it is ignored if the PROXY_URL directive has no value.

Required/Optional

Optional

Mapping File Syntax

ESRIJSON_PROXY_PORT 8080

Workbench Parameter

Proxy Port

PROXY_USERNAME

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.

Required/Optional

Optional

Mapping File Syntax

ESRIJSON_PROXY_USERNAME someusername

Workbench Parameter

Proxy Username

PROXY_PASSWORD

Specifies the password to use when accessing a password-protected proxy server.

This directive is ignored if there is no value for any of the PROXY_URL, PROXY_USERNAME or PROXY_AUTH_METHOD directives.

Required/Optional

Optional

Mapping File Syntax

ESRIJSON_PROXY_PASSWORD password1234

Workbench Parameter

Proxy Password

PROXY_AUTH_METHOD

Specifies the authentication method to use when accessing a password-protected proxy server. This directive is ignored if there is no value for any of the PROXY_URL, PROXY_USERNAME or PROXY_PASSWORD directives.

Required/Optional

Optional

Values

Basic | Digest | NTLM

Mapping File Syntax

ESRIJSON_PROXY_AUTH_METHOD Basic

Workbench Parameter

Proxy Authentication Method

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