Web Data Connector for ESRI REST API Metadata

Collection of Tableau Web Data Connectors (WDC) that enable Tableau to read metadata and data schemas/structures from nearly any openly-accessible ESRI REST server or portal. Data services include 'MapServer' and 'FeatureServer' only. Data sources are returned to Tableau with corresponding metadata and/or data structure/schemas to provide documentation of published service data structures and properties. Please note that these properties represent the published REST service properties and may not represent the underlying data structure with the source database.

• Connector in the collection:
  • dataSourceMetadata WDC
  • dataSchemas WDC
  • schemaSpec WDC

dataSourceMetadata WDC:

Web Data Connector Link:

https://GeoCodable.github.io/esriRestMetadataWDC/dataSourceMetadata

Description:

Tableau Web Data Connector (WDC) that returns a list of data sources available on an ESRI REST server or portal server. Data sources are listed alongside dataset level metadata properties.

Relationships:

The resulting Tableau data source table can be joined to the dataSchemas WDC data source table using the 'dataset_url' column as a foreign key (FK).

WDC Schema/Data Structure:

Click to view dataSourceMetadata WDC Schema

ID	TYPE	Primary Key	Foreign Key
api_rest_name	string
api_rest_url	string
api_directory	string
api_service	string
api_service_type	string
dataset_name	string
dataset_id	string
dataset_url	string	(PK)
dataset_type	string
dataset_description	string
dataset_capabilities	string
dataset_geometryType	string
dataset_geometryField	string
dataset_extent	string
dataset_sourceSpatialReference	string
dataset_supportsDatumTransformation	string
dataset_currentVersion	string
dataset_supportedQueryFormats	string
dataset_maxRecordCount	string
dataset_supportsPagination	string
dataset_supportsAdvancedQueries	string
dataset_useStandardizedQueries	string
dataset_supportsHavingClause	string
dataset_supportsCountDistinct	string
dataset_supportsOrderBy	string
dataset_supportsDistinct	string
dataset_supportsTrueCurve	string
dataset_supportsReturningQueryExtent	string
dataset_supportsQueryWithDistance	string
dataset_supportsSqlExpression	string
dataset_dateFieldsTimeReference	string
dataset_copyrightText	string
dataset_isDataVersioned	string
dataset_hasAttachments	string
dataset_supportsStatistics	string
dataset_supportsCoordinatesQuantization	string
dataset_totalRecords	string

Query Parameters:

• "esriRestUrl" (Required)

  • The "esriRestUrl" query parameters allow users to publish a WDC specific to a given ESRI REST API by providing the URL as a parameter.
    • Example: 'esriRestUrl=https://cartowfs.nationalmap.gov/arcgis/rest'

• "esriRestName" (Required)

  • A WDC name is also provided via the "esriRestName" parameter. Naming the WDC allows data source organization within Tableau/Tableau Server and tracking of multiple WDC's spanning different ERSI REST API's.
    • Example: 'esriRestName=The National Map'

• "getCounts" (Optional)

  • "getCounts" can be set to obtain record counts during the metadata collection if the method is available to the service. The "getCounts" parameter is optional with the allowed values/methods of 'exact' or 'approx'. The 'approx' method returns an estimated record count, but is slightly more efficient than the 'exact method which returns an accurate total.

    • Example: 'getCounts=exact'
    • Example: 'getCounts=approx'

  • Additional info on record counts:

    • the approx method (where=9999=9999) is only available with REST services with version 10.8.1 or higher.
    • See the ESRI REST documentation for more on returning record counts

Example URL with query parameters:

../esriRestMetadataWDC/dataSourceMetadata?esriRestUrl=https://cartowfs.nationalmap.gov/arcgis/rest&esriRestName=The National Map&getCounts=exact

How to use Web Data Connectors:

• For complete steps on adding data to Tableau via a Web Data Connector, reference the Connect to the data source section in Tableau's official documentation.

• To test and debug a Web Data Connector with parameters, use the Tableau WDC Simulator while using browser developer tools (Ctrl+Shift+I)

dataSchemas WDC:

Web Data Connector Link:

https://GeoCodable.github.io/esriRestMetadataWDC/dataSchemas

Description:

Tableau Web Data Connector (WDC) that returns the ESRI/ArcGIS field/column definitions and metadata by column name and data source URL. The returned values represent the ESRI field/column definitions applied to the service level including the data types, aliases, permissions, constraints, and domain properties. Please note that these properties represent the published service properties and may not represent the underlying data structure with the source database.

Relationships:

The dataSourceMetadata WDC can be joined to the resulting Tableau data source table using the 'dataset_url' column as a foreign key (FK).

WDC Schema/Data Structure:

Click to view dataSchemas WDC Schema

ID	TYPE	Primary Key	Foreign Key
dataset_url	string		(FK) - dataSourceMetadata WDC
dataset_name	string
column_alias	string
column_defaultValue	string
column_editable	string
column_length	string
column_name	string
column_nullable	string
column_type	string
domain_type	string
domain_name	string
domain_description	string
domain_codedValues	string
domain_range	string

Query Parameters:

• "esriRestUrl" (Required)

  • The "esriRestUrl" query parameters allow users to publish a WDC specific to a given ESRI REST API by providing the URL as a parameter.
    • Example: 'esriRestUrl=https://cartowfs.nationalmap.gov/arcgis/rest'

• "esriRestName" (Required)

  • A WDC name is also provided via the "esriRestName" parameter. Naming the WDC allows data source organization within Tableau/Tableau Server and tracking of multiple WDC's spanning different ERSI REST API's.
    • Example: 'esriRestName=The National Map'

Example URL with query parameters:

../esriRestMetadataWDC/dataSchemas?esriRestUrl=https://cartowfs.nationalmap.gov/arcgis/rest&esriRestName=The National Map

How to use Web Data Connectors:

• For complete steps on adding data to Tableau via a Web Data Connector, reference the Connect to the data source section in Tableau's official documentation.

• To test and debug a Web Data Connector with parameters, use the Tableau WDC Simulator while using browser developer tools (Ctrl+Shift+I)

schemaSpec WDC:

Web Data Connector Link:

https://GeoCodable.github.io/esriRestMetadataWDC/schemaSpec

Description:

Tableau Web Data Connector (WDC) that reads a defined schema specification (spec) data from a table hosted within ArcGIS Online or ArcGIS portal. The purpose of the schemaSpec WDC is to connect to a hosted table which contains information detailing a set of data standards listed by column name. The schema spec data details how columns of data are to be defined by column name. A template for the schema specification (spec) file geodatabase/table is available within the repo. Unzip the file geodatabase to load or attribute the data governance standards to the table via ArcGIS Pro or ArcGIS Portal/Online.

Relationships:

The resulting Tableau data source table can be joined to the dataSchemas WDC data source table using the 'column_name' column as a foreign key (FK).

WDC Schema/Data Structure:

Click to view schemaSpec WDC Schema

ID	TYPE	Primary Key	Foreign Key
OBJECTID	string	(PK)
column_alias	string
column_defaultValue	string
column_editable	string
column_length	string
column_name	string		(FK)
column_nullable	string
column_type	string
domain_codedValues	string
domain_description	string
domain_name	string
domain_range	string
domain_type	string
column_description	string
column_mandatory	string
parent_schema_id	string

Query Parameters:

• "schemaSpecUrl" (Required)

  • The "schemaSpecUrl" query parameters allow users to connect to a schema specification table hosted in ArcGIS Portal, Online, or REST server by providing the URL as a parameter.
    • Example: 'schemaSpecUrl=https://services.arcgis.com/bb8pZ67djVvqq9pIINtr/arcgis/rest/services/schema_spec_gdb/FeatureServer/0'

• "connName" (Required)

  • A WDC name is also provided via the "connName" parameter. Naming the WDC allows data source organization within Tableau/Tableau Server and tracking of multiple WDC's spanning different schema spec data sources.
    • Example: 'connName=Schema Spec 01'

• "specQuery" (Optional)

  • "specQuery" can be set to perform specialized queries aginst an ArcGIS Portal, Online, or REST server schema spec table. When unspecified, all records and all fields are retruned from the schema spec table.

    • Example: 'where=parent_schema_id=schema_spec_01&outFields=*&f=json'

    • See the ESRI REST documentation for more on query parameters

Example URL with query parameters:

../esriRestMetadataWDC/specQuery?schemaSpecUrl=https://services.arcgis.com/bb8pZ67djVvqq9pIINtr/arcgis/rest/services/schema_spec_gdb/FeatureServer/0&esriRestName=Schema Spec 01

How to use Web Data Connectors:

• For complete steps on adding data to Tableau via a Web Data Connector, reference the Connect to the data source section in Tableau's official documentation.

• To test and debug a Web Data Connector with parameters, use the Tableau WDC Simulator while using browser developer tools (Ctrl+Shift+I)