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 Ferramenta Dados de Saída

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

Notas de versão do Conector 1.0.0 (Python)

ID

Descrição

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

Gerenciador de Conexões de Dados

As ferramentas do Box 2.5.0 e versões posteriores são compatíveis com o Gerenciador de Conexões de Dados para um armazenamento mais fácil e seguro de suas credenciais. Crie uma conexão com o Box e reutilize facilmente as credenciais armazenadas em fluxos de trabalho que incluem as ferramentas do Box. O Alteryx Server exige credenciais armazenadas para executar com êxito os fluxos de trabalho publicados.

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

Habilitar o AMP Engine

Certifique-se de ter o AMP Engine habilitado para os fluxos de trabalho que contêm as ferramentas do Box 2.5.0 e versões posteriores para aproveitar todo o potencial dos recursos do Designer.

Registro no aplicativo Box

  1. Faça login em https://alteryx.app.box.com/developers/console usando suas credenciais do Box.

  2. Clique em Criar novo aplicativo.

  3. Selecione Aplicativo personalizado.

  4. Em Método de autenticação, selecione Autenticação de usuário (OAuth 2.0). Insira o Nome do aplicativo e clique em Criar aplicativo.

  5. Na guia Configuração em Escopos de aplicativo, selecione Gravar todas as pastas e arquivos armazenados no Box para fornecer permissão ao aplicativo.

  6. Selecione Salvar alterações.

  7. Para gerar um novo token de desenvolvedor, clique em Revogar, depois, em Gerar token de desenvolvedor.

  8. Você pode usar ID e Segredo do cliente em Credenciais do OAuth 2.0 para autenticação.

Configuração personalizada do aplicativo

Para evitar um problema de CORS do Box ao usar o aplicativo com autenticação OAuth ou token de acesso e JWT, use uma configuração personalizada:

  1. Aplicativo Box com autenticação OAuth:

    1. Adicione o URI de redirecionamento https://cef.alteryx.com/designer/oauthcallback para solucionar o problema de CORS da janela do CEF.

      BoxOAuth
    2. Insira file://* em Origens permitidas.

      BoxOAuthCORS
  2. Aplicativo Box com token de acesso e autenticação JWT:

    1. Insira file://* em Origens permitidas.

      BoxTokensCORS

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

Use o conector do Box para executar, agendar e publicar fluxos de trabalho do Designer utilizando arquivos armazenados no seu espaço de trabalho do Box. Os tipos de arquivo compatíveis são XLSX, CSV e YXDB.

Notas de versão independentes das ferramentas do Box

Versão

Descrição

v2.5.8

  • Corrigido um problema em que a versão 2.5.7 do conector do Box falhava com várias ferramentas Entrada do Box no Server 25.1 quando os fluxos de trabalho eram executados em paralelo e retornavam o erro Falha ao localizar os valores de conexão do DCM.

v2.5.7

  • O Designer exibe uma clara mensagem de aviso quando os usuários inserem um número de planilha, nome de planilha ou intervalo de planilha inválido.

  • O conector do Box padroniza a precisão de hora e data/hora para milissegundos para evitar zeros extras à direita, enquanto ainda oferece suporte à resolução de nanossegundo quando exigido pelo fluxo de trabalho.

  • Corrigido um problema em que os arquivos recém-criados nas ferramentas do Box herdavam o nome de arquivo selecionado anteriormente quando salvos com qualquer extensão.

  • Corrigido um problema em que selecionar Habilitar simulação (dry-run) na ferramenta Entrada do Box (versão 2.5.6) usando uma conexão do DCM com autenticação JWT causava um erro.

  • Corrigido um problema em que o conector do Box versão 2.5.7 não reconhecia arquivos YXDB.

  • Corrigido um erro que ocorre ao carregar um arquivo usando as ferramentas do Box.

  • Corrigido um problema em que os caracteres especiais na senha do proxy causavam um erro ao configurar um servidor proxy manual para as ferramentas do Box.

  • Corrigido um problema em que os valores secretos eram expostos no JSON retornado nas ferramentas de desenvolvedor HTML do Designer para as ferramentas do Box.

v2.5.6

  • Compatível com o Alteryx Designer e o Server 2021.4.2 Patch 6, 2022.1 Patch 4 e versões posteriores.

  • Exige o AMP Engine.

  • Corrigido o problema em que o Box Input não conseguia ler dados quando uma coluna do Excel tinha dados de dois tipos.

  • Corrigido o problema em que os JSON Web Tokens não funcionavam nas ferramentas do Box.

  • Corrigido o problema em que o SDK do Python não reportava erros do DCM.

  • Corrigido o problema em que a Entrada do Box não retinha dados do tipo data.

  • Corrigido o problema em que a Saída do Box convertia números em texto.