Skip to content

Commit a28588e

Browse files
Merge pull request SharePoint#8884 from JoanneHendrickson/patch-78
Update migration-api-overview.md
2 parents b907402 + f752f8f commit a28588e

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

docs/apis/migration-api-overview.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "SharePoint Online Import Migration API"
33
description: "This article provides in depth information on how to use the SPO Migration API."
4-
ms.date: 03/28/2023
4+
ms.date: 04/10/2023
55
ms.author: jhendr
66
author: JoanneHendrickson
77
manager: serdars
@@ -337,6 +337,49 @@ File content that is referenced within the manifest of the package structure mus
337337

338338
The main requirement for the structure is that the FileValue references in the **Manifest.XML** file must refer to the exact name and physical hierarchy that the content is stored in within the Azure Blob Store ___location for import. The destination file names and folder hierarchy from the import operation aren't directly related to the physical naming and hierarchy and are instead defined through the **Manifest.XML** file.
339339

340+
### ArchivedFiles.XML
341+
342+
The **ArchivedFiles.XML** file, if included, is expected to be at the root of the Azure blob storage container defined by the CreateMigrationJob’s azureContainerManifestUri parameter. The QuickXorHash/Checksum has to be computed for the optional pack0.zip file using the [QuickXorHash Algorithm](/onedrive/developer/code-snippets/quickxorhash). If small files in the Manifest.xml are not archived (not showing in ArchiveFiles.xml), they still can be processed as before (equivalent to feature off).
343+
344+
This file allows for transferring files in batch. When the ArchivedFiles.xml is provided by the client (the default scenario), the server side will validate the correctness of the .xml schema, then import the files inside each pack. When ArchivedFiles.XML is not provide by the client, the feature will be disabled.
345+
346+
#### Prerequisites
347+
348+
The QuickXorHash/Checksum has to be computed for the optional pack0.zip file using the [QuickXorHash Algorithm](/onedrive/developer/code-snippets/quickxorhash).
349+
QuickXorHash is created for the .zip file which concatenates all smaller files.
350+
351+
|Item|Requirement|
352+
|:-----|:-----|
353+
|Encryption|The zip file must be encrypted.|
354+
|File size|Less than 100KB. Note: File size is calculated based on the encrypted file.|
355+
|Compression|Do not compress the small data files your are archiving into the zip file.|
356+
|Zip file size|Maximum size 10MB|
357+
|Zip files per package|Maximum of 2|
358+
359+
#### Table 1: Example ArchivedFiles.XML file
360+
361+
```xml
362+
<?xml version="1.0" encoding="utf-8"?>
363+
<ArchivedFiles>
364+
<ArchivedFile Name="pack0.zip" Checksum="xxxxxx=">
365+
<File FileValue="01.dat" />
366+
<File FileValue="02.dat" />
367+
<File FileValue="03.dat" />
368+
<File FileValue="04.dat" />
369+
<File FileValue="05.dat" />
370+
<File FileValue="06.dat" />
371+
</ArchivedFile>
372+
<ArchivedFile Name="pack1.zip" Checksum="xxxxxx=">
373+
<File FileValue="07.dat" />
374+
<File FileValue="08.dat" />
375+
<File FileValue="09.dat" />
376+
<File FileValue="10.dat" />
377+
<File FileValue="11.dat" />
378+
<File FileValue="12.dat" />
379+
</ArchivedFile>
380+
</ArchivedFiles>
381+
```
382+
340383
### ExportSettings.XML
341384

342385
The **ExportSettings.XML** file is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This required file is validated using the constrained DeploymentExportSettings.XSD, which has some limited changes from current published [full 2013 package schema](../schema/content-migration-schemas.md).

0 commit comments

Comments
 (0)