FME Transformers: 2024.1

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

TrimbleConnectConnector

Accesses the Trimble Connect platform to upload, download, list, or delete data from a Trimble Connect account.

Jump to Configuration

Typical Uses

  • Upload, download, list, or delete data from a Trimble Connect account
  • Transfer data from Trimble Connect to an attribute in FME, or vice versa
  • Retrieve data from a Trimble Connect account for use elsewhere in a workspace

How does it work?

The TrimbleConnectConnector uses your Trimble Connect account credentials (either via a previously defined FME web connection, or by setting up a new FME web connection right from the transformer) to access the Trimble Connect platform.

Depending on your choice of actions, it will upload or download files, folders, and attributes; list out Trimble Connect files; or delete items from the service. On uploads, link attributes are added to the output features. On List actions, links and file/folder information are added as attributes.

Usage Notes

  • There is a maximum length of 255 characters for folder and file names
  • The upload size limit for a single file is 5GB.
  • Files larger than 5MiB will be uploaded via multipart upload. Each part is 250MB.
  • As described in the Trimble Connect API documentation, the upload will be marked as “EXPIRED” (and the feature rejected) if the file is not uploaded within 90 minutes for single-part upload.
  • This transformer cannot be used to directly move or copy files between different Trimble Connect locations. However, multiple TrimbleConnectConnectors can be used to accomplish these tasks.
  • The FeatureReader can access Trimble Connect directly (without using the TrimbleConnectConnector), however, a local copy of the dataset will not be created.

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

The output of this transformer will vary depending on the action performed.

  • After an Upload action, the ID of the file will be saved to an attribute.

  • A Download action can save to a file, a folder, or an attribute.

  • A Delete action has no output to this port.

  • A List action will output a new feature for each file/folder found in the path specified. Each of these new features will have attributes listing various pieces of information about the object.

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 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 TrimbleConnectConnector 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

Trimble Connect Account

Performing operations against a Trimble Connect account requires the use of OAuth2 authentication using a Web Connection.

To create a Trimble Connect connection, click the 'Trimble Connect Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections.

Region

Either provide a valid Trimble Connect server URL or select the server region to use.

Choices include:

  • North America

  • Europe

  • Asia

  • Australia

Action

Select the operation to perform. Choices include:

  • Delete
  • Download
  • List
  • Upload

The remaining parameters available depend on the value of the Action parameter. Parameters for each Action are detailed below.

Source

Project ID

The Trimble Connect ID of a project.

Object ID

The Object ID of a file or folder on Trimble Connect to delete. If valid credentials have been provided as a web connection, you may browse to a location.

Source

Project ID

The Trimble Connect ID of a project.

Object ID

The Object ID of a file or folder on Trimble Connect to download. If valid credentials have been provided as a web connection, you may browse to a location.

Destination

Download as

Select whether to store the downloaded data in a file, folder, or attribute.

  • Attribute: The downloaded object will be stored in the specified attribute. Note that this will always assume system encoding. Use the AttributeEncoder if your contents need to be a specific encoding type..
  • File: The downloaded file will be stored in the specified folder.
  • Folder: The downloaded folder object will be created and stored inside the specified folder. If the root folder was specified for download, the contents of the root folder will be nested in a folder named with the project name.

Download to Folder

Specify the path to the folder that will store the downloaded file. Valid for Download as File or Folder.

Download to Attribute

Specify the attribute that will store the contents of the downloaded file. Valid for Download as Attribute only.

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

If File Exists

Whether to overwrite existing files in the target destination. Valid for Download as File or Folder. Default is set to Overwrite.

Include Subfolders

Whether to include subfolders when downloading a folder. Valid for Download as Folder. Default is Yes.

Output Attributes

The selected attributes will be added to the output feature.

Attributes to Add

_download_path

Path of the downloaded object on the local file system. This attribute will not be added for Download as Attribute.

Source

Project ID

The ID of a Trimble Connect project.

Folder ID

The folder ID on Trimble Connect to list the contents of. If valid credentials have been provided as a web connection, you may browse to a location. The folders available for listing all belong to the selected project.

Include Subfolders

Choose whether to list contents of subfolders. Default is set to ‘Yes’.

Output Attributes

Attributes to Add

Select available attributes to be included:

_id

Return the ID of a stored Trimble Connect object.

_name

Return the name of a stored Trimble Connect object.

_file_or_folder

Return the type (file or folder) of a stored Trimble Connect object.

_created

Return the creation time (UNIX timestamp) of a stored Trimble Connect object.

_last_modified

Return the last modified time (UNIX timestamp) of a stored Trimble Connect object.

_size

Return the size of a stored Trimble Connect object (in bytes).

_path

Return path of the Trimble Connect object from the root directory of the selected Trimble Connect project.

_project_id

Return the ID of the project that the Trimble Connect object belongs to.

_tags

Return a Trimble Connect object’s tags in a comma separated string.

_json_response

Return full json response returned from the Trimble Connect API call.

Source

Upload

The type of data to be uploaded.

  • File: The specified file will be uploaded.

  • Folder: The specified folder and its contents will be uploaded.

  • Attribute: The contents of the specified attribute will be uploaded.

When working with large objects, File is a better choice than Attribute as the data will be streamed directly from disk and not require that the object be stored entirely in memory on a feature.

If uploading a file that already exists in the destination, the existing Trimble Connect file will be updated and its version will increment.

If uploading a folder that already exists in the destination, the feature will be rejected with an fme_rejection_code attribute.

File to Upload

The file to be uploaded to Trimble Connect if Upload is set to File.

Folder to Upload

The folder to be uploaded to Trimble Connect if Upload is set to Folder.

Include Subfolders

Choose whether to upload subfolders of the Folder to Upload or not.

Attribute to Upload as File

The data to be uploaded, supplied from an attribute if Upload is set to Attribute.

Destination

Project ID

The ID of a Trimble Connect project.

Folder ID

The path on Trimble Connect to upload the source file to. To upload to the root directory, enter “/”.

Upload with File Name

The name of the file created from the data supplied in Attribute to Upload as File. The name must include a filename extension (for example, .dwg, .rvt, .pdf).

Output Attribute

Attributes to Add

_id

Returns the ID of the target item which was just created.

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 Trimble Connect account
Aliases TrimbleConnector
History Released FME 2023

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

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