Skip to main content

box Box Output Tool

Use the Box Output tool to write data or upload local files to your Box workspace.

Important

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

Install the Tool and Sign In to Box

To install and configure the Box Output tool

  1. Download the tool from Alteryx Community.

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

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

  4. You can either Select Existing Connection or enter your credential details in the left-side panel.

  5. Choose an authentication method:

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

    2. Provide Access Token: Authenticate with an access token.

    3. JSON Web Token (JWT): Select a file with the token and enter your user account ID.

      You can also Connect through your Box application with a client ID and secret.

  6. Select Connect.

Configure the tool

You can write the incoming data into a file or you can upload local files to your Box workspace.

Write Incoming Data into File

  1. Choose a collection from the Collections dropdown menu.

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

  2. Or, create a new file. There are 2 ways to create a new file...

    1. Select Add File.

      1. By Name: Write output to a new file with the given name.

      2. By Field: Write output rows to new files named by the column.

    2. Use the file path. Write the file name with file extension in the File Path field and select Enter.

      Select the appropriate file format on the Options tab.

  3. Select Run to run the workflow. A new file is created and displayed in the tree view. Note: You can create a new folder using the file path.

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

  • XLSX File Format Configurations

    • In the Options tab, you can choose the Existing File Action (Rename, Overwrite, Append, and Abort) and select whether First row contains field name.

      Warning

      If you select the Overwrite or Append options in Existing File Action, the updated sheet becomes the first sheet in the file. This can impact tools using the order numbers of sheets.

    • In the Data tab you can select Data Range:

      • By Sheet Name: The sheet name to be created in Box, including the starting cell.

      • By Field: To create multiple sheets based on the field name of the input sheet.

  • CSV File Format Configurations

    • In the Options tab, you can select File Format, Max Field Length, Field Delimiter (Comma by default), Quote Character (None by default), and Code Page.

    • You can also choose whether to Write Headers, Start Data on Line, and Existing File Action (Rename, Overwrite, Append, and Abort).

  • YXDB File Format Configurations

    • In the Options tab, you can select Existing File Action (Rename, Overwrite, Append, and Abort).

Upload Files to Box

For a detailed guide, see the Community article.

  1. Select the Source field containing full path of the files you want to upload.

  2. Choose a collection from the Collections dropdown menu.

    Important

    To select the file or the folder to upload the files to, you can enter the full file or folder path in the Target Path textbox. Use Set File Path by Field to define the Target Path using an incoming field.

  3. In the Options tab, you can choose the Existing File Action (Rename, Overwrite, and Abort).

In this section: