---
schema_version: "1"
id: eaaaa2e59c95c0b329b64c474f252a98aa2d65dc745ef3f6d94919e3da22ed04
title: Upgrading and Migrating Box Connector to Version 5.x
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/box-connector/latest/box-connector-upgrade.md
canonical_url: https://docs.mulesoft.com/box-connector/latest/box-connector-upgrade
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 2075de1488857b102db79823d64d75ed2f1081075a700c9ffbdc7ff9eb169700
description: MuleSoft Documentation Site
release: "5.3"
latest: true
---
---
product: Box Connector
version: 5.3
is-latest-version: true
---

# Upgrading and Migrating Box Connector to Version 5.x

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Upgrade Anypoint Connector for Box (Box Connector) from version 4.x to version 5.x to take advantage
of new functionality.

## Supported Upgrade Paths

<table><colgroup><col> <col></colgroup><thead><tr><th>From Version</th><th>To Version</th></tr></thead><tbody><tr><td><div><div><p>4.x.x</p></div></div></td><td><div><div><p>5.x.x</p></div></div></td></tr></tbody></table>

## Changes in This Release

- The prefix for all the connector operations changed from **mule-box-connector** to **box**.

- The OAuth 2.0 configuration XML structure changed.

  In earlier releases, the XML for the OAuth 2.0 connection element looked like this:

  ```xml
  <mule-box-connector:config
  	name="Mule_box_connector_Config"
  	doc:name="Mule-box-connector Config"
  	property_clientId="clientId"
  	property_clientSecret="secret"
  	property_localCallbackConfig="HTTP_Listener_config"
  	property_host="api.box.com"
  	property_port="4439"
  	property_basePath="/2.0"
  	property_protocol="HTTPS"
  	property_responseTimeout="10000"
  	property_localCallbackPath="/callback"
  	property_externalCallbackUrl="http://my-app.cloudhub.io/callback"
  	property_localAuthorizationUrl="http://localhost:8081/authorize"
  	property_authorizationUrl="https://account.box.com/api/oauth2/authorize"
  	property_accessTokenUrl="https://api.box.com/oauth2/token"
  />
  ```

  In the latest release, the XML looks like this:

  ```xml
  <box:config name="Box_Connector_Config" doc:name="Box Connector Config" >
  	<box:oauth2security-connection >
  		<box:oauth-authorization-code
  			consumerKey="consumerKey"
  			consumerSecret="consumerSecret"
  			authorizationUrl="https://account.box.com/api/oauth2/authorize"
  			accessTokenUrl="https://api.box.com/oauth2/token"
  			resourceOwnerId=“resourceownerId” />
  		<box:oauth-callback-config
  			listenerConfig="HTTP_Listener_config"
  			callbackPath="/callback"
  			authorizePath="/authorize"
  			externalCallbackUrl="http://localhost:8081/callback" />
  	</box:oauth2security-connection>
  </box:config>
  ```

## New Operations

New operations for Box Connector 5.0 include:

<table><colgroup><col> <col></colgroup><thead><tr><th>Box Operation</th><th>Description</th></tr></thead><tbody><tr><td><p>Upload file</p></td><td><p>Uploads a file to Box. For files larger than 50 MB, use the <strong>Create upload session</strong> operation instead.</p></td></tr><tr><td><p>Get file information</p></td><td><p>Retrieves detailed information about a file.</p></td></tr><tr><td><p>Upload file version</p></td><td><p>POST operation that updates a file’s contents. For files larger than 50 MB, use the <strong>Create upload session</strong> operation instead.</p></td></tr><tr><td><p>Create upload session</p></td><td><p>Creates an upload session for a new file. Use this operation for uploading files larger than 50 MB. Chunks large uploads into sequential parts that you can then upload individually. Parts can be uploaded in parallel.</p></td></tr><tr><td><p>Get upload session</p></td><td><p>Returns information about an upload session.</p></td></tr><tr><td><p>List parts</p></td><td><p>Returns a list of the chunks uploaded to the upload session so far.</p></td></tr><tr><td><p>Create upload session for existing file</p></td><td><p>Creates an upload session for an existing file.</p></td></tr><tr><td><p>Commit upload session</p></td><td><p>Closes an upload session and creates a file from the uploaded chunks.</p></td></tr><tr><td><p>Upload part of file</p></td><td><p>Updates a chunk of an upload session for a file.</p></td></tr><tr><td><p>Remove upload session</p></td><td><p>Aborts an upload session and discards all data uploaded.</p></td></tr></tbody></table>

## Upgrade Prerequisites

Before you perform the upgrade, you must create a backup of your files, data, and configurations in
case you need to restore to them.

## Upgrade Steps

Follow these steps to perform the upgrade:

1.  In Anypoint Studio, create a Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange**.

3.  In **Add Dependencies to Project**, enter `box` in the search field.

4.  In **Available modules**, select **Box Connector Config** and click **Add**.

5.  Click **Finish**.

6.  Verify that the Box Connector dependency version is 5.0.0 in the `pom.xml` file in the Mule
    project.

Studio upgrades the connector automatically.

## Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

1.  In Studio, verify that there are no errors in the **Problems** or **Console** views.

2.  Verify that there are no problems in the project `pom.xml` file.

### Revert the Upgrade

If it is necessary to revert to the previous version of box connector, change the `5.0.0` dependency
version in the project’s `pom.xml` file to the previous version.

You must update the project’s `pom.xml` file in Anypoint Studio.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Box Connector Reference](https://docs.mulesoft.com/box-connector/latest/box-connector-reference)

- [Salesforce Help](https://help.salesforce.com)