ArcGISOnlineConnector

Connects to Esri ArcGIS Online or Portal for ArcGIS to manage ArcGIS items.

Typical Uses

Managing datasets and supplementary files on ArcGIS Online or Portal for ArcGIS by uploading, downloading, publishing, sharing, and deleting files and folders
Transferring file contents into or out of an attribute in FME
Retrieving file and folder names, paths, links and other information from ArcGIS Online or Portal for ArcGIS for use elsewhere in a workspace
Retrieving or updating metadata

How does it work?

The ArcGISOnlineConnector uses either your ArcGIS Online or Portal for ArcGIS account credentials to perform various management tasks on Esri ArcGIS Online or Portal for ArcGIS:

Action	Task
Delete	Delete an item from a user’s own ArcGIS Online content.
Download	Download a file or folder to an attribute, file, or folder from a user’s ArcGIS content or group they have access to.
Get Details	Get details for an item, including its metadata.xml file.
List	List the item details for the contents of a group, a user’s folder, a user’s root folder, or all of a user’s content.
Publish	Publish an existing ArcGIS item as a feature service. See Publishing below.
Set Details	Update the details for an item or overwrite its metadata.xml file.
Share	Change the sharing level of a user’s ArcGIS Online content item or share it to additional groups.
Update	Update the contents of an existing ArcGIS item and optionally specify a new title or tags.
Upload	Upload a file or attribute to a location in a user’s ArcGIS Content.

Once valid account credentials have been provided, you may browse to available content for the selected Action.

Publishing

The following ArcGIS item types are supported for publishing with this transformer:

Shapefile
CSV
Microsoft Excel
Feature Collection
GeoJSON
File Geodatabase
Scene Package
SQLite Geodatabase
Image Collection
Service Definition
Tile Package
Compact Tile Package
Vector Tile Package

CSV and Excel files will be analyzed and have some publishing parameters auto-generated for them, which are logged at the info level.

For CSV files, ArcGIS will attempt to classify the file as containing either coordinate data, address data, lookup data, or no location data.

If a CSV file is classified as having location data but ArcGIS cannot determine which fields contain this data, the ArcGISOnlineConnector will log a warning and publish the CSV file as though it does not contain any location data. The resulting feature service will be a table.

Usage Notes

This transformer cannot move or copy files between different locations. Consider using multiple connectors for these tasks, by downloading files/folders and re-uploading them to a new location.
Uploading data to ArcGIS is performed via synchronous multipart upload. Each file chunk is 20MB. The connector will upload these chunks consecutively. If a chunk upload fails, the connector will retry each upload up to five times.
Early termination of translations during Publish, Update, or Upload actions may result in malformed ArcGIS item entries. When publishing, a feature service may be created but any title or tags specified for it may not be honored. When updating or uploading, it is possible for the metadata to be uploaded before the file content has been uploaded.
The FeatureReader can access online ArcGIS content directly but does not download a local copy of the dataset.

Configuration

Input Ports

Output Ports

Output

Features with added attributes, as specified in parameters and according to Action:

Action	Output
Delete	Input feature unchanged.
Download	Input feature with details about the downloaded item.
Get Details	Input feature with metadata details about the specified item.
List	Multiple features, one for each item in the specified path, with details about the items.
Publish	Input feature with details about the published item.
Set Details	Input feature with details about the updated item.
Share	Input feature unchanged.
Update	Input feature with details about the updated item.
Upload	Input feature with details about the uploaded item.

Parameters

Request

Action

Select an operation to perform. Choices include:

Delete
Download
Get Details
List
Publish
Set Details
Share
Update
Upload

Action > Delete

Content Source

Path

Specify the ArcGIS Item ID of the file or folder to be deleted.

Note that:

The user must be the owner of the item.
The root folder of a user’s content cannot be specified for deletion.
If the specified folder contains a delete-protected item, all items in the folder which are not protected will be deleted. The folder and the protected item(s) will remain and the input feature will be output via the <Rejected> port.
If an invalid item/folder ID is specified, an API error will be logged but the input feature will not be rejected.

Delete Options

Delete Permanently

Select a preferred deletion method:

Yes: The item/folder will be deleted permanently.
No (Default): The item/folder will be moved to the recycle bin.

On ArcGIS Online, items can be moved to a recycle bin for 14 days before permanent deletion.

The recycle bin is only available for ArcGIS Online organizations that have enabled it. It is not available for all item types - for a list of exclusions, see ArcGIS - Why don't all the items I delete go to the recycle bin?

If the site or installation does not support the recycle bin, items will be permanently deleted regardless of this parameter setting.

Output Attributes

No attributes are added for this Action.

Action > Download

Content Source

Select the download source:

User: The user’s own ArcGIS content
Group: A group the user is a member of or a group in their organization that they have access to

Group ID

When Content Source is Group, specify the group identifier.

Path

Specify the ArcGIS Item ID of a file or folder to download.

Destination

Download as	Select a destination type for downloaded items: File: Items will be stored in the Download to Folder location. Filenames are the ArcGIS title of the object and original extension. Any file-unsafe characters are replaced with underscores (_). Folder: The downloaded folder and its contents will be stored in the Download to Folder location. When Content Source is Group the created folder is named after the group. When Content Source is User the created folder has the same name as the target folder. When Path is a root folder, the contents are not nested inside a content folder - they are downloaded directly to the Download to Folder location. Attribute: The downloaded item is stored in the specified attribute. System encoding is assumed - add an AttributeEncoder if a specific encoding type is required.
Download to Attribute	When Download as is Attribute, specify the attribute to contain the contents of the downloaded item. Encoding FME will attempt to convert the attribute's contents to a UTF-8 string. If this fails, the attribute's contents will be created as raw binary. To ensure that the original bytes are always preserved and never converted to UTF-8, use Download as >File instead.
Download to Folder	When Download as is File or Folder, specify the path to the folder that will store the downloaded item.
If File Exists	When Download as is File or Folder, select a method for handling existing files: Reject: Leave the existing file intact and output the feature via the <Rejected> port. Overwrite: Overwrite the existing file.
Include Subfolders	When Download as is Folder, select a method for handling subfolders: Yes: Include all subfolders No: Do not include subfolders. ArcGIS content is structured such that only the root folder contains subfolders.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_download_path

Path the file/folder was downloaded to. If a folder, the path includes a trailing slash.

Action > Get Details

Content Source

Select the item source:

User: The user’s own ArcGIS content
Group: A group the user is a member of or a group in their organization that they have access to

Group ID

When Content Source is Group, specify the group identifier.

Path

Specify the ArcGIS Item ID of the item.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_access_use_constraints	License information or restrictions for the object.
_credits	Attribution information for the ArcGIS object as well as its copyright status
_description	Description of a stored ArcGIS object.
_extent	Bounding box for an item. Coordinates are in WGS84 and are provided in the form [[minX, minY], [maxX, maxY]]
_filename	Name of the file associated with the stored object, if one exists.
_id	ID of the ArcGIS object or feature service.
_item_type	ArcGIS type of a stored ArcGIS object. File only.
_metadata_xml	The metadata.xml file associated with the ArcGIS object. If one does not exist, this attribute will be set to NULL.
_name	Title of a stored ArcGIS object.
_summary	Summary description of a stored ArcGIS object.
_tags	Comma-separated list of the tags associated with an object.
_thumbnail_url	Link which can be used to access the thumbnail image for the item.
_type_keywords	Comma-separated list of keywords which describe the type of the object. This includes keywords determined based on its ArcGIS item type as well as user defined keywords, if any exist.

Action > List

Content Source

Content Source	Select the source of the content: User: The user’s own ArcGIS content Group: A group the user is a member of or a group in their organization that they have access to
Group ID	When Content Source is Group, specify the group identifier.
User Content Folder	When Content Source is User, specify the ArcGIS Item ID of the folder, or / for root.
Include Subfolders	When Content Source is User, select a method for handling subfolders: Yes: Include all subfolders No: Do not include subfolders. ArcGIS content is structured such that only the root folder contains subfolders.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_created	Creation time (UNIX timestamp) of a stored ArcGIS object.
_file_or_folder	Type (file or folder) of a stored ArcGIS object.
_file_size	Size of a stored ArcGIS object (in bytes). File only.
_file_type	File extension of a stored ArcGIS object. (for example, ‘zip’ or ‘csv’) File only, and only if the file is downloadable.
_id	ID of the ArcGIS object or feature service.
_is_downloadable	A flag (Yes/No) depending on whether or not the ArcGISOnlineConnector can be used to download this object. File only.
_item_type	ArcGIS type of a stored ArcGIS object. File only.
_json_response	JSON response provided directly from the API for this item.
_last_modified	Last modified time (UNIX timestamp) of a stored ArcGIS object. File only.
_name	Title of a stored ArcGIS object.
_private_url	Link to an ArcGIS object or feature service. If the object is an item, this will direct the user to the ArcGIS web content page for their item. If the object is a folder, this will direct the user to the ArcGIS web content listing of items for their folder.
_sharing_permissions	Level of access to the item (private, shared, org, public). A ‘shared’ item is an item that has its sharing level set to private but has been shared to groups. File only.
_tags{}	A list attribute containing the tags associated with an item. File only.
_webservice_url	Feature service URL. Only valid for feature-service-type ArcGIS items.

Action > Publish

Publishing Options

Content Source	Specify the Item ID of a stored ArcGIS file to publish. Note that: The user must be the owner of this item. The item should not already have a feature service published from it. If a feature service already has been published from an item, the connector will reject and the id of the existing feature service will be provided in the _conflicting_id rejection attribute.
Feature Layer Title	Specify a name for the newly created feature layer in ArcGIS. If blank, the published item will use the existing title of the source item. The title should be unique in the user’s organization.
Feature Layer Tags	Specify any tags that the published feature layer should have in ArcGIS. If blank, the existing tags of the source item are used.
Coordinate System	Specify the target spatial reference of the created feature service. If unspecified, the default WKID 102100 is used.

Wait Behavior

Wait for Publish Processing

Select an option for publishing completion:

Yes: Wait for the Processing Timeout duration and reject or pass the feature depending on the success of the publish operation.
No: Make the publish request and pass or fail depending on the success of that request.

Processing Timeout (s)

When Wait for Publish Processing is Yes, specify the amount of time in seconds to wait for the feature layer to publish.

If not specified, the default of 180 seconds is used.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_id	ID of the ArcGIS object or feature service.
_private_url	Link to an ArcGIS object or feature service. If the object is an item, this will direct the user to the ArcGIS web content page for their item. If the object is a folder, this will direct the user to the ArcGIS web content listing of items for their folder.
_service_type	Type of service created with the publish operation.
_webservice_url	Feature service URL. Only valid for feature-service-type ArcGIS items.

Action > Set Details

Content Source

Path	Specify the ArcGIS Item ID of the file to have metadata updated. The user must own the item being updated.

Details

Operation

Select an updating method:

Update Fields (Default): Modify individual fields in the target item’s details.
Replace Metadata XML: Replace the metadata.xml file associated with the target item.

XML Metadata Attribute

When Operation is Replace Metadata XML, specify the attribute containing XML content to upload as a metadata file.

Fields

When Operation is Update Fields, provide values for any fields to be updated.

If a field is left blank, it will not be updated on the item. If it is set to NULL, the field will be cleared.

Title	Specify a new title for the target item.
Tags	Specify new tags for the target item. Tags should be provided as a comma separated list.
Summary	Specify a new summary for the target item.
Description	Specify a new description for the target item.
Credits	Specify new attribution information for the target item as well as its copyright status.
Access and Use Constraints	Specify new license information or use restrictions for the target item.
Type Keywords	Specify new type keywords for the target item. Type keywords should be provided as a comma separated list. Note that updating this value only updates user-defined type keywords. Keywords associated with the ArcGIS Item Type will still remain.
Thumbnail URL	Set a new thumbnail for the target item. This should be provided using a URL to the image.
Extent	Set the bounding box for an item. Coordinates should be in WGS84 and must be provided in the form minX, minY,maxX, maxY.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_id	ID of the ArcGIS object or feature service.
_private_url	Link to an ArcGIS object or feature service. If the object is an item, this will direct the user to the ArcGIS web content page for their item. If the object is a folder, this will direct the user to the ArcGIS web content listing of items for their folder.

Action > Share

Content Source

Path	Specify the ArcGIS Item ID of the file to share.

Sharing

Share Level

Select the sharing level to apply:

Owner: The item will only be accessible to the user and any groups it has been shared to.
Organization: The item will be accessible to the user and anyone else in their organization. If a user does not belong to an organization, behavior for this option is undefined.
Everyone (Public): The item will be visible to everyone. Sharing to everyone will automatically share to the organization as well, unless a user does not belong to an organization.

Share to Additional Groups

Specify any additional groups to share the item to by listing Group IDs separated by spaces.

Pre-existing group shares are not affected.

If any specified group cannot be shared to, the feature is rejected and the unsuccessful groups are logged. Any valid groups will still be shared to.

Output Attributes

No attributes are added for this Action.

Action > Update

Content Source

Path	Specify the ArcGIS Item ID of a file or folder to update.

Data Source

Upload

Select the source type:

File: The specified file will be uploaded as the new content.
Attribute: The contents of the specified attribute will be uploaded as the new content.

Note that when working with large objects, File is generally the better choice as the data will be read from disk and not need to be held in memory.

File to Upload

When Upload is File, specify the file to be uploaded.

The file type (extension) must match that of the target update item or the feature will be rejected.

Attribute to Upload as File

When Upload is Attribute, specify the attribute containing the content for upload.

Metadata

Title	Optionally specify a new title for the target item.
Tags	Optionally specify new tags for the target item, as a comma-separated list.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_id	ID of the ArcGIS object or feature service.
_private_url	Link to an ArcGIS object or feature service. If the object is an item, this will direct the user to the ArcGIS web content page for their item. If the object is a folder, this will direct the user to the ArcGIS web content listing of items for their folder.

Action > Upload

Data Source

Upload	Select the source type: File: Upload a file. Attribute: Upload the contents of an attribute. URL: Upload the URL of an item. Note that when working with large objects, File is generally the better choice as the data will be read from disk and not need to be held in memory.
File to Upload	When Upload is File, specify the file to be uploaded.
Attribute to Upload as File	When Upload is Attribute, specify the attribute containing the content for upload.
URL	When Upload is URL, specify the URL of the item to be submitted. URLs can link to a service, a web mapping application, or any other supported content.

Metadata

Title	Specify a name for the uploaded item.
Item Type	When Upload is File or Attribute, specify the type of item being uploaded by either Use File Extension (default) or explicitly choosing a supported type. Where possible, the file extension is used to determine the item type. Zip files need to be identified explicitly. If no valid item type can be determined or the file extension does not match the specified type, the feature is rejected. For a list of item types which ArcGIS Online supports for upload, see Items supported in ArcGIS Online.
URL Item Type	When Upload is URL, specify the type of resource the URL links to. For a list of supported types using a URL, see Add layers from a URL. This transformer does not support these types: ArcGIS Server web service OGC Feature Layer GeoJSON
Tags	Specify tags for the created item, as a comma-separated list.

Content Destination

User Content Folder

Specify the ArcGIS folder ID to upload to.

The name of a user’s ArcGIS Folder can also be used, provided that it does not conflict with the ID of an existing folder. If no such folder exists, one with that name will be created.

Filenames must be unique within ArcGIS content folders. If an item already exists in the folder with the same filename, the feature will be rejected with the ID of the conflicting item in the _conflicting_id attribute.

Upload with File Name

When Upload is Attribute, specify the filename, including extension, to contain the uploaded content.

Output Attributes

Attributes to Add

Select any available attributes to be included on the output features:

_id	ID of the ArcGIS object or feature service.
_private_url	Link to an ArcGIS object or feature service. If the object is an item, this will direct the user to the ArcGIS web content page for their item. If the object is a folder, this will direct the user to the ArcGIS web content listing of items for their folder.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

How to Set Parameter Values

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

Content Types

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters	Create your own editable parameters.

Dialog Options - Tables

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

Add a row
Remove a row
Move current row up one
Move current row down one
Move current row to top
Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

Cut a row - delete and copy to clipboard
Copy a row to the clipboard
Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior	Feature-Based
Feature Holding	No
Dependencies	Esri Access
Aliases	AGOLConnector ArcGISPortalConnector
History	Released FME 2020.1

FME Online Resources

The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.

Search for all results about the ArcGISOnlineConnector on the FME Community.

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.

ArcGISOnlineConnector

Typical Uses

How does it work?

Publishing

Usage Notes

Configuration

Input Ports

Output Ports

Parameters

Content Source

Delete Options

Output Attributes

Content Source

Destination

Encoding

Output Attributes

Content Source

Output Attributes

Content Source

Output Attributes

Publishing Options

Wait Behavior

Output Attributes

Content Source

Details

Output Attributes

Content Source

Sharing

Output Attributes

Content Source

Data Source

Metadata

Output Attributes

Data Source

Metadata

Content Destination

Output Attributes

Editing Transformer Parameters

Defining Values

Using the Text Editor

Using the Arithmetic Editor

Conditional Values

Content

Table Tools

Reference

FME Online Resources