Create Search Batch Descriptor File

The following section gives you the guidelines to create an external batch descriptor file for Export SharePoint List contents using the search option task type.


The first row of the metadata file should contain the Field Names as headers.


The first field should be named as 'Path' and second field should be named as 'Destination Path'.

The other field names should be separated by a delimiter character such as comma (,), semi-colon (;) etc. The delimiter character used in the external metadata file should be same as 'List Separator' defined in locale settings  in 'Regional and Language Options' in Control Panel and '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(*)

The first column of all the rows should contain the source URL of the list or folder or file or folder or list item. In other words, the source path should be either a SharePoint List URL (e.g., http://vyapin/Shared Documents) or sub-folder URL within SharePoint List (e.g.,http://vyapin/Shared Documents/sample folder1) or file URL within the SharePoint List (e.g.,http://vyapin/shared documents/sample folder1/SampleDocument.doc) or list item URL within the SharePoint List (e.g., http://vyapin/lists/cities/1_.000)


The second column of all the rows should contain the destination folder location e.g., "C:\My Projects\" (or) \FileServer\My Documents, where the exported item is to be stored.


Be consistent with the drive letters and UNC path when exporting folders, files and list item attachments from a SharePoint list. If you use local / mapped drives to export files or list item attachments , ensure the 'Destination Path' field has the corresponding local / mapped drive path (e.g., M:\My Documents). If you use shares to export file or list item attachments, ensure the 'Destination Path' field has the corresponding UNC path (e.g.,\\Machine_Name\Share_Name).


For CSV and TXT formats, all field names and their corresponding metadata values should be enclosed within double quotes (“ ”) e.g., “http://vyapin/Shared Documents/sample folder1”. When using accent characters such as [á é í ó] in folder / file names, the CSV / TXT metadata file must be in UNICODE encoded format.


For Microsoft Excel file formats (XLSX),  you do not have to enclose the field names and their corresponding values within double quotes.


Sample format of a CSV / TEXT batch descriptor file:

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

“Path”,“Destination Path“
“http://vyapin/shared documents/Sample Brochure.doc“,“C:\My Documents”
“http://vyapin/shared documents/sample folder1/*“,“\\vyapinfs\ExportDocs\shared doc contents”
“http://vyapin/lists/*.*“,“C:\My Sales\Lists Backup”
"http"//vyapin/lists/cities/.*","C:\My Cities\Backup