box

Box Input Tool

Version:
2021.3
Last modified: August 16, 2021

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

Tool Configuration 

To install the Box Input tool, in Designer open the Box Input yxi file you have downloaded from Alteryx Analytics Gallery. 

To install the Box Input tool for all users, open the Designer app with administrator credentials. 

  1. Select the Box Input tool to navigate to the configuration panel. 

  1. You can either Select Existing Connection or enter your credential details in the left side panel.
    You can choose from following authentication methods: 

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

    2. Get files from URL – a pop up window appears to grant the access to Box. 

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

Select the Save connection to DCM checkbox to store your credentials in secure vault outside the workflow and to synchronize across the Alteryx product suite.  
You can also choose to Connect through your own Box application with the client ID and secret.  

  1. Select Connect

  1. Choose the files collection from Collections dropdown menu. 

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

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

CSV File Format Configurations 

For the CSV file format, 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 SheetsSheet NamesSheet 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. 

You can also choose to download file locally for later processing by selecting the Download file locally for later processing.

Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.