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.

Important

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 Outil Sortie de données

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.Read Data from BoxWrite Data to Box

Notes de publication

Notes de mise à jour du Connecteur 1.0.0 (Python)

ID	Description
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.

Description

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…

In Designer, go to Add-Ons > Manage Marketplace Add-Ons. You will see a list of available connectors.
Select Box Tools Connector and select Install. Designer downloads and installs the package. Designer might require a restart to complete the installation.
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

Drag the Input Data or Output Data tool to the canvas, and select Connect to Data.
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.
Select + New. From the list of technologies, select Box.
Enter the Connection Name and Data Source Name.
In the Credentials section, select your authentication method, and enter the credentials. For more information, see Authentication Methods.
Select Save. You can also select Test Connection to validate your credentials before saving.
Select Connect. Box may request authentication.
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.Read Data from BoxWrite Data to Box
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.

Note

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.

Gestionnaire de connexions aux données

Les outils Box version 2.5.0 et ultérieure prennent en charge le Gestionnaire de connexions aux données pour un stockage plus simple et plus sûr de vos informations d'identification. Créez une connexion à Box et réutilisez facilement les informations d'identification stockées dans les workflows incluant les outils Box. Alteryx Server nécessite des informations d'identification stockées pour exécuter correctement les workflows publiés.

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

Activation d'AMP Engine

Assurez-vous que l'outil AMP Engine est activé pour les workflows contenant les outils Box version 2.5.0 et ultérieure afin de tirer pleinement parti des fonctionnalités de Designer.

Inscription de l'application Box

Connectez-vous à https://alteryx.app.box.com/developers/console à l'aide de vos informations d'identification Box.
Sélectionnez Créer une nouvelle application.
Sélectionnez Application personnalisée.
Dans Méthode d'authentification, sélectionnez Authentification utilisateur (OAuth 2.0). Saisissez le Nom de l'application et sélectionnez Créer une application.
Dans l'onglet Configuration de la section Étendue de l'application, sélectionnez Écrire tous les dossiers et fichiers stockés dans Box pour donner l'autorisation à l'application.
Sélectionnez Enregistrer les modifications.
Pour générer un nouveau jeton de développeur, sélectionnez Révoquer, puis Générer un jeton de développeur.
Vous pouvez utiliser l'ID client et le secret client issus des Informations d'identification OAuth 2.0 pour l'authentification.

Configuration d'application personnalisée

Pour éviter un problème CORS de Box lors de l'utilisation de l'application avec l'authentification OAuth ou le jeton d'accès et JWT, utilisez une configuration personnalisée :

Application Box avec authentification OAuth :
1. Ajoutez URL de redirection https://cef.alteryx.com/designer/oauthcallback pour résoudre le problème CORS de la fenêtre CEF.
2. Saisissez file://* pour Origines autorisées.
Application Box avec jeton d'accès et authentification JWT :
1. Saisissez file://* pour Origines autorisées.

Box Standalone Connectors (Deprecated - Limited Support)

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

Outil Entrée de Box

Outil Sortie de Box

Utilisez le connecteur Box pour exécuter, planifier et publier des workflows à partir de Designer, à l'aide de fichiers stockés dans votre espace de travail Box. Les types de fichiers pris en charge sont XLSX, CSV et YXDB.

Notes de version des outils Box autonomes

Version	Description
v2.5.8	Correction d'un problème qui entraînait un échec du connecteur Box version 2.5.7 lors de l'utilisation de plusieurs outils Entrée de Box sur Server 25.1 lorsque les workflows s'exécutaient en parallèle, et qui renvoyait l'erreur `Impossible de trouver les valeurs de connexion DCM`.
v2.5.7	Designer affiche un message d'avertissement clair lorsque les utilisateurs saisissent un numéro de feuille, un nom de feuille ou une plage de feuilles non valide. Par défaut, le connecteur de Box définit les champs Time et DateTime avec une précision en millisecondes afin d'éviter l'ajout de zéros inutiles, tout en continuant de prendre en charge la résolution en nanosecondes lorsque le workflow l'exige. Correction d'un problème dans lequel les fichiers nouvellement créés dans les outils Box héritaient du nom de fichier précédemment sélectionné lorsqu'ils étaient enregistrés avec une extension quelconque. Correction d'un problème qui entraînait une erreur lors de la sélection de l'option Activer le test à blanc dans l'outil Entrée de Box (version 2.5.6) à l'aide d'une connexion DCM avec authentification JWT. Correction d'un problème qui empêchait la version 2.5.7 du connecteur Box de reconnaître les fichiers YXDB. Correction d’une erreur qui se produit lors du chargement d’un fichier à l’aide des outils Box. Correction d'un problème dans lequel les caractères spéciaux dans le mot de passe du proxy entraînaient une erreur lors de la configuration d'un serveur proxy manuel pour les outils Box. Correction d'un problème dans lequel les valeurs secrètes étaient exposées dans le JSON renvoyé et visibles dans les outils de développeur HTML de Designer pour les outils Box.
v2.5.6	Compatible avec Alteryx Designer et Server 2021.4.2 correctif 6, 2022.1 correctif 4 et versions ultérieures. Nécessite AMP Engine. Corrigé un problème empêchant l’outil Entrée Box de lire les données lorsqu’une colonne Excel contenait deux types de données. Corrigé un problème empêchant les jetons web JSON de fonctionner dans les outils Box. Corrigé un problème qui empêchait le SDK Python de signaler les erreurs DCM. Correction d'un problème où l'outil Entrée de Box ne conservait pas le type de données Date. Correction d'un problème où l'outil Sortie de Box convertissait des nombres en texte.

Dans cette section:

Box