Skip to main content

box Box Input Tool

Use the Box Input tool to read the data stored in your Box workspace.

Important

This tool is not automatically installed with Designer. To use this tool, download it from the Alteryx Marketplace.

Tool Configuration

To install and configure the Box Input tool...

  1. Download the tool from Alteryx Community.

  2. In Designer, open the Box Tools YXI file. Note: To install the Box Input tool for all users, open the Designer app with administrator credentials.

  3. Select the Box Input tool to navigate to open the configuration panel.

  4. You can either set up a connection or enter your credential details in the left side panel.

  5. You can choose from following authentication methods:

    1. Sign in via Internet Browser–a pop-up window displays to grant access to Box.

    2. Get files from URL–a pop-up window displays to grant access to Box.

    3. Provide Access Token–authenticate with an access token generated to call for your account without going through the authorization flow.

    4. JSON Web Token–select a file and enter User Account ID to authenticate.

      You can also choose to Connect through your own Box application with the client ID and secret.

  6. Select Connect.

  7. Choose the files collection from the Collections dropdown.

  8. To select the file or folder to read the data, you can enter full file or folder path in the File Path text box. Use Search to find the file with its full name with extension, or select a file from tree view.

  9. If you want to process a file of a file type that Box Input doesn’t support or if you want to keep an offline copy of a file, select Download file locally for later processing and choose the location to save the file. The default location is %TEMP%.

  10. Select Include Subfolders to apply the tool configuration to all subfolders in the selected folder. This might increase workflow run time.

  11. In the Options tab, choose the File Format. Option fields are updated based on the selected file extension.

CSV File Format Configurations

For the CSV file format, the below configurations are available in the Options tab:

  • Field Delimiter–Comma (default), Semicolon, Tab, Pipe, Space, and Custom Delimiter.

  • Quote Characters–Single, Double, and Custom. None is default.

  • Max Field Length–integer (0, 1, 2, 3, 4, etc.). 254 is default.

  • Start Data on Line–integer (1, 2, 3, 4, etc.). 1 is default.

  • Code Page–all code page formats. UTF-8 is default.

  • Attach Metadata–none is default.

  • First row contains field name–unselected by default.

XLSX File Format Configurations

For the XLSX file format, below configurations are available in the Options tab:

  • Start Data on Line–integer (1, 2, 3, 4, etc.). 1 is default.

  • Code Page–all code page formats. UTF-8 is default.

  • Attach Metadata–none is default.

  • First row contains field name–unselected by default..

In the Data tab you can select Data range options: All Sheets, Sheet Names, Sheet Numbers along with a particular range, Named Range, or to Import only the list of sheet names.

YXDB File Format Configurations

For the YXDB file format, below configurations are available in the Options tab:

  • Attach Metadata - none is default.