Skip to main content

Box

The Box connector lets you connect to Box storage in Designer. Box is available as a data source in the Input Data and Output Data tools, letting you read from and write to Box directly in your Designer workflows.

Importante

New Connector Version in Designer

If your workflow uses the standalone Box Input or Box Output tools, those are now deprecated. Instead, use connector version 3.0.0 or later with the Input Data and Output Data tools. Use the workflow migration utility to update existing workflows.Output Data Tool Icon Strumento Dati di output

If you want to update the Box connector in your Designer workflows, you can use the workflow migration utility.

Prerequisites

Requirement

Detail

Designer Version

  • 2025.1 Patch 5, 2025.2 Patch 3, 2026.1 or later.

  • File partitioning is available starting with 2025.2 Patch 5.

  • The Workflow Migration tool is supported for 2025.2 Patch 3 or later.

Connector Version

Box version 3.0.0 or later. Available from Designer Add-Ons.

Box Permissions

See Box App Registration.

DCM

You must enable DCM in Designer. Go to Options >User Settings > Edit User Settings > General and select Override DCM Settings to enable it.

Network Access

Outbound access to Box and Box OAuth endpoints.

Box Connector Details

Box is available in Designer Desktop 2025.1 Patch 5 and later as a data source for the Input Data and Output Data tools. To learn more about the file type options, go to Read Data from Box or Write Data to Box .

Note di release

Note di release del connettore 1.0.0 (Python)

ID

Descrizione

v3.0.0

  • Compatible with Designer 2025.1 Patch 5, 2025.2 Patch 3, 2026.1 and later.

  • Test Connection button has been added to all DCM authentication types to validate the credentials before saving it.

  • You can edit Scope for Built-in, Custom app.

  • You can edit Redirect URI for Custom app.

  • Box tool can render all platform-supported file formats, including CSV, XLSX, Avro, and JSON.

  • File Partitioning has been added for xlsx file format in Box Output.

  • Added the Read Metadata Only input option for files and folders.

  • Added the Read Only List of Full Paths input option, which reads full paths recursively from the selected folder.

  • Parquet file support in Box is available from Designer 2026.2 and above.

  • Added File Partitioning for the XLSX file format in Box output. You can split output into multiple files by a maximum number of rows or by the values in a selected column, and this requires Designer 2025.2 Patch 3 or later.

Known Issue

  • Box Input cannot read data from a link belonging to a different base account within the same company.

  • The Box Output Abort operation displays two errors in the output results window instead of one, even though the operation completes with the correct result.

Install the Connector

You can easily install the latest version of the Box connector from Designer via the Add-Ons. This is the recommended installation method that allows you to browse, install, and update connectors without leaving Designer or visiting the Alteryx Marketplace.

To install the connector…

  1. In Designer, go to Add-Ons > Manage Marketplace Add-Ons. You will see a list of available connectors.

  2. Select Box Tools Connector and select Install. Designer downloads and installs the package. Designer might require a restart to complete the installation.

  3. After installation and setup are complete, the Box connector is available from the Input Data and Output Data tools.

Set Up a Connection

To connect to Box connector using DCM...DCM - Designer

  1. Drag the Input Data or Output Data tool to the canvas, and select Connect to Data.

  2. In the Connector Setup, select Create or Browse a Data Connection.

    If you've created a Box connection before, you can select the connection from the Recents tab.

  3. Select + New. From the list of technologies, select Box.

  4. Enter the Connection Name and Data Source Name.

  5. In the Credentials section, select your authentication method, and enter the credentials. For more information, see Authentication Methods.

  6. Select Save. You can also select Test Connection to validate your credentials before saving.

  7. Select Connect. Box may request authentication.

  8. Select the read or write configuration in the Options window. To know more about the options, see to Read Data from Box or Write Data to Box .

  9. Select Confirm to create a connection to the file. You can continue building your workflow.

You can use the same Box connection in both the Input Data and Output Data tools.

Workflow Migration

If your existing workflows use the deprecated Box Input or Box Output tools, you need to migrate them to use the new connector. Use the workflow migration utility to update existing workflows. The utility requires Designer 2025.2 Patch 3 or later.

The utility previews all the changes and replaces deprecated tool instances with the new connector versions without breaking the workflows.

Review the Changed Behavior and Limitations sections before you migrate.

Nota

Your existing Box connections may need to be recreated. Connections created with Box connector version 2.5.8 and earlier do not automatically become version 3.0.0 connections.

Authentication Methods

Box supports four authentication methods. Use the table below to choose the right one for your use case.

Method

Details

Built-in

  • Use this to set up a personal, ad hoc connection with your own Box credentials.

  • Uses the built-in Alteryx Box application, eliminating the need for app registration.

  • Scope is configurable and editable. Not recommended for scheduling workflows.

Custom App

  • Use this when your team shares a custom-registered Box application.

  • Scope and Redirect URI are both configurable and editable. For instructions on the setup, see Box App Registration.

Access Token

  • Use this to authenticate with a developer token generated in the Box Developer Console.

  • Developer tokens are short-lived, so this is not recommended for scheduled or automated workflows.

JWT app auth

  • Use this to schedule or automate workflows without tying authentication to a specific user.

  • Requires a Box custom application configured for server authentication with JWT. For instructions on the setup, see Box App Registration.

All four methods support Test Connection, which validates your credentials before you save the connection.

Changed Behavior from Previous Version

Review the changed behavior from version 2.5.8.

  • Shared links are accessed with the Raw Path feature. Not an authentication method.

  • Include subfolders checkbox is part of the Download File or Folder input option, which handles files and folders together.

  • The legacy option Rename is now Create a New File, which appends a timestamp rather than a unique number.

Limitations

  • You can use the Modify option in Box Output to append data to an XLSX file. Box connector versions 2.5.8 and earlier also support appending data to CSV and YXDB files. In version 3.0.0, Append is supported for XLSX files only.

  • The Upload File to Box output option is not available in version 3.0.0. It will be part of an upcoming release.

  • Box connector version 3.0.0 is available in Designer Desktop. Support for Alteryx One is planned for a later release.

  • Desktop Automation (Scheduler) is not supported by this connector.

  • Workflows that contain the Box connector must use the AMP engine.

Data Connection Manager

Gli strumenti Box versione 2.5.0 e successive supportano Data Connection Manager (DCM) per una memorizzazione più semplice e sicura delle tue credenziali. Crea una connessione a Box e riutilizza con facilità le credenziali memorizzate nei flussi di lavoro che includono gli strumenti Box. Alteryx Server richiede credenziali memorizzate per eseguire correttamente i flussi di lavoro pubblicati.

The Box tools version 2.5.0 and later also support Data Connection Manager.

Abilitazione di AMP Engine

Per sfruttare appieno il potenziale delle funzionalità di Designer, assicurati che AMP Engine sia abilitato per i flussi di lavoro che contengono gli strumenti Box versione 2.5.0 e successive.

Registrazione dell'app Box

  1. Accedi a https://alteryx.app.box.com/developers/console utilizzando le tue credenziali Box.

  2. Seleziona Crea nuova app.

  3. Seleziona App personalizzata.

  4. In Metodo di autenticazione, seleziona Autenticazione utente (Oauth 2.0). Immetti il nome dell'app e seleziona Crea app.

  5. Nella scheda Configurazione di Ambiti di applicazione, seleziona Scrivi in tutti i file e le cartelle memorizzati su Box per fornire l'autorizzazione all'app.

  6. Seleziona Salva modifiche.

  7. Per generare un nuovo token sviluppatore, seleziona Revoca, quindi seleziona Genera token sviluppatore.

  8. Per l'autenticazione, puoi utilizzare l'ID client e il segreto client dalle credenziali OAuth 2.0.

Configurazione dell'applicazione personalizzata

Per evitare un problema di CORS Box quando si utilizza l'app con autenticazione OAuth o token di accesso e JWT, utilizza una configurazione personalizzata:

  1. App Box con autenticazione OAuth:

    1. Aggiungi l'URI di reindirizzamento https://cef.alteryx.com/designer/oauthcallback per risolvere il problema di CORS della finestra CEF.

      BoxOAuth

    2. Immetti file://* in Origini consentite.

      BoxOAuthCORS

  2. App Box con token di accesso e autenticazione JWT:

    1. Immetti file://* in Origini consentite.

      BoxTokensCORS

Box Standalone Connectors (Deprecated - Limited Support)

We have deprecated the below standalone Box tools. Install the latest Box Connector to leverage the newest features.

box Strumento Input di Box

box Strumento Output di Box

Utilizza il connettore Box per eseguire, pianificare e pubblicare flussi di lavoro da Designer, utilizzando i file memorizzati nello spazio di lavoro Box. I tipi di file supportati sono XLSX, CSV e YXDB.

8 dicembre 2025

Versione

Descrizione

v2.5.8

  • Abbiamo risolto un problema per cui la versione 2.5.7 del connettore Box non funzionava con più Strumenti Input di Box in Server 25.1 quando i flussi di lavoro venivano eseguiti in parallelo e restituiva l'errore Impossibile trovare i valori della connessione DCM.

v2.5.7

  • Designer visualizza un chiaro messaggio di avviso quando gli utenti immettono un numero di foglio non valido, un nome di foglio non valido o un intervallo di fogli non valido.

  • The Box connector defaults Time and DateTime precision to milliseconds to avoid extra trailing zeros, while still supporting nanosecond resolution when required by the workflow.

  • Fixed an issue where newly created files in the Box tools inherit the previously selected filename when saved with any extension.

  • Risolto un problema per cui la selezione di Abilita esecuzione simulata nello strumento Box Input (versione 2.5.6) con una connessione DCM che utilizza l'autenticazione JWT causava un errore.

  • Abbiamo risolto un problema per cui la versione 2.5.7 del connettore Box non riconosce i file YXDB.

  • Corretto un errore che si verifica durante il caricamento di un file tramite gli Strumenti Box.

  • Fixed an issue where special characters in the proxy password cause an error when setting up a manual proxy server for the Box tools.

  • Risolto un problema per cui, negli Strumenti per Sviluppatori HTML di Designer per gli strumenti Box, il JSON restituito esponeva valori segreti.

v2.5.6

  • Compatibile con Alteryx Designer e Server 2021.4.2 Patch 6, 2022.1 Patch 4 e versioni successive.

  • Richiede AMP Engine.

  • Risolto un problema per cui Input di Box non riusciva a leggere i dati quando una colonna di Excel conteneva dati di due tipi diversi.

  • Risolto un problema per cui i JSON Web Token non funzionavano negli Strumenti di Box.

  • Risolto un problema per cui l'SDK Python non segnalava errori DCM.

  • Risolto il problema che impediva a Input di Box di conservare i dati relativi al tipo di data. (TDCE-537)

  • Risolto un problema per cui Box Output convertiva i numeri in testo.

In questa sezione: