Skip to main content Skip to complementary content

Box properties

Properties to configure to connect to Box.

Box connection

Property

Configuration
Selection Select or enter Box.
Configuration
Engine Select your engine in the list.
Connection Authentication type Select one of the following method to connect to Box:
  • JWT: specify the credentials in the JWT authentication section to authenticate using JSON Web Tokens (JWT).
  • Developer token: specify the credentials in the Developer token field to authenticate using a developer token. You can find the developer token in the Configuration tab of your Box Developer console.
For more information about secure authentication to Box, see Authentication from the official Box documentation.
JWT authentication If you select the JWT authentication method, specify the following parameters that you can retrieve in the Box developer > Configuration > App settings section:
  • Client ID: enter the client ID associated with your account.
  • Client secret: enter the client secret associated with your account.
  • Public key ID: enter the key associated with your account.
  • Private key: enter the private key associated with your account.
  • Private key passphrase: enter the passphrase associated with your account.
  • Enterprise ID: enter the enterprise ID associated with your account.
  • Set user ID: toggle the option ON if you want to authenticate with a user ID (Box account) rather than an enterprise ID (Box admin account) and specify it in the User ID field that appears.
Check connection Click the Check connection button to validate the connection parameters and verify the connection status.
Description Enter a display name (mandatory) and a description (optional) for the connection.

Box dataset

Property Configuration
Dataset name Enter a display name for the dataset. This name will be used as a unique identifier of the dataset in all Talend Cloud apps.
Connection Select your connection in the list. If you are creating a dataset based on an existing connection, this field is read-only.
Main Box folder ID or Path to Box folder
  • Box folder ID (if Get folder by ID is enabled in the Advanced parameters): Enter or select the identifier of the Box folder. Example: /All Files/MyFolder/12345678
  • Path to Box folder (if Get folder by ID is disabled in the Advanced parameters): Enter a name for the Box folder you want to create or select an existing one in the list.
File name template Enter a file name to use as a template.
Format configuration From the Content format list, select the format of the file:
  • CSV: specify the parameters in the CSV configuration section from the Main and Advanced tabs.
  • Avro: no specific parameters required for this format.
  • Excel: specify the parameters in the Excel configuration section from the Main tab.
  • JSON: specify the parameters in the JSON configuration section from the Advanced tab.
CSV configuration If you select the CSV format, specify the following parameters:
  • Line separator type: select the type of line separator used in the file.
  • Encoding type: select the type of encoding used in the file.
  • Set header: toggle the option ON if the file contains header lines and specify the number of lines to be skipped in the Number of lines field.
  • Field separator type: select the type of field separator used.
Excel configuration If you select the Excel format, specify the following parameters:
  • Excel format: select the Excel version/format.
  • Sheet name: enter a name for the Excel sheet.
  • Set header: toggle the option ON if the file contains header lines and specify the number of lines to be skipped in the Number of lines field.
  • Set footer: toggle the option ON if the file contains footer lines and specify the number of lines to be skipped in the Number of lines field.
Advanced Format configuration If you select the CSV format, specify the following parameters:
  • Escape character: enter the escape character you want to be used. The escape character used by default is \.
  • Quote character: enter the quote character you want to be used. The quote character used by default is ".
If you select the JSON format, specify the following parameter:
  • Infer all numbers as double: toggle the option ON if you want the numbers to be inferred as double in the JSON file.
Get folder by ID Toggle this option OFF to disable the possibility to use Box folder IDs instead of Box folder paths.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here