# tBoxv2Get

Downloads a selected file from a Box account.

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

## tBoxv2Get Standard properties

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

The Standard tBoxv2Get component belongs to the Cloud family.

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

Information noteNote: 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

| Properties | Description |
| --- | --- |
| Property type | Either Built-in or Repository.<br><br><ul> <li> <span>Built-in</span>: No property data is                        stored centrally.</li> <li> <span>Repository</span>: Select the repository                        file where properties are stored. The fields that follow are                        completed automatically using the fetched data.</li> </ul><br><br>This drop-down list is not available if you select the Use an<br>existing connection option. |
| Use an existing connection | Select this check box and in the Component<br>List drop-down list, select the desired connection component to<br>reuse the connection details you already defined. |
| Authentication type | Select the authentication type: JWT (short for JSON Web<br>Token) or Developer token.<br><br>You need to provide the following<br>parameters in the corresponding fields for the JWT authentication<br>type.<br><br><ul> <li><span>Client ID</span> and <span>Client secret</span>: 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 <a href="https://developers.box.com/" target="_blank">https://developers.box.com/</a> 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.</li> <li><span>Public key ID</span></li> <li><span>Private key</span></li> <li><span>Private key passphrase</span></li> <li><span>Enterprise ID</span> or <span>User ID</span></li> </ul><br><br><br>For more information about JWT authentication, see [JWT Auth](https://developer.box.com/guides/authentication/jwt/).<br><br>Information noteNote: To enter the client secret, private key, or private key passphrase, click the<br>[...] button next to the corresponding field to bring out the<br>Enter a new password dialog box, enter the key in the text<br>field, and click OK. Note that you can enter the key either in a<br>JSON string in the pure password mode or as a Java expression in the<br>Java mode. You can toggle between the two modes by clicking<br>switch to Java mode or switch to pure password<br>mode on the top of the text field.<br><br>If you select Developer token from the drop-down list, type in<br>the developer token in the Developer token field. For more information about developer token, see [Developer Tokens](https://developer.box.com/guides/authentication/tokens/developer-tokens/).<br><br>The Authentication type drop-down list is available when Use an existing connection is not selected. |
| Box path to file | Type in the Box path to the file to download.<br><br>You can also specify the Box path of the file by clicking the [...] button<br>next to this field and navigate to the file.<br><br>This option is available<br>when the Get file by ID option in the<br>Advanced settings view is not selected. |
| Box ID | Type in the Box ID of the file to download.<br><br><br>You can also specify the<br>Box ID by clicking the [...] button next to this field and<br>navigate to the file.<br><br>This option is available when the Get file by<br>ID option in the Advanced settings view<br>is selected. |
| Local path to file | Type in the path for storing the downloaded file. If the file already<br>exists, it will be replaced with the downloaded file. |

## Advanced settings

| Properties | Description |
| --- | --- |
| tStatCatcher Statistics | Select this check box to collect log data at the component<br>level. |
| Get file by ID | Select this option to specify the file to be downloaded using its Box ID. |

## Global Variables

| Variables | Description |
| --- | --- |
| Global Variables | ERROR\_MESSAGE: the error message generated by the<br>component when an error occurs. This is an After variable and it returns a string. This<br>variable functions only if the Die on error checkbox is<br>cleared, if the component has this checkbox.<br><br>A Flow variable functions during the execution of a component<br>while an After variable functions after the execution of the component.<br><br>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<br>it.<br><br>For more information about variables, see [Using contexts and variables](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/contexts-and-variables). |

## Usage

| Usage guidance | Description |
| --- | --- |
| **Usage rule** | This component can be used alone or along with other components via the Iterate link or a trigger link such as<br>OnSubjobOk. |