7.3. Restructure using Folders/Containers
Using this feature the customer can create a table called a ‘Structure Mapping’ which lists source folder/containers and specifies where they should be placed in the target. When an entry is specified, all of its children will also be moved beneath it, so it’s not necessary to specify all source folders.
In summary the process is to download source system structure information into a .CSV file. Edit this to add suitable target details and then upload the .CSV file.
Select the download icon to start Structure mapping. The .CSV file to be used to populate structure mapping will be populated list of folders from the source. When download option is selected, the user is prompted for the folder path depth. This is the number of folders ‘down’ that it should export. Note the value is relative to the source path specified.
Example Source Folder Hierarchy:
Documents\Engineering\Project Diamond
Documents\Engineering\Project Diamond\Documentation
Documents\Engineering\Project Diamond\Beta Programme
Documents\Engineering\Project Diamond\Beta Programme\Internal
Documents\Engineering\Project Diamond\Beta Programme\SE Community
Documents\Engineering\Project Diamond\Beta Programme\External
Specify a folder depth of three would populate the CSV with unique folders that are 3 levels deep.
Folder Depth of 3
Documents\Engineering\Project Diamond
Folder Depth of 4
Documents\Engineering\Project Diamond
Documents\Engineering\Project Diamond\Documentation
Documents\Engineering\Project Diamond\Beta Programme
7.3.1. SharePoint Structure Basics
This section describes the basic principles of structures in SharePoint and may be helpful if the user is not very familiar with SharePoint.
The structure to locate any item in SharePoint is defined by 3 elements
- SiteCollection
- Document Library
- Folder
Items can be stored at the Document Library level (i.e. the root) or within a Folder or Subfolder.
To migrate into SharePoint the SiteCollection, Document Library and Folder needs to be known. Depending upon the information specified in the Migration Job, all of this information may have been specified, if not, then the omitted fields need to be specified in Structure Mapping to allow these items to be migrated successfully.
7.3.2. Completing Structure Mapping Overview
Source related fields in Structure Mapping (SourcePathID and SourcePath)
Depending upon the source. Structure mapping will either require the SourcePath or SourcePathID to be specified to identify the source location to be mapped depending upon the source. These columns will be populated automatically when the structure mapping template is downloaded.
Target fields in Structure Mapping
The information that’s mandatory in structure mapping depends upon the full target path specified when the migration job was created. e.g. If a Site Collection was specified as the target location in the Migration Job, then TargetSubSite, TargetLibrary are required and TargetFolder is optional. (The folder names in the target will come from the source).
Structure Mapping Field | Description |
TargetSiteCollection |
This is a URL that is required when: - A: Target path is to tenant level. B: To migrate to a Site Collection other than what’s specified in target path. |
TargetSubSite | Specify / to migrate to root, otherwise the name of the SubSite. If the SubSite does not exist, it will be created using the Team Site template. |
TargetLibrary | Required if a Document Library is not specified in target path on the Migration job. |
TargetFolder | Not mandatory. Specify if want to migrate to specific folder. |
TargetRootSetting | Required if wanted to use MERGE setting. |
When a structure mapping is imported, it will be validated using the logic from the above table to ensure that columns contain necessary values. With the exception of the TargetRootSettings field, it does NOT ensure that the values are correct/exist in the target.
Target SiteCollection:
This is the Full URL of the Target Site collection.
Target SubSite:
Specify / to migrate to root, otherwise the name of the SubSite. If the SubSite does not exist, it will be created using the Team Site template.
Target Library:
If migrating to an existing library, the value needs to be the ‘internal name’ of the target library NOT the display name e.g. Shared Documents (Internal name) instead of Documents (Display Name). Note values are case sensitive so specify the internal name exactly. If the specified library does not exist, it will be created.
TargetFolder:
Specify / to migrate to the root folder or else specify name of folder which will be created if it does not exist. Any value specified will overwrite the target folder.
TargetRootSetting:
If TargetRootSetting field is blank or set to CREATE, the final folder path in the source path will be used to create a parent root folder in the target underneath which the data is migrated. A value of MERGE can be specified and in that scenario no root path is created and the data is migrated directly into the target folder.
7.3.3. Structure Mapping Examples
Structure Mapping example files are located in C:\Program Files\Proventeq\Proventeq Content Suite\SampleFiles
Example File Share Structure Mapping
In this example, assume that the SiteCollection has been specified as AcmeSure in the Target Connection in the Migration Job. This means it is not required in the structure mapping. This is a FileShare migration and so the SourcePath field is used to specify the source path. By using the download structure mapping template feature the SourcePath will be prepopulated.
Row 1
- TargetSubSite is set to / since not migrating to a Subsite
- TargetLibrary contains name of Document Library Insurance
- TargetFolder is set to / to migrate to the root of the Insurance Document Library
- TargetRootSetting is set to Create. This means the last folder Path in SourcePath will be created as a root.
Result: -
Items in “E:\File System Test Data\Insurance” are migrated to “AcmeSure\Insurance\Insurance\”
Row 2
As above but TargetFolder is specified so items from Health Insurance folder in the Source are migrated to Health folder with the Insurance DocumentLibrary.
Result: -
Items in “E:\File System Test Data\Insurance\Health Insurance” are migrated to “AcmeSure\Insurance\Health\Health Insurance”
See how the Create TargetRootSetting means that the “Health Insurance” folder is created below the Health Target Folder.
Row 9 – Example using MERGE
- TargetSubSite is set to Archive so migration is to SubSite called Archive which will be created if it does not exist.
- TargetLibrary contains name of Document Library Archive
- TargetFolder is set to Archive Docs to migrate to the Archive Docs folder (which will be created within the Archive Sub Site if it doesn’t exist)
- TargetRootSetting is set to Merge. This means items in the root of the source folder will be migrated into the root of the target.
Result: -
“E:\File System Test Data\Insurance\Insurance Archive” are migrated to “AcmeSure\Archive\Archive\Archive Docs”
Note how because TargetRootSetting is set to Merge, “Insurance Archive” is not in the target path. If it was set to Create, items would be migrated
E:\File System Test Data\Insurance\Insurance Archive migrated to AcmeSure\Archive\Archive\Archive Docs\Insurance Archive
Below is an example where the Target connection is at the Tenant level and no specific Site Collection is specified so the TargetSiteCollection is mandatory as it specifies the Site Collection the items should be migrated to.
Example Non FileShare/ShareFile Structure Mapping
For migrations other than ShareFile and File Share, structure mapping entries require that the SourcePathID is used to identify the target path. By using the download structure mapping template feature the SourcePathID will be prepopulated.
Example Structure Mapping to OneDrive
When migrating to OneDrive, there needs to be a structure mapping entry for each user. The TargetSiteCollection URL is usually of the form https://<tenant name>-my.sharepoint.com/personal/<user principal name>
Comments