tBoxGet – Docs for ESB 5.x

Component family

Cloud/Box

Function

This component connects to a given Box account and downloads files to a specified local
directory.

Purpose

The tBoxGet component downloads a selected file from a
Box account.

Basic settings

Use existing connection

Select this check box and in the Component List click the
relevant connection component to reuse the connection details you already defined.

Connection/Client Key

Enter the client key required by Box to access the Box API. To obtain the client key and
client secret you need to create an account at https://developers.box.com/ and then create a Box App under the Box account to
be used. The client key and client secret can be obtained from the account application
settings.

Connection/Client Secret

Enter the client secret required by Box to access the Box API. To obtain the client key and
client secret you need to create an account at https://developers.box.com/ and then create a Box App under the Box account to
be used. The client key and client secret can be obtained from the account application
settings.

Connection/Access Token

Enter the access token required by Box to access a Box account and operate it. For how to get
the access token and refresh token, see the sample at https://github.com/box/box-java-sdk-v2/wiki/HelloWorld.

Connection/Refresh Token

Enter the refresh token required by Box to refresh the access token automatically. For how to
get the access token and refresh token, see the sample at https://github.com/box/box-java-sdk-v2/wiki/HelloWorld.

Connection/Use HTTP proxy

If you are using a proxy, select this check box and enter the host and port information of
that proxy in the corresponding fields that are displayed.

Path

Enter the path on Box pointing to the file you need to download.

Save as file

Select this check box to display the Save To field and
browse to, or enter the local directory where you want to store the
downloaded file. The existing file, if any, is replaced.

Schema and Edit schema

A schema is a row description. It defines the number of fields to be processed and passed on
to the next component. The schema is either Built-In or
stored remotely in the Repository.

Note that the schema of this component is read-only with two
columns named fileName and
content.

The Schema field is not available
when you have selected the Save as
file check box.

Advanced settings

tStatCatcher Statistics

Select this check box to collect log data at the component
level.

Global Variables

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

FILE_NAME: the name of the file being processed. This is
a Flow variable and it returns a string.

INPUT_STREAM: the content of the file being fetched. This
is a Flow variable and it returns an InputStream.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.

Usage

This component can be used alone or along with other components via the Iterate link or a trigger link such as
OnSubjobOk.

Limitation

n/a