FME Transformers: 2025.0

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
ArcGISOnlineConnector
Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
ArcGISOnlineConnector

ArcGISAttachmentConnector

Connects to an ArcGIS Feature Service to manage attachments. Supports adding, updating, deleting, listing, and downloading attachments.

Jump to Configuration

Typical Uses

  • Attaching images, PDFs, or other files to ArcGIS Feature Service features
  • Updating or deleting existing attachments
  • Listing attachment metadata for validation or logging
  • Downloading attachments for local storage or further processing

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

The output of this transformer will vary depending on the Action performed. Attachment metadata and operation results are presented as feature attributes.

  • After an Add action: Output features represent successfully uploaded attachments with relevant IDs.
  • After a Delete action: Output features confirm the removal of specified attachments.
  • After a Download action: Output features contain the downloaded attachment data.
  • After a List action: Output features represent the metadata of the attachments linked to a feature. Each output feature corresponds to a single attachment.
  • After an Update action: Output features represent updated attachments with confirmation attributes.

The incoming feature is output through this port.

Features that cause the operation to fail are output through this port. An fme_rejection_code attribute describing the category of the error will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.

Note  If a feature comes in to the ArcGISAttachmentConnector already having a value for fme_rejection_code, this value will be removed.

Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.

Parameters

Connection

To create an ArcGIS connection, click the ArcGIS Connection drop-down box and select Add Web Connection....

The connection can then be managed via Tools > FME Options > Web Connections.

Action

The type of operation to perform. Choices include:

  • Add
  • Delete
  • Download
  • List
  • Update

Feature

Feature URL

URL to the feature where attachment operations will be performed. Follows this form:

https://<feature_service_url>/<layer_id>/<object_id_of_feature>

Esri ArcGIS Feature Service reader returns the feature URL in a format attribute, arcgisfeatureservice_feature_url, which may be used for the Feature URL.

Using GlobalIDs for ArcGIS Feature Service Attachments

ArcGIS REST endpoints always require an OBJECTID in the path—there’s no built-in way to use a GlobalID directly. Without an OBJECTID, attachment operations are not supported.

Data Source

Upload

Specify whether uploading from a file or a feature attribute.

File to Add

The file path containing the content to be uploaded if ‘Upload’ is ‘File’.

Attribute to Add as File

The attribute from which you want the content to be uploaded if ‘Upload’ is ‘Attribute’.

Metadata

Keywords

(Optional) Keywords for the attachment (if enabled in the feature service settings).

Add with Filename

The name of the uploaded file including the extension (i.e. file.txt) if ‘Upload’ is ‘Attribute’.

Added Attributes

These attributes will be added to the output features:

_attachment_id

The Object ID of the newly added attachment.

_global_id

The global ID of the newly added attachment.

Request

Delete All Feature Attachments

Whether or not to delete all existing attachments for the feature.

Feature

Feature URL

URL to the feature where attachment operations will be performed. Follows this form:

https://<feature_service_url>/<layer_id>/<object_id_of_feature>

Esri ArcGIS Feature Service reader returns the feature URL in a format attribute, arcgisfeatureservice_feature_url, which may be used for the Feature URL.

Using GlobalIDs for ArcGIS Feature Service Attachments

ArcGIS REST endpoints always require an OBJECTID in the path—there’s no built-in way to use a GlobalID directly. Without an OBJECTID, attachment operations are not supported.

Attachment ID

The ID of the attachment on which operations will be performed.

Added Attributes

These attributes will be added to the output features:

_attachment_id

The Object ID of the deleted attachment. This attribute is only outputted if the “Delete all for Feature” option is set to “No”

_total_attachments

Total number of attachments on the feature. This attribute is only outputted if the “Delete all for Feature” option is set to “Yes”

_attachments_deleted

Total number of attachments deleted. This attribute is only outputted if the “Delete all for Feature” option is set to “Yes”

_attachment_ids

List of deleted attachments. This attribute is only outputted if the “Delete all for Feature” option is set to “Yes”

_deletion_errors

List of attachments that were not deleted successfully alongside their respective errors. This attribute is only outputted if the “Delete all for Feature” option is set to “Yes”

Feature

Feature URL

URL to the feature where attachment operations will be performed. Follows this form:

https://<feature_service_url>/<layer_id>/<object_id_of_feature>

Esri ArcGIS Feature Service reader returns the feature URL in a format attribute, arcgisfeatureservice_feature_url, which may be used for the Feature URL.

Using GlobalIDs for ArcGIS Feature Service Attachments

ArcGIS REST endpoints always require an OBJECTID in the path—there’s no built-in way to use a GlobalID directly. Without an OBJECTID, attachment operations are not supported.

Attachment ID

The ID of the attachment on which operations will be performed.

Destination

Download as

Select whether to store the downloaded data in a File, Folder or Attribute.

  • File: The attachment will be stored in the specified folder.
  • Attribute: The attachment will be stored in the specified attribute.

Download to Folder

When Download as is File, specify the path to the folder that will store the attachment.

If File Exists

When Download as is File, whether to overwrite existing files in the target destination.

Download to Attribute

When Download as is Attribute, specify the attribute that will store the attachment.

Added Attributes

These attributes will be added to the output features:

_downloaded_path

The local path where the downloaded attachment is saved (if attachment is saved to a file).

_filename

The actual filename of the downloaded file.

_file_size

The size of the downloaded file in bytes.

_content_type

The MIME type of the downloaded file.

Feature

Feature URL

URL to the feature where attachment operations will be performed. Follows this form:

https://<feature_service_url>/<layer_id>/<object_id_of_feature>

Esri ArcGIS Feature Service reader returns the feature URL in a format attribute, arcgisfeatureservice_feature_url, which may be used for the Feature URL.

Using GlobalIDs for ArcGIS Feature Service Attachments

ArcGIS REST endpoints always require an OBJECTID in the path—there’s no built-in way to use a GlobalID directly. Without an OBJECTID, attachment operations are not supported.

Output Attributes

Attributes to Add

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

_attachment_id

The unique ID of each attachment found.

_attachment_name

The original filename of the attachment.

_attachment_size

The size of the attachment in bytes.

_content_type

The MIME type of the attachment (e.g., image/png).

_keywords

The keywords of the attachment.

_exifinfo

The EXIF data of the attachment. This field will be blank if the file format does not support EXIF data.

Feature

Feature URL

URL to the feature where attachment operations will be performed. Follows this form:

https://<feature_service_url>/<layer_id>/<object_id_of_feature>

Esri ArcGIS Feature Service reader returns the feature URL in a format attribute, arcgisfeatureservice_feature_url, which may be used for the Feature URL.

Using GlobalIDs for ArcGIS Feature Service Attachments

ArcGIS REST endpoints always require an OBJECTID in the path—there’s no built-in way to use a GlobalID directly. Without an OBJECTID, attachment operations are not supported.

Attachment ID

The ID of the attachment on which operations will be performed.

Data Source

Upload

Specify whether uploading from a file or a feature attribute.

File to Add

The file path containing the content to be uploaded if ‘Upload’ is ‘File’.

Attribute to Add as File

The attribute from which you want the content to be uploaded if ‘Upload’ is ‘Attribute’.

Metadata

Keywords

(Optional) Keywords for the attachment (if enabled in the feature service settings).

Add with Filename

The name of the uploaded file including the extension (i.e. file.txt) if ‘Upload’ is ‘Attribute’.

Added Attributes

This attribute will be added to the output features:

_attachment_id

The Object ID of the updated attachment.

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.

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.

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.

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  
History  

FME Community

The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.

Search for all results about the ArcGISAttachmentConnector 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.