Esri ArcGIS Online (AGOL) Feature Service Reader/Writer
Licensing options for this format begin with FME Professional Edition.
The Esri ArcGIS Online Feature Service Reader/Writer plug-in enables FME to read and write features from a Feature Service hosted on the ArcGIS Online cloud service.
Note: A valid ArcGIS Online account is required to access ArcGIS Online.
A free trial can be obtained at http://www.esri.com/software/arcgis/arcgisonline/evaluate.
For more information, see Esri GeoServices REST Specification.
Overview
ArcGIS Online is a platform for sharing and publishing geospatial data to the public, or privately within an organization. Data uploaded to ArcGIS Online can then be visualized on the web.
ArcGIS Online supports many different kinds of data. FME’s ArcGIS Online Feature Service Reader/Writer only exposes Feature Services available under an ArcGIS Online user’s account.
In FME, an ArcGIS Online Feature Service is a required format parameter, and a layer or table within a Feature Service is a feature type.
ArcGIS Online requires HTTPS access. If you are connecting via a proxy server, ensure that it supports HTTPS.
Duplicate Layer Names
ArcGIS Online allows for duplicate layer names within a Feature Service.
The ArcGIS Online Feature Service Reader resolves ambiguity by appending the layer ID to the end of feature types if multiple layers share the same name. If a layer ID is present in the feature type, the ID takes precedence over the name.
Authentication
The ArcGIS Online Feature Service Reader/Writer uses the supplied username and password to obtain an access token. The access token is used to authenticate all subsequent requests during a translation.
To read directly from To read directly from a Feature Service without authentication, or with a manually-supplied token, use the Esri ArcGIS Feature Service Reader.
Reader Overview
The ArcGIS Online Feature Service Reader reads features from the layers in a Feature Service. ArcGIS Online returns features in JSON format, which is converted into an FME feature.
Each layer contains features of a single geometry type. Tables are effectively layers that have no geometry.
Although ArcGIS Online Feature Services may support Z-values and measures, the ArcGIS Online Feature Service Reader cannot read such values at this time.
Writer Overview
The ArcGIS Online Feature Service Writer uses the ArcGIS REST API to create Feature Services and write features.
When writing to an existing Feature Service, it is strongly recommended that you select Writer > Import Feature Types in order to obtain the schema for all layers in the Feature Service.
In particular, publishing a Feature Service can result in changes to the schema of feature types. See the Troubleshooting section for details.
INSERT, UPDATE, DELETE operations are all combined into a single request per feature type, issued in batches of requests based on a configurable number of features. If the operation for any single feature fails within a batch, then all other write operations in that batch are automatically rolled back by the server, and the translation aborts. If ArcGIS Online returns an error for any write operation, the ArcGIS Online Feature Service Writer will pass the error messages to the log.
If the destination Feature Service layer supports Z or M values, the ArcGIS Online Feature Service Writer can write them. However, it is currently not possible to create Feature Service layers with Z or M support.
Feature Service Creation
If the Feature Service directive refers to a Feature Service that does not exist, and the writer mode for all feature types is INSERT, then the ArcGIS Online Feature Service Writer will create the Feature Service. The mechanics of this operation differ significantly from writing to an existing Feature Service:
- All features are written to Shapefiles.
- The Shapefiles are compressed into a single ZIP file, and uploaded to ArcGIS Online as a Shapefile Item.
- The Shapefile Item is published as a Feature Service.
The mechanism for this operation differs significantly from the case of writing to an existing Feature Service. The Shapefile Item remains on the Portal after the Feature Service is published from it. The Feature Service has no dependency on the Shapefile Item, so it is safe to delete it.
WARNING: Due to the Shapefile creation step, the limitations of the Esri Shape format apply when creating a new Feature Service. In order to prevent commonly-encountered problems, the ArcGIS Online Feature Service Writer will enforce some of Shape’s attribute name constraints, such as capitalization and length.
Note: When creating a Feature Service comprised of a single layer (feature type), ArcGIS Online may adopt the Feature Service's name as the layer's name, instead of using the feature type name. Workbench will not reflect this change unless feature types are re-imported after Feature Service creation.
Object (Feature) IDs
When a Feature Service is created, ArcGIS Online will add to all layers a new field that serves as the primary key. This is called the Object ID field. Typically, ArcGIS Online will name this field “FID”, but it is possible for layers to have a different name for its Object ID field. Note that the value of this field is always assigned by ArcGIS Online: values provided for this attribute during INSERTs are ignored by the server.
When in UPDATE or DELETE mode, a value must be provided for the attribute that corresponds to the Object ID field. If the attribute is not present, the writer will output an error message that specifies the name of the required attribute.
Layer Creation
Layers can only be created as part of creating a Feature Service. Creating new layers in an existing Feature Service is not supported at this time. Feature types that do not correspond to a layer in an existing Feature Service will result in an error.