Accesses the Box file storage service to upload, download, or delete files and folders or list file/folder information from a Box account.
Typical Uses
-
Manage datasets on Box by uploading, downloading, and deleting files and folders
-
Transfer a file's contents (such as XML or raster) into or out of an attribute in FME
- Read downloaded Box data using the FeatureReader, or upload data written by the FeatureWriter to Box
- Retrieve file and folder names, paths, links and other information from Box to use elsewhere in a workspace.
How does it work?
The BoxConnector uses your Box 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 file storage service.
Depending on your choice of actions, it will upload or download files, folders, and attributes; list information from the service; or delete items from the service. On uploads, link attributes can be added to the output features. On List actions, links and file/folder information are added as attributes.
Example: Downloading a dataset
In this example, the BoxConnector is used to download an Esri Geodatabase from Box. After creating a valid web connection to a Box account (which can be done right in the Box Account parameter), and browsing to the geodatabase folder, the Object ID is retrieved, and a destination for the download is selected.
A FeatureReader is added to read the newly downloaded dataset. Here, the PostalAddress feature type will be further processed elsewhere in the workspace.
By executing the download here in the workspace, the geodatabase will be refreshed every time the workspace is run.
Example: Downloading and using a raster as an attribute
In this example portion of a workspace, the BoxConnector is used to download a raster orthoimage from Box into an attribute.
The file is read from Box, and the contents stored as a blob attribute. Then a RasterReplacer is used to interpret the blob into a usable raster format.
The combination of these two transformers avoids having to download the image to local storage and re-read it. A similar technique can be used for point cloud files, using the PointCloudReplacer transformer.
Usage Notes
-
This transformer cannot be used to directly move or copy files between different Box locations. However, multiple BoxConnectors can be used to accomplish these tasks.
-
The FeatureReader can access Box directly (without using the BoxConnector), however, a local copy of the dataset will not be created.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
The output of this transformer will vary depending on the Box Action performed.
- After an Upload action, URLs to the file may be saved to the Sharable Link and Direct Download Link attributes, and the ID of the file will saved to an attribute.
- A Download action can save to either a folder or attribute.
- A Delete action has no output ports.
- Finally, 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.
<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.
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
Request
| Box Action |
The type of operation to perform. Choices include:
|
| Box Account |
Performing operations against a Box account requires the use of OAuth2 authentication using a Web Connection. To create a Box connection, click the 'Box Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections. |
The remaining parameters available depend on the value of the Request > Box Action parameter. Parameters for each Box Action are detailed below.
Parameters - Delete Action
Box Path
| Delete as |
Select whether to delete a File or Folder.
|
|
Object ID |
The Object ID of a file or folder on Box to delete. If valid credentials have been provided as a web connection, you may browse to a location. |
Parameters - Download Action
Box Source
|
Object ID |
The Box ID of the file/folder 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.
|
| Download to Folder | Specify the path to the folder that will store the downloaded file. Valid for Download as File or Folder. |
| Include Subfolders | Choose whether to download subfolders of the Box Source or not. Valid for Download as Folder only. |
| 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. |
Parameters - List Action
Box Path
| Generate Sharable Link | Specify this option to retrieve the File or Folder Link attribute. This will allow content to be viewed and/or downloaded by anyone with access to these links. |
|
Object ID |
The folder ID on Box to list the contents of. If valid credentials have been provided as a web connection, you may browse to a location. |
Output Attributes
Default attribute names are provided, and may be overwritten.
|
File or Folder Name |
Specify the attribute to hold the name of an object on Box. |
|
File or Folder ID |
Specify the attribute to hold the ID of an object on Box. |
|
File or Folder Link |
Specify the attribute to hold the link to an object on Box. |
|
File Size |
Specify the attribute to hold the size of a file object on Box. |
|
Last Modified |
Specify the attribute to hold the last modified date of an object on Box. |
|
File or Folder Flag |
Specify the attribute to hold the type (file or folder) of an object on Box. |
|
Relative Path |
Specify the attribute to hold the relative path to an object on Box. |
Parameters - Upload Action
Source
|
Upload |
The type of data to 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. Box treats file uploads of the same name, in a specific folder, as duplicates, but does not allow multiple instances in a specific folder. You must upload the file to a different folder than the existing one. When wanting to upload content from a folder, it is better to upload as a folder instead of setting a fixed path and sending multiple features into the connector to upload as a file. |
| Generate Sharable Links | Specify this option to set the Shared and Direct Download Link Attributes. This will allow uploaded content to be viewed and/or downloaded by anyone with access to these links. |
|
File to Upload |
The file to be uploaded to Box if Upload is set to File. |
|
Folder to Upload |
The folder to be uploaded to Box 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. |
Box Destination
| Folder ID | The path on Box 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, .txt, .jpg, .doc). |
Output Attributes
| Sharable Link |
Specify the output attribute that will store a temporary publicly accessible URL that links to the file on Box. |
| Direct Download Link | Specify the output attribute that will store a URL that links to the file on Box. The URL can only be used by authenticated users. |
|
File or Folder Id |
Specify the output attribute that will store the ID of the file/folder that was just uploaded. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click 
beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
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. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
How to Set Parameter Values
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 - whether entered directly in a parameter or constructed using one of the editors.
Content Types
| These functions manipulate and format strings. | |
| A set of control characters is available in the Text Editor. | |
| Math functions are available in both editors. | |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Working with User Parameters | Create your own editable parameters. |
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | Box account |
| FME Licensing Level | FME Professional Edition and above |
| Aliases | |
| History | Released FME 2017.0 |
| Categories |
FME Knowledge Center
The FME Knowledge Center 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 BoxConnector on the FME Knowledge Center.
Examples may contain information licensed under the Open Government Licence – Vancouver