July 30, 2023

tBoxDelete – Docs for ESB 7.x

tBoxDelete

Removes a given folder or file from Box.

This component connects to a given Box account and removes a specified file or
folder.

tBoxDelete Standard properties

These properties are used to configure tBoxDelete running in the Standard Job framework.

The Standard
tBoxDelete component belongs to the Cloud family.

The component in this framework is available in all Talend
products
.

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, check the Box documentation you can access from https://developers.box.com/.

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, check the Box documentation you can access from
https://developers.box.com/.

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 folder or the file you need to remove.

Schema and Edit schema

A schema is a row description. It defines the number of fields
(columns) to be processed and passed on to the next component. When you create a Spark
Job, avoid the reserved word line when naming the
fields.

Note that the schema of this component is read-only with one column named filepath.

Advanced settings

tStatCatcher Statistics

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

Global Variables

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.

REMOVED_PATH: the path of the folder or file being
deleted on Box. 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

Usage rule

This component is usually used standalone in a subJob to remove data from Box.

Related scenarios

No scenario is available for the Standard version of this component yet.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x