FME Transformers: 2025.2 BETA

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
GoogleDriveConnector
S3Connector
SharePointOnlineConnector
Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
GoogleDriveConnector
S3Connector
SharePointOnlineConnector

AutodeskDocsConnector

Connects to Autodesk Docs, Autodesk Construction Cloud or Autodesk Build to manage files and folders.

Jump to Configuration

Typical Uses

  • Managing files on Autodesk Docs by uploading, downloading, and deleting files and folders
  • Transferring file contents into or out of an attribute in FME
  • Retrieving file and folder names, paths, and other information from Autodesk Docs to use elsewhere in a workspace.

How does it work?

The AutodeskDocsConnector uses your Autodesk account credentials to perform various management tasks on Autodesk Docs:

Action Task

Delete

Delete files and folders.

Download

Download a file or folder to an attribute, file, or folder.

List

List the item details for the contents of a folder.

Upload

Upload a file, folder, or the contents of an attribute.

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

Authentication

Autodesk authentication has two components -

  • One-time addition of FME in the Autodesk App Store.
  • Creating a Web Connection in FME for recurring authentication.

See Using Web Connections and Adding FME through the Autodesk App Store for Use in the AutodeskDocsConnector.

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.

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

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

Action Output

Delete

Input feature unchanged.

Download

Input feature unchanged.

List

Multiple features, one for each item in the specified location, with details about the items.

Upload

Input feature with details about the uploaded item.

Input features are output here unmodified, in addition to any other output locations (Output or <Rejected>).

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 which contains more specific details as to the reason for the failure.

If an Input feature already has 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

Account

Select or create a Web Connection, connecting to the Autodesk Docs Web Service

See Using Web Connections.

Note that FME must be added to the Autodesk App Store prior to using the web connection - see Authentication above.

Action

Select an operation to perform. Choices include:

  • Delete
  • Download
  • List
  • Upload

Retry on Failure

When enabled, checks if the response has a Retry-After header specifying how long to wait and adheres to that when available. Otherwise it retries after 1 second, and doubles the wait time for each consecutive retry.

Retries

Specify how many times the request should be retried in the case of a failure.

Delete Options

Hub

Specify the ID of the Autodesk Docs Hub.

Project

Specify the Project of interest within the Hub.

Item

Specify the ID of the file or folder on Autodesk Docs to delete.

Autodesk Docs prohibits deleting the root directory of a project, as well as the top-level Plans and Project Files folders.

Output Attributes

No attributes are added for this Action.

Download Options

Hub

Specify the ID of the Autodesk Docs Hub.

Project

Specify the Project of interest within the Hub.

Item

Specify the ID of a file or folder on Autodesk Docs to download.

Destination

Download as

Select a destination type for downloaded items:

  • Attribute: The downloaded object will be stored in the specified attribute.
  • File: The downloaded file will be stored in the specified folder.
  • Folder: The downloaded folder object will be stored in the specified folder.

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.

Response Body Encoding

When Download as is Attribute, select an encoding method.

Options include various character set encodings which ensure the output is in a human-readable form.

If Auto Detect from HTTP Header is specified but there is no encoding in the Content-Type metadata associated with the data, the output will be returned as raw bytes.

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.
Note  Viewable files in the Plans directory are not supported for download.

Output Attributes

No attributes are added for this Action.

List Options

Hub

Specify the ID of the Autodesk Docs Hub.

Project

Specify the Project of interest within the Hub.

Folder

Specify the ID of a folder on Autodesk Docs to list the contents of.

Include Subfolders

Select a method for handling subfolders:

  • Yes: Include all subfolders
  • No: Do not include subfolders.

Output Attributes

Attributes to Add

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

_created

Date and time when the file was created.

_created_by

Name of user who created the file or folder.

_extension

The extension of the file.

_file_or_folder

Whether the item is a file or a folder.

_file_size

The size of the file in bytes.

_full_path

Full path of the file or folder, from the root of the project.

_hub

The Hub ID of the file or folder.

_id

Item id of the file or folder.

_last_modified

Date and time when the file was last modified.

_last_modified_by

Name of user who last modified the file or folder.

_name

Name of the file or folder.

_project

The Project ID of the file or folder.

_source_file_name

If the file is a viewable under the Plans directory (an automatically extracted Revit view, for example) this will be the name of the source file it was extracted from.

_version_number

The version number of the file.

Data Source

Upload

Select the source type:

  • Attribute: Upload the contents of an attribute.
  • File: Upload a file.
  • Folder: Upload a folder and its contents.

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.

Folder to Upload

When Upload is Folder, specify the folder to be uploaded.

Include Subfolders

When Upload is Folder, select a method for handling subfolders:

  • Yes: Upload all subfolders
  • No: Do not include subfolders.

Attribute to Upload as File

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

Upload Options

Hub

Specify the ID of the Autodesk Docs Hub.

Project

Specify the Project of interest within the Hub.

Upload with File Name

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

If File Exists

Select a method of handling conflicts with existing files at the upload location:

  • Create New Version: The new file is uploaded as a new version of the existing file.
  • Reject: If uploading a file, the input feature will be rejected.
  • Overwrite: Any existing files or folders will be overwritten by the uploaded items.
Note  Files uploaded to Autodesk Docs are processed before being published and so will not be immediately viewable after uploading. There are also restrictions on what file types may be uploaded. See Autodesk Docs Supported Files on Web.

Output Attributes

Attributes to Add

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

_created

Date and time when the file was created.

_created_by

Name of user who created the file or folder.

_extension

The extension of the file.

_file_or_folder

Whether the item is a file or a folder.

_file_size

The size of the file in bytes.

_full_path

Full path of the file or folder, from the root of the project.

_hub

The Hub ID of the file or folder.

_id

Item id of the file or folder.

_last_modified

Date and time when the file was last modified.

_last_modified_by

Name of user who last modified the file or folder.

_name

Name of the file or folder.

_project

The Project ID of the file or folder.

_source_file_name

If the file is a viewable under the Plans directory (an automatically extracted Revit view, for example) this will be the name of the source file it was extracted from.

_version_number

The version number of the file.

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 Autodesk Docs, Autodesk Construction Cloud (ACC), or Autodesk Build Account, recommended to have a Forge App with access to the Data Management API
Aliases AutodeskBIM360DocsConnector AutodeskConstructionCloudConnector
History  

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 AutodeskDocsConnector 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.