Reader Directives

The directives processed by the Microsoft SharePoint reader are listed below. The suffixes listed are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the Microsoft SharePoint reader is SHAREPOINT.

These directives are exposed in Workbench as format settings through the Reader Parameters.

DATASET

Required/Optional

Required

Mapping File Syntax

SHAREPOINT_DATASET https://sharepoint.example.com

Workbench Parameter

Site

USER

Required/Optional

Required

Mapping File Syntax

SHAREPOINT_USER user

Workbench Parameter

Username

PASSWORD

Required/Optional

Required

Mapping File Syntax

SHAREPOINT_PASSWORD password

Workbench Parameter

Password

AUTHENTICATION

Required/Optional

Required

Mapping File Syntax

SHAREPOINT_AUTHENTICATION BASIC|NTLM|SAML|KERBEROS

Workbench Parameter

Authentication

INCLUDE_HIDDEN_LISTS

Indicates whether hidden (system-generated) lists are included when clicking the browse button beside the Lists reader parameter. These lists typically contain metadata pertaining to the SharePoint site and are not created by a user.

For example, there may be a hidden list called User Information List that contains information about user activity and permissions. The items of this list would be generated by SharePoint automatically and not manually edited by a user.

Required/Optional

Optional

Values

YES | NO (default)

  • NO: The reader returns 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 lists that are not hidden.
  • If this value is not specified, then NO is assumed.

  • YES: The reader returns all the schemas of the lists accessible to this user on the server, including hidden lists.

Mapping File Syntax

SHAREPOINT_INCLUDE_HIDDEN_LISTS YES|NO

Workbench Parameter

Include Hidden Lists

SHOW_ALL_FIELDS

Indicates whether the reader generates attributes from all fields of the selected list(s), or just the fields visible in the default view of the list(s). If NO, the schema for each feature type will match the set of fields that are included in the very first view (also known as the Default View) of the corresponding list on the SharePoint site.

Fields unsupported by the SharePoint Reader are also excluded from the schema. Refer to Field Type for a list of supported fields.

Required/Optional

Optional

Values

YES | NO (default)

  • NO: The reader returns the set of columns in the default view of each list selected for reading as attributes on the reader feature type.
  • If this value is not specified, then NO is assumed.

  • YES: The reader returns all of the columns in the default view of each list selected for reading as attributes on the reader feature type, with the exception of unsupported column types.

Mapping File Syntax

SHAREPOINT_SHOW_ALL_FIELDS YES|NO

Workbench Parameter

Show All Fields

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:

  • for Enterprise Geodatabases, FME will not return any schema features;
  • for Personal and File Geodatabases, 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