tBoxList – Docs for ESB 5.x

Component family

Cloud/Box

Function

This component reads the file(s) in Box held in the directory you specify and lists the
metadata and the contents of that file or those files.

Purpose

The tBoxList component lists the files stored in a
specified directory in Box.

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 pointing to the folder you need to list the files
from, or enter the path pointing to the exact file you need to
read.

List type

Select the type of data you need to list from the specified path, Files, Folders, or
Both.

Include subdirectories

Select this check box to list files from any existing sub-folders
in addition to the files in the directory defined in the Path field.

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 six
columns named name, path, lastModified, size,
id, and type.

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.

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

FILE_PATH: the path pointing to the folder or the file
being processed on Box. This is a Flow variable and it returns a string.

FILE_DIRECTORY: the directory of the folder or the file
being processed on Box. This is a Flow variable and it returns a string.

LAST_MODIFIED: the timestamp of the last modification of
the file being processed. This is a Flow variable and it returns a long.

SIZE: the volume of the file being processed. This is a
Flow variable and it returns a long.

ID: the ID of the folder or the file being processed on
Box. This is a Flow variable and it returns a string.

TYPE: the type of the objects being processed on Box,
file or folder. This is a Flow variable and it returns a string.

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 is typically used standalone.

Limitation

n/a