tBoxCopy - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

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

Purpose

The tBoxCopy component copies or moves a given folder or file from Box.

tBoxCopy properties

Component family

Cloud/Box

 

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.

 

Move Directory

Select this check box to move a directory in Box.

 

Copy Directory

Select this check box to copy a directory in Box.

 

File Name

Enter file name with the path in Box you want to copy.

 

Source Directory

This option appears when the Move Directory or Copy Directory check box is selected. Enter the source directory in Box to be moved or copied.

 

Destination Directory

Enter the destination directory in Box where the specified file or directory will be copied or moved.

 

Rename

Select this check box to rename the file or directory to be copied. When copying a file, specify the new file name in the Destination File Name field. When copying a directory, enter the new directory name in the New Directory Name field.

 

Remove Source File

Select this check box to remove the source file during the copy action.

 

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. The schema is either Built-In or stored remotely in the Repository.

Note that the schema of this component is read-only with four columns named destinationFilePath, destinationFileName, sourceDirectory, and destinationDirectory.

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.

DESTINATION_FILENAME: the destination file name. This is an After variable and it returns a string.

DESTINATION_FILEPATH: the destination file path. This is an After variable and it returns a string.

SOURCE_DIRECTORY: the source directory. This is an After variable and it returns a string.

DESTINATION_DIRECTORY: the destination directory. This is an After 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 usually used standalone in a Subjob to copy or move data from Box.

Limitation

n/a

Related scenarios

No scenario is available for this component yet.