FME Transformers: 2024.2
FME Transformers: 2024.2
CesiumIonConnector
Uploads a folder dataset to the Cesium ion service as a new asset.
How does it work?
The CesiumIonConnector uses your Cesium ion 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 service.
A folder containing one of :
- A CityGML file and a textures subdirectory
- GeoTIFF files
- LAS files
- OBJ files
is supported for upload.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
Features that have successfully uploaded the specified folder to Cesium ion are output through this port.
The feature will have the following attributes added on to it that represent information about the request to Cesium ion and the created asset.
_cesiumion_url |
The URL of the new asset |
_cesiumion_id |
Numerical ID of the new asset |
_cesiumion_user_id |
ID of the user account |
_cesiumion_type |
The type of asset. One of 3DTILES, IMAGERY, or TERRAIN. |
_cesiumion_name |
The name of the new asset |
_cesiumion_description |
The description for the new asset |
_cesiumion_bytes |
Number of bytes uploaded |
_cesiumion_date_added |
Date the asset was added |
_cesiumion_status |
Cesium ion processing status. One of NOT_STARTED, IN_PROGRESS, COMPLETE or ERROR |
_cesiumion_percent_complete |
Processing percent complete |
Initiator
The incoming feature is output through this port.
<Rejected>
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, 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 CesiumIonConnector 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
Authentication
Cesium ion Account |
To create a Cesium ion connection, click the 'Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections. |
Request
Action |
The type of operation to perform. Choices include:
|
The remaining parameters available depend on the value of the Request > Action parameter. Parameters for each Action are detailed below.
Parameters - Delete Action
Options
Asset ID |
The Cesium ion asset to delete. |
Parameters - Upload Action
Options
Source Folder |
The path to the folder to upload as an asset. The folder should contain one of :
|
Asset Name |
The name to give the new asset on Cesium ion. |
Asset Description |
The description to give the new asset on Cesium ion. |
Wait Behavior
Wait for ion Processing |
If this option is set to Yes, FME will wait for Cesium ion to finish processing the uploaded asset. |
Processing Timeout (s) |
The maximum amount of time, in seconds, to wait for Cesium ion asset processing to complete. The translation will still succeed if the timeout is reached, but the uploaded asset is not guaranteed to be ready for use. |
Manual Georeferencing
If checked, specify a latitude, longitude and height in order to georeference an unreferenced OBJ file. Has no effect on other formats.
Latitude (Degrees) |
The latitude for the coordinates of the georeference. |
Longitude (Degrees) |
The longitude for the coordinates of the georeference. |
Height (Meters) |
The height for the coordinates of the georeference. |
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.
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.
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
These functions manipulate and format strings. | |
Special Characters |
A set of control characters is available in the Text Editor. |
Math functions are available in both editors. | |
Date/Time Functions | Date and time functions are available in the Text Editor. |
These operators are available in the Arithmetic Editor. | |
These return primarily feature-specific values. | |
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:
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
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 Holding |
No |
Dependencies | Cesium ion Account |
Aliases | |
History | Released FME 2019.0 |
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 CesiumIonConnector 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.