Batch File Structure

The following section describes the guidelines to create a batch descriptor file for Migrate SharePoint site, list & library content using batch file mode task option.

1.

The first row of the batch descriptor file should contain the Field Names as headers. In a migration task, data type of the columns must be the same across all lists. SharePoint Columns that are read-only will not be updated by Dockit.

2.

The first field should be named as 'Source Path' and second field should be named as 'Destination Path'. Other field names  should be followed separated by a delimiter character such as comma (,), semi-colon (;) etc. The delimiter character used in the batch descriptor file should be same as 'List Separator' defined in 'Format' string value available in the registry key (HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Jet\4\Engines\Text).

The following table shows the equivalent Format string for 'List Separator' in the registry key:

List Separator Equivalent Format String
, (comma) CSVDelimited
; (semi-colon) Delimited(;)
* (asterisk) Delimited(*)
3.

The 'Source Path' and 'Destination Path' fields will not be carried forward as a metadata column in SharePoint.

4.

The 'Source Path' column of all the rows should contain the URL of the source SharePoint site / list / folder / file / list item. e.g., "http://sharepoint/site1", "http://sharepoint/site1/Lists/Contacts".

5.

If a site URL is given in the batch file, then you can use the following wildcards to exclude / include the sub-sites.

Wildcard characters Example Description
* http://sharepoint/site1/. Migrate all lists, items and folders at the given source SharePoint site level only (excluding sub-sites).
*.* http://sharepoint/site1/*.* Migrate the given source site and its sub-sites with content.

In a list URL is given in the batch file, you can use the following wildcards to migrate the list items from the source SharePoint list based on your requirement.

Wildcard characters Example Description
.* http://sharepoint/lists/Cities/.* Migrate all items from the source SharePoint list.
*.* (default) http://sharepoint/shared documents/*.* Migrate all items and folders from the source SharePoint list.
. http://sharepoint/lists/tasks/. Migrate list items available in the top level folders only.
* http://sharepoint/lists/custom list/* Migrate folder structure only.

 6.

The 'Destination Path' column of all the rows should contain the URL of the target SharePoint site / list / folder e.g., http://RD65/technical documents/folder1

 7.

The column 'New Folder' is an optional column in the batch descriptor file. Using this column, you can provide the relative path to be created in the respective destination location given under 'Destination Path' column prior to migrating the content. For instance, please see the batch descriptor file snippet given below:

Source Path Destination Path New Folder
http://sharepoint.vyapin.com/Documents/Sample File.xls http://sharepoint/technical documents/folder1 folder2/folder3
http://sharepoint.vyapin.com/Lists/Contacts/1_.000 http://sharepoint/Employee Details Sales/Executives

Dockit automatically creates the folders (folder2/folder3) specified in the column 'New Folder' underneath the specified destination location (folder1). The 'Sample File.xls' will be migrated into the new destination location 'http://RD65/technical documents/folder1/folder2/folder3'.

8.

The column 'Site Template' is an optional column in the batch descriptor file. Using this column, you can provide the site template  for the sites being migrated to target SharePoint. For instance, please see the batch descriptor file snippet given below:

Source Path Destination Path Site Template
http://sharepoint.vyapin.com/sites/Mission/Wild http://sharepoint/sites/Mission Team Site
http://sharepoint.vyapin.com/sites/Adventure/Estuary http://sharepoint/sites/Mission/Adventure Blank Site

Dockit creates the site (wild) underneath the specified destination location (Mission) with the template specified in Site Template column (Team Site). The 'Wild' site content will be migrated into the new destination location 'http://sharepoint/sites/Mission/Wild'.

9.

For CSV and TXT formats, all field names and their corresponding metadata values should be enclosed within double quotes (“ ”) e.g., “John Doe”. When using accented characters such as [á é í ó] in folder / file names, the CSV / TXT batch descriptor file must be in UNICODE encoded format.

10.

For Microsoft Excel file formats (XLS / XLSX),  do not enclose the field names and their corresponding metadata values within double quotes.

11.

Ensure date values are in 'Date Only' or 'Date And Time' format.

12.

Lookup data type value will be assigned based on column value only. Lookup columns referring to non-existing list and column will not be updated by Dockit.

13.

People or Group data type value should be user name, Active Directory (AD) group name or SharePoint group name. User or group name referring to non-existing user or group will not be updated by Dockit. The user Login Name (domain\username), Display Name (John Doe) or E-mail address (someone@example.com) can be used to denote a user account.

Sample format of a CSV / TEXT batch descriptor file:

Note: Refer Point #2 for the separator to be used in the batch descriptor file

“Source Path”,“Destination Path“,”Issue Date”,”Author Name”,”Position”,"Department"
“http://sharepoint.vyapin.com/Documents/Sample Brochure.doc”,“http://sharepoint/libone1“,”11/06/2006”,”John Doe”,”Director”,”Senior Management"
“http://sharepoint.vyapin.com/Documents/Sales/Sample Sales Template.xls”,“http://sharepoint/libone2“,”11/24/2006”,”Jane Doe”,”VP Sales”,”Corporate Sales"
“http://sharepoint.vyapin.com/Documents/Sample Product Demo.ppt”,“http://sharepoint/libone3/folder“,”09/09/1999”,”David Blake”,”Sales Manager”,”Consumer Sales”
“http://sharepoint.vyapin.com/Lists/Contacts/1_.000”,“http://sharepoint/Exmployee Details“,”10/21/2003”,”Schew”,”VP Accounts”,”Accounts"
“http://sharepoint.vyapin.com/Lists/Tasks/10_.000”,“http://sharepoint/Lists/Tasks/Folder“,”09/12/2009”,”Crouch”,”Sales Executive”,”Consumer Sales”