tBoxv2Copy Standard properties - Cloud - 8.0

Box

Version
Cloud
8.0
Language
English
Product
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
Data Governance > Third-party systems > Cloud storages > Box components
Data Quality and Preparation > Third-party systems > Cloud storages > Box components
Design and Development > Third-party systems > Cloud storages > Box components
Last publication date
2024-02-20

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

The Standard tBoxv2Copy component belongs to the Cloud family.

The component in this framework is available in all subscription-based Talend products.

Note: This component is available only when you have installed the 8.0.1-R2023-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

Basic settings

Property type

Either Built-in or Repository.

  • Built-in: No property data is stored centrally.
  • Repository: Select the repository file where properties are stored. The fields that follow are completed automatically using the fetched data.

This drop-down list is not available if you select the Use an existing connection option.

Use an existing connection

Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined.

Authentication type

Select the authentication type: JWT (short for JSON Web Token) or Developer token.

You need to provide the following parameters in the corresponding fields for the JWT authentication type.
  • Client ID and Client secret: Enter the client key and 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.
  • Public key ID
  • Private key
  • Private key passphrase
  • Enterprise ID or User ID
For more information about JWT authentication, see JWT Auth.
Note: To enter the client secret, private key, or private key passphrase, click the [...] button next to the corresponding field to bring out the Enter a new password dialog box, enter the key in the text field, and click OK. Note that you can enter the key either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field.

If you select Developer token from the drop-down list, type in the developer token in the Developer token field. For more information about developer token, see Developer Tokens.

The Authentication type drop-down list is available when Use an existing connection is not selected.

Action type Select the action to carry out against the Box file or folder.
  • Move folder: moves the specified folder to the target folder.
  • Move file: moves the specified file to the target folder.
  • Copy folder: copies the specified folder to the target folder.
  • Copy file: copies the specified file to the target folder.
Rename Select this option to rename the file or folder while it is copied or moved to the target folder. You can type in the new name in the New name field.
Path to Box file/folder

Type in the Box path to the file or the folder to copy or to move.

You can also specify the file or the folder by clicking the [...] button next to this field and navigating to the file or the folder.

This option is available when the Get by ID option in the Advanced settings view is not selected.

Box ID

Type in the Box ID of the file or the folder to copy or to move.

You can enter the Box ID of the file or the folder by clicking the [...] button next to this field and navigating to the file or the folder.

This option is available when the Get by ID option in the Advanced settings view is selected.

Destination folder

Type in the path to the target folder.

You can also specify the target folder by clicking the [...] button next to this field and navigating to the folder.

New name

Type in the new name for the file or the folder that is copied or moved to the target folder.

This field is available when the Rename option is selected.

Advanced settings

tStatCatcher Statistics

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

Get by ID Select this option to specify the file to be downloaded using its Box ID.

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.

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 more information about variables, see Using contexts and variables.

Usage

Usage rule

This component is usually used standalone in a subJob to copy or move data from Box.