Skip to main content
This article is about Box Shuttle in the Admin Console. If you’re using legacy Box Shuttle, a standalone tool, see legacy migration guides.

Overview

Box Shuttle acts as an intermediary between various content management systems, enabling you to transfer folders, files, permissions, and metadata from these platforms to Box. You have two options to migrate your data:
  • Migrate data only: migrates files and folders from a selected source path of an account or folder to the selected target location without applying permissions.
  • Migrate data with permissions: transfers not only files and folders, but also permissions from one location to another. This type of migration job is suitable for comprehensive management of files, accounts, and privileges throughout the entire data migration process.
Box Shuttle does not migrate permissions or collaboration data for external users.
This guide provides instructions on how to migrate data with permissions. For migrating data only, see Data-only migration.
Workflow diagram for a migration with permissions, from source system through mapping, permissions scan, conflict resolution, filter and run settings, validation, simulation, and migration to the final report.
StepDescription
1Select the source system.
2Map the source content to the target location, by hand or in a spreadsheet.
3Scan the source system for any information related to permissions set on files and folders.
4If the scan returns a list of errors, resolve them in the source system, and re-scan the source system.
5Map source users and groups to their Box counterparts. If the scan detects any permission conflicts, decide how to resolve them.
6Specify additional content filters and other settings for the migration job.

Available settings can differ depending on the source system.

7Define run settings to set up upload bandwidth value (for Windows sources only) and mirror deletions.

Mirror deletions can lead to accidental data loss. Box recommends that you always run simulations and review reports before you run any transfer that can delete data.

8Check the content and settings to make sure everything is correct.
9Run a simulation of the migration.

This step is optional and you can proceed directly to migration, but Box recommends it, especially if you are running a migration for the first time. A simulation confirms that all the necessary information is in place and ready for migration.

10Once you have examined the simulation report, run the migration. When the migration is done, you can examine the resulting report.

Create a new job

To create a new job, select Migrate Data from the New Job drop-down menu.

Select source system

Select the source system that holds the data you want to migrate. If you don’t have an existing source system available, set it up using Source system configuration instructions.
Box Shuttle cannot alter or modify your source data.

Map files and folders

Map the source system data to the Box file and folder structure. A settings page precedes this step and asks how you want to map. Select Map Data manually to map each item in Box Shuttle, as described below, or map a large number of directories at once with bulk mapping with a spreadsheet. For each source account or folder you want to migrate, select the target account and folder that receives the data. When you select a folder, Box Shuttle migrates that folder or account along with every file and folder inside it. You can, however, deselect specific subfolders or files you don’t want migrated.
Make sure that all Box users have confirmed their invitations. You cannot transfer data to a Box account of a user who did not accept the invitation.
To select the target location, select Choose Target Location to open a panel in which you can choose the target Box account, folder, or file.
Map Data screen for a permissions migration mapping Beth's folders to Hercule Poirot's Migrated_Files target.
You can map the entire account, or a specific folder or file in this account. You can also create a new folder within that account. The icon hides the rows without any mapping defined.

Set parent directory

You can set a parent directory that Box Shuttle creates in each target location for the migrated content. To do so:
  1. Select the folder icon next to the search bar.
  2. Enter the name for the parent directory and confirm.
Mapping indicators next to the mapped folders help you to map the folders effectively. Actions you perform at the child folder level are indicated at the parent folder level. For example:
  1. A source folder is explicitly mapped to a folder in a target account. One of the child folders or files is also redirected to a target folder in a different account, so a redirect icon displays at the parent folder level.
  2. This source folder was redirected to a different target account, and a child folder or file was skipped.
  3. This folder was skipped and is not migrated.
ItemLevel of displayDescription
FolderAn item in a specific folder is explicitly included in the migration. This file is migrated, even though the folder is not.
FolderFiles in the folder were skipped. These files are not migrated.
Folder, AccountAn item in the folder was redirected to a different folder or account.
Folder, AccountA file or files in one of the child folders are explicitly included in the migration. Icon displayed when you select files in several folders.
File, Folder, AccountClears the mapping.
File, Folder, Account

Opens the list with target account folders. Use it to:

  • Select a different folder
  • Rename the folder
File, Folder, AccountSkips the file in the folder. This file is not migrated.
File, Folder, AccountIncludes the skipped file in the migration.

Choose migration type

Migrating data with permissions means transferring not only files and folders, but also ownership rights and permissions from one location to another. This type of migration job is suitable for comprehensive management of files, accounts, and privileges throughout the entire data migration process.
  1. After you are done with the mapping, select Migrate Data with Permissions from the available options.
  2. A new section displays, enabling you to collect information about permissions applied to source files and folders. Select Begin Scan to scan the source items.
Migration Settings with Migrate Data and Permissions selected and a Begin Scan button to gather source permissions.

Run permissions scan

During the permissions scan, Shuttle scans the source files and folders to identify permissions applied to folders and files.
Migration Settings after scan showing 2 files, 1 folder, and 1.3 kB scanned with a Re-Scan button.

Source errors

The scan might result in errors. For example, a particular file format might have no export options. If any errors occur, you have two options:
  • Resolve these errors in the source system and re-scan the directories.
  • Skip content that has errors and proceed with migration.
Source Read Errors page listing Google Apps format files that cannot be exported, with Re-Scan and Skip Errors buttons.

Map users and groups

A settings page precedes this step and asks how you want to map. Select Map users and groups manually to map each user and group in Box Shuttle, as described below, or map them in a spreadsheet with bulk mapping with a spreadsheet. Select each source user or group and map it to a specific target account or group. You can also skip specific users and user groups.
You must assign each user or group to a target counterpart, apart from the ones that you skip. Make sure that all mapped Box accounts have confirmed their invitations.
Map Users and Groups screen listing Beth, Engineering, and Peter Harper with Choose Target User or Group links.

Resolve permission conflicts

At this point, you can choose how to resolve permission conflicts during the data migration.
  • Expand permissions is recommended for most migrations, because it preserves the access on Box that users had on the source.
  • Restrict permissions and Skip conflict are useful for migrations where it is essential to preserve the limited access and data confidentiality present on the source.
  • Skip conflict means that content is not migrated to Box. Make sure you have a plan to migrate that content as part of your overall migration.
If any permission conflicts occur between the source and the target, Box Shuttle provides you with the following options to choose from:
ActionDescriptionDiagram
Expand permissionsAdds permissions to child folders or files if they have fewer permissions than a parent.
Expand permissions diagram showing child folders and files gaining additional Admin and Team permissions during migration.
Restrict permissionsRemoves permissions from the parent folder if a child has fewer permissions than the parent.
Restrict permissions diagram showing Admin access changed to No sharees on a parent folder and its child items.
Skip conflictThese folders or files are not transferred in the data migration because they have reduced permissions relative to a parent. They display as filtered in results.
Skip conflict diagram showing folders and files with reduced permissions excluded from migration, marked in red.
Permission Conflicts page with Expand Permissions selected and a Begin preparation button.
Select Begin preparation to prepare your migration plan.

Define filters and additional settings

  • Filter settings enable you to further specify which folders and files to include in the migration or exclude from the process.
    • Standard Filter settings ignore temp and system files, and migrate everything else. This is the recommended setting.
    • Advanced Filter settings filter the content on the basis of a regular expression, date, or size.
  • File versions settings enable you to choose whether to migrate the most recent version only, or all versions of the file.
If you select migrating versions on the initial transfer, Box Shuttle transfers only the most recent version. If you select versioning for a subsequent run of the job, Box Shuttle cannot transfer any versions that precede that most recent version.
The presence of file version settings depends on the source system chosen. For example, migration from Windows files has only filter settings available for you to use.
Job Settings with Advanced Filter for files modified before March 1, 2023 and Current Version selected.

Define run settings

Define the following run settings:
  • Run Parameters: At this point you can still choose if you want to migrate your data only or apply permissions to the chosen files and folders. For migrations where you want to migrate all data to Box before Box collaborators have access to it, you can run a job as Migrate Data Only and then switch the mode to Apply Permissions for the final run.
  • Bandwidth (for Windows sources only): Specify the maximum upload speed, or select Unlimited.
  • Mirror Deletions: Specify if you want to delete the files from the target location if they are no longer available in the source.
This option removes files from the target that do not exist on the source, even if those files never existed on the source. Use it only if no one is actively using the accounts and folders you migrate content into, because it can lead to accidental data loss. Box recommends that you always run simulations and review reports before you run any transfer that can delete data.
Shuttle Run Settings: Apply Permissions selected, unlimited bandwidth, Mirror Deletions enabled with warning.

Verify data

During the pre-run validation you can see the summary including the data you want to migrate and the job settings to verify if they are correct before proceeding with the migration. To make changes, select the breadcrumbs menu at the top to go back to the part you want to change.

Run simulation

Simulations give you an estimate on runtime and check for potential issues or errors before you migrate your data. This is an important step to validate your migration configuration, and Box recommends running a simulation before performing a transfer to encourage positive migration outcomes. Some simulation incompatibilities for Box include files larger than the maximum size supported and filtered system files, such as thumbs.db or other similar extensions. Simulations detect many, but not all, of the potential errors in a transfer job.

When to run a simulation

  • After setting up your first job
  • When you make job configuration changes
  • If data on your source or Box target changes significantly, including data being moved or renamed
  • Before migrating permissions
Selecting Run Simulation starts the process. This can take anywhere from a few minutes to several days, depending on how much content there is to analyze. Once a simulation is complete, view the results of the estimated job details similar to an analysis job. Preview the simulation results to make the live transfer a more seamless experience. After the simulation is done, you can view the results by selecting View Job Report. The Filters button on the right activates a side panel you can use to display specific results. When the simulation job has finished, the reports tell you what files and how many bytes of data would have been transferred, and what files, if any, would be deleted. Additionally, the simulation:
  • Identifies the size of content on the source, the number of files, and total bytes.
  • Assesses how many files and bytes transfer during synchronization runs, and identifies which files transfer during the sync. This is helpful for evaluating whether to run the sync.
  • Identifies and troubleshoots transfer errors quickly, such as Access denied, when comparing results to a direct transfer. Simulation jobs also help evaluate drive and network connectivity problems.
  • Provides an estimated time to complete a data migration, and potential congestion issues impacting transfer speed.
This estimate is a guideline only. The actual transfer might take more or less time depending on a number of factors.After the simulation is done, you can view the results by selecting View Job Report. See Reporting for more details.

Run transfer

Selecting Run Transfer starts the migration process. After it is finished, you can examine the results. After the transfer is done, you can view the results by selecting View Job Report. See Reporting for details.

Schedule migration

You can schedule a job to run at a given time and re-run it at configurable intervals.
For a Windows source system, the scheduler runs only one job at a time. This ensures that each job has sufficient memory, CPU, and other resources to transfer data to Box at optimal speeds.
Data Migration job with the overflow menu open, showing Configure Job, Run Transfer, and Schedule options next to the Run Simulation button.
For more details on scheduling, see Scheduling jobs.

Notifications and reporting

Box notifications keep you informed of the status and progress of your Box Shuttle jobs. Reports created after each analysis, simulation, and migration job provide detailed information about job performance estimates and migrated or analyzed files and folders. See Introducing Box Shuttle for details.
Last modified on September 9, 2026