Chat now with support
Chat with Support

Welcome, erwin customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

Metalogix Essentials for Office 365 2.4 - User Guide

Metalogix Essentials for Office 365 User Guide
Administrator Architect Backup
Interface Overview Common Functions
Connecting to SharePoint and OneDrive for Business Connecting to Cloud Storage Global and SharePoint Administrators Hyper Backup Creating a Full Backup Creating an Update Backup Creating an Exchange Online Mailbox Backup Creating an Office 365 Group Backup Creating a OneDrive for Business Backup Backup Resume Backup Search Restore from Backup Scheduling Backup Jobs Retention Policies Import/Export Backup Archives Moving the Backup Location Backup Project Conversion
Interface Overview Common Functions
Connecting to Drives Copy Google Drive Copy File Share Copy My Sites to OneDrive for Business Copy Tenant Copy Box Copy Dropbox OneDrive Management Progress Tab Hyper Migration Path Length Overflow
File Manager Informant Migrator
Interface Common Functions
Connect to SharePoint and OneDrive for Business Global and SharePoint Administrators Copy Sites Live Compare Copy Lists and Libraries Copy, Move, and Tag SharePoint Content Copy Alerts Pre-Migration Report Azure Turbo Mode In-Place Tagging of SharePoint Items Incremental Copy Nintex Workflow Migration Orphaned Users Copy Preserving Content Authorship and Approve/Reject Statuses Save Site to XML Using Scripts and Integration With Windows Task Scheduler
Profile and Global Variables Public Folders for SharePoint Reporting and Re-Mapping Users and Templates Security Manager Term Store Manager Scripts Wizards Appendix

Uploading Files into SharePoint Using a CSV Spreadsheet

The uploading files into SharePoint using a CSV spreadsheet option is designed to enhance and expand SharePoint’s ability to import files located in Windows or other operating systems, by utilizing a spreadsheet that contains accompanying metadata. The files will be imported into SharePoint and tagged with the metadata associated to it from this spreadsheet. Here are the basic guidelines for using the Upload Content Using CSV feature inside Essentials products.

1.Start by identifying the files and folders that you want to import into SharePoint. There are two ways to do this:

·You can expand and navigate through the Connections (1) area in the product. If you double click on a folder or drive, the contents will be displayed in the Contents (2) area. You may drag-and-drop or copy/paste from Connections or Contents areas directly to the destination.
uploading files using CSV 1

·Alternatively, Essentials provides the same capabilities directly from Windows Explorer.

2.After you have selected the content and dragged/copied it to your SharePoint destination, a familiar wizard will be displayed. This is the same wizard that is used to copy SharePoint content from one place to another. The first window will confirm the destination you drag and dropped the content to. Click Next.
uploading files using CSV 2

3.The second window will give you the ability to apply metadata values. It is a good idea to take advantage of this feature and apply as many metadata values as possible since all the data is validated against SharePoint. There are many capabilities for intelligent and auto tagging available including mapping to NTFS values such as folder names, file names, owners, etc.; or to select values directly from SharePoint managed metadata, choice and lookup lists. Once you have set all your metadata preferences, click Next.
uploading files using CSV 3

4.The final screen of the wizard has a check box towards the bottom of the page. Selecting the Create CSV File for uploading files option will generate a comma separated values file compatible with Excel or any text editing software.
uploading files using CSV 4

5.Although the file content may vary based on the selected metadata, the structure of the CSV spreadsheet will remain consistent. The CSV file will consist of the following columns:

Column Name


Source File

Identifies the physical path to the file that will be uploaded

Target SharePoint Site

Identifies the target site for the file listed in the source file column. The field is left blank by default but may be specified to upload content into different sites and lists using the same CSV file. In order to take advantage of this feature the CSV file must be uploaded on a site not a list level.

Target SharePoint List

Identifies the target list for the import

SharePoint File Name

Identifies the SharePoint item name that will be used for the import ( "/" is used to identify folders)

Content Type

Identifies the SharePoint content type that will be used for the import. This content type should already exist within the target SharePoint list and must be spelled exactly the same way to avoid errors

Custom Fields

Any custom fields would be listed following the content type. These fields must already exist within the target SharePoint list (and content Type). The values entered here must also pass any SharePoint validation or restrictions for the corresponding field.

Created At

Identifies the content creation date which is extracted from the file system. If left blank the value will be set to the current date and time.


This is a reserved field utilized for incremental copy functionality. Do not enter anything into this field.

Modified At

Identifies the last content modification date which is extracted from the file system. If left blank the value will be set to the current date and time

Created By

Identifies the user who created the content. If left blank the value will be set to the user currently logged into SharePoint

Modified By

Identifies the user who last modified the content. If left blank the value will be set to the user currently logged into SharePoint.

Mark Version

For versioned libraries, identifies the version level for the item being imported ("Major" or "Minor"). If a quasi-versioning system was used in the file system, this field along with the SharePoint File Name can be used to recreate the versions in SharePoint. In order to implement this functionality, use the same file name in the SharePoint File Name field and then specify the appropriate version level in this field. If left blank, the default version level will be used during import.

Version Comment

Specifies the comment that will be used when importing items


NOTE: The layout must not be changed, otherwise the imported file will not be recognized. However, the content may be edited to your preferences. Please remember that any values that are modified or edited must be valid to SharePoint, otherwise they will be ignored or an error will be generated.

6. Identify the library or folder destination for your files, and upload content using CSV by doing one of the following:

·Select Upload Content Using CSV from the ribbon in the File Manager section.
uploading files using CSV 7

·right-click and select "Use CSV to..." and then select "Upload/Copy Content".
uploading files using CSV 5

7.Next the Upload or Copy Content using CSV screen will be generated. Enter the location of your .csv file or .bck file.


NOTE: The .bck files are automatically created by the application when downloading the entire site and sub-sites (see Downloading Content from SharePoint for more information).

uploading files using CSV 6

8.You may check individual items or the Check All button at the bottom to select everything. In addition if you are using a custom character set select it in the provided field.

9.To start the import, just press the Finish button.

Downloading Content from SharePoint

The download content from SharePoint option is intended to allow the user to extract content out of SharePoint into a local storage, attached storage, or file share. There are a variety of situations where this feature is helpful. Some examples include:

·Archive or off-board content from SharePoint.

·Move content from one SharePoint to another that is not accessible through a network.

·Ability to download and then reload content into a re-built environment.

Do the following in order to download content from SharePoint:

1.Select the content you want to download. You can select specific items in the content pane, or specific lists/sites in the Navigation pane.
download content from sharepoint 1

2.Once you have selected the content, select the Download Content option. This option is available in:

·the ribbon.
download content from sharepoint 2

·right clicking on the object you want to download and selecting "Download Content to File System" from the right click menu.
download content from sharepoint 3

3.This will open the item or site download wizard, depending on the object you selected for download.


NOTE: An option to include sub-sites is also available but please note that this may result in a lengthy download process

download content from sharepoint 5

4.Select a location to store your download and appropriate options from the Advanced Options section.
download content from sharepoint 6

5.Press Finish to begin the download.
download content from sharepoint 4

Using Scripts and Integration with Windows Task Scheduler

As with many of Metalogix Essentials operations, users may generate a command line script by pressing the Generate Script button (refer to Scripting Reference Guide for additional information).  For repetitive operations like backups, the application has been integrated with Windows Task Scheduler (WTS).  WTS allows users to run jobs on a schedule, in the background, even if no user is currently logged into the computer.  

Once a script is executed, the history will be available in the log viewer.  Unless specified in the script all history files will have auto-generated file names as a unique string of numbers. The path to all log files is: C:\Users\[UserName]\Essentials\.metadata\appLog.

To create a new script and load it into Windows Task Scheduler:

1.Press the Generate Script button within any of the Essentials wizards.
Using scripts1

2.The Command Line Script window will open, displaying the script for that wizard action. Press Copy to Clipboard.
using scripts2

3.Open Windows Task Scheduler and select the Create Basic Task option in the Actions panel.
using scripts3

4.Give your task a name and a description, click Next.
using scripts4

5.Select when you would like the task to start, click Next.
using scripts5

6.Set a start date and time, and how many days you would like the task to continue for. Click Next.
using scripts6

7.Leave the Action selection as "start program" and click Next.
using scripts7

8.In the Program/Script field, paste the script you copied to the clipboard in step 2. Click Next.
using scripts8

9.On the summary page, click Finish.

Copy Files Shares to OneDrive for Business

When licensed, Metalogix Essentials File Manager provides the ability to bulk upload user's networked file system drives into their respective OneDrive for Business Document library in your Office 365 tenant.  This operation has the following requirements for use:

·The account used to perform the upload needs to have access and at least Read permissions from this computer to all the user's networked file system drives.

·The account used to perform the upload needs to be a Global Administrator in this Office 365 tenant.

·The person performing the upload will need to know the relationship (mapping) between each user's networked file system drive and their corresponding Office 365 user account.

·Each user account must have either a SharePoint or OneDrive license assigned to it in Office 365.

Once the requirements above are satisfied, you can proceed with utilizing the bulk upload functionality.

1.To access the wizard, first switch to the Drives tab in the Essentials for Office 365 application.

2.Click the "Copy File Shares" button and select Copy file Shares to OneDrive. This will open the wizard.
Copy FileShare to OneDrive01

3.Give your project a name.
copy fileshare to onedrive 001

4.Enter the URL to the SharePoint Admin Center in your Office 365 tenant.  Click the Connect button and then enter the Username and Password of your Global Administrator to authenticate.  The SharePoint Admin Center URL will look similar to this:
Copy FileShare to OneDrive2

5.In the Map File System to Users section, load the CSV file that maps the relationship between the networked file system drives and the corresponding Office 365 user account.  During upload all the content, files, and sub-folders (if configured), will be migrated from within the root of this network path and uploaded into the user's OneDrive for Business "Documents" library.


NOTE: Click here to download an example mapping file.

6.After the mapping file is loaded, click the Check for Users Personal Sites button to run a validation test.  This option is designed to validate the existence of the mapped user in Office 365 and also to check for the availability of each user's OneDrive for Business.
Copy FileShare to OneDrive3
The following results can be displayed in the "OneDrive Exists" column:

·Yes - The user account has been found in this Office 365 Tenant and this user's OneDrive for Business has already been provisioned.

·No - The user account has been found in this Office 365 Tenant, but this user's OneDrive for Business has not yet been provisioned.

·Invalid User - The user account was not found in this Office 365 Tenant and therefore cannot be included with this operation as currently mapped.

7.After the validation process, select all the valid users from the list which you wish to include in this operation and click Next to continue.

8.On the following page of the wizard, you are presented with a few choices dealing with the content that is to be uploaded.  Select the options required, as described below.
Copy FileShare to OneDrive4

Include sub-folders:  When enabled this will include the content (files and folders) within all the root folders.  When disabled, only the root level content (files and folders) of this location will be included.

Overwrite if files exist:  If a file of the same name already exists in the OneDrive's Documents library, this option will overwrite that file with the current one from the file system.

Incremental Copy:  There are multiple scenarios where an ability to re-copy changes (from the source environment to the target) rather than re-copying all the content is preferable and necessary.  This function allows user's to continue working on their networked drives or in their OneDrives while the migration is performed and then at a later date, the tool can be used to identify and migrate newly created or modified content.  Incremental Copy uses a 'Last <N> Days/Weeks/Months' method to identify and migrate this content starting at the time of execution.  Click here for additional information about Incremental Copy.

Copy Permissions: This setting copies NTFS File System folder permissions when copying file system content to SharePoint libraries or when importing files from the file system using CSV Spreadsheet for metadata.

Remove Folder Structure:  Provides the ability to exclude folders and include only their content, from the upload process.

Migrate to Folder: When this option is enabled, you can create a (or use an existing) root folder structure in the destination library where your source content will be migrated. You will need to define the path like this example:

/My Source Content/2017

In the above example, the folder "My Source Content" and subfolder "2017" will be created in the root library of your destination and all source content will be migrated to this folder location.

Apply Filter:  Creates and assign any number of filter parameters to be used to include or exclude content from the upload process, including but not limited to file extensions, size and dates.

Re-map Users:  If the user accounts within your local file system differ from those in Office 365, this option provides the ability to map the differences so the tool can properly retain the Created/Modified By authorship information and permissions.  Please note that source file shares account are read in the following format and this should be used when creating your user mapping file. domain\user01,  You should also add any necessary Groups to this mapping file too. domain\ADMarketingGroup,Marketing

Enable Azure Turbo Mode: When enabled, this option utilizes Microsoft's SharePoint Online Migration API to increase the migration performance and throughput. A recommendation for optimal use of this API is larger sets of data; the more content, the better the throughput. Please review the User Manual for additional information as well as recommended configuration as this process is a resource intensive operation.

Because this API uses Azure storage as a staging area for the migration, it requires that you provide an Azure storage location. The options are to either utilize Microsoft supplied storage or to provide your own Azure storage location. If you wish to use your own Azure account, you must provide both the Azure Account Name as well as the corresponding Acces Key. If you cannot supply this information, please search our online Knowledge Base, User Manual or contact Support for additional information before proceeding or consider using the Microsoft Supplied Storage option. For more information please see the Azure Turbo Mode section.


NOTE: this function is optional and is only used to increase the migration performance to SharePoint Online or OneDrive for Business in Office 365. It does not provide any additional functionality that is not available when this option is disabled.

·Microsoft Provided Storage: This option allows you to use Microsoft provided Azure storage instead of providing your own for the purpose of utilizing Azure Turbo Mode.


NOTE: the migration end result will not differ regardless of your selection between Microsoft or User provided storage.

·User Provided Storage: This option allows you to provide your own Azure Storage instead of using one provided by Microsoft for the purpose of utilizing Azure Turbo Mode. It requires that you provide both your Azure Blob Storage Account Name as well as its corresponding Access Key by clicking the "Select" button to the right. If you cannot supply this information, please search our online Knowledge Base, User Manual or contact Support for additional information before proceeding. Note:


NOTE: that the migration end result will not differ regardless of your selection between Microsoft or User provided storage.

oDefer Upload to Azure: When enabled, this option does not upload and immediately queue the import process from Azure storage, but rather saves the packages to a file location to then be uploaded and imported at a later time. This will allow you to use another application (at any time) to upload the content to Azure.

§To make use of the Deferred Upload option, the following process takes place:

1.First, you should setup the operation as usual using the Azure Turbo option.

2.Then, check the Defer Upload to Azure option and then Select the location where you wish to store the packages. Please be sure that there is enough disk space to accommodate all the packages that will be created.

3.During this process, the packages will be created, saved to this location and empty containers will also be created in your Azure storage.

4.After the operation completes, you will need to upload (using whichever upload utility you choose) the contents of each local folder into the appropriate Azure container. The folder names created in your local file location will be named exactly the same as the containers in Azure.

5.Once all the content from each folder is uploaded to the appropriate container in Azure storage, open the Azure Turbo Queue and choose the Refresh option.

6.Select one or more of the "Pending" jobs, right click and choose Process. The Import process has now begun and the jobs should soon switch to the status Queued.

oSend Notification: When selected, this feature will send emails to the listed recipients once Migrations are completed.

9.Click Finish to begin the migration.


Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating