Enhance Start-SPMigration GUI for SharePoint SSOM compatibility and update mapping schema
- Added version checks to ensure the script runs in 64-bit Windows PowerShell Desktop Edition. - Implemented checks for STA thread requirement and SharePoint environment validation. - Updated application version to 1.2.0 and supported mapping schema version to 2. - Introduced a new function to retrieve SharePoint product support information based on build version. - Modified mapping table structure to include ToolVersion and additional metadata fields. - Updated sample mapping JSON to reflect new schema version and added new fields for metadata column mappings.
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
# Start-SPMigration
|
||||
|
||||
PowerShell-Skript fuer die Migration von SharePoint On-Premise Inhalten ueber das serverseitige Objektmodell.
|
||||
Version 1.2.0
|
||||
|
||||
PowerShell-Werkzeug fuer die Migration von SharePoint-On-Premises-Inhalten ueber das serverseitige Objektmodell (SSOM). Unterstuetzt werden SharePoint Server 2016 und SharePoint Server 2019.
|
||||
|
||||
Das Skript kann:
|
||||
|
||||
@@ -10,24 +12,46 @@ Das Skript kann:
|
||||
- exportierte Inhalte wieder in ein Ziel-Web importieren
|
||||
- beim Export automatisch eine JSON-`MappingTable` fuer Feld-, Listen- und Bibliotheks-Mappings erzeugen
|
||||
- beim Import dieselbe `MappingTable` fuer Container- und Metadaten-Mappings verwenden
|
||||
- grosse Dokumente streambasiert exportieren und importieren, ohne die komplette Datei in den Arbeitsspeicher zu laden
|
||||
- Fehler einzelner Dateien in `ImportErrors-yyyyMMdd-HHmmss.csv` protokollieren und mit der naechsten Datei fortfahren
|
||||
|
||||
## Voraussetzungen
|
||||
|
||||
- SharePoint On-Premise Server
|
||||
- Ausfuehrung auf einem Server mit installiertem SharePoint PowerShell-Modul
|
||||
- Berechtigungen auf Quell- und Ziel-Web
|
||||
- PowerShell mit Zugriff auf `SharePointServer`
|
||||
- SharePoint Server 2016 oder SharePoint Server 2019
|
||||
- lokale Ausfuehrung auf einem SharePoint-Farmserver; SSOM kann keine entfernte Farm adressieren
|
||||
- 64-Bit Windows PowerShell (Desktop Edition), nicht PowerShell 7
|
||||
- Hauptskript: Windows PowerShell 4.0 oder neuer
|
||||
- GUI: Windows PowerShell 5.0 oder neuer im STA-Modus; Windows PowerShell 5.1 wird empfohlen
|
||||
- Farm- und Web-Berechtigungen fuer die ausgefuehrten Export-/Importaktionen
|
||||
|
||||
Das Skript laedt intern:
|
||||
Das Werkzeug versucht zuerst das SharePoint-Modul und anschliessend den auf klassischen Farmen ueblichen Snap-in-Fallback zu laden:
|
||||
|
||||
```powershell
|
||||
Import-Module SharePointServer
|
||||
Add-PSSnapin Microsoft.SharePoint.PowerShell
|
||||
```
|
||||
|
||||
Die lokale Farmversion wird anhand von `SPFarm.Local.BuildVersion` erkannt. Andere Versionen, einschliesslich Subscription Edition, werden bewusst abgelehnt. Die Umgebung kann vor einer Migration separat geprueft werden:
|
||||
|
||||
```powershell
|
||||
.\Start-SPMigration.ps1 -ValidateEnvironment
|
||||
```
|
||||
|
||||
### Migration zwischen zwei Farmen
|
||||
|
||||
Eine Migration von SharePoint 2016 nach SharePoint 2019 erfolgt mit SSOM zwingend zweistufig:
|
||||
|
||||
1. Export lokal auf einem Server der SharePoint-2016-Quellfarm ausfuehren.
|
||||
2. Den kompletten Exportordner auf einen Server der SharePoint-2019-Zielfarm kopieren.
|
||||
3. Import dort lokal gegen das Ziel-Web ausfuehren.
|
||||
|
||||
Ein kombinierter Export und Import in demselben Prozess ist nur sinnvoll, wenn Quelle und Ziel in derselben lokalen Farm liegen. Ein Import von 2019 nach 2016 ist ein nicht garantierter Downgrade und erzeugt eine Warnung.
|
||||
|
||||
## Dateien im Projekt
|
||||
|
||||
- `Start-SPMigration.ps1`: Hauptskript fuer Export und optionalen Import
|
||||
- `FieldMapping.sample.csv`: altes CSV-Beispiel fuer Feldmapping, weiterhin als Fallback lesbar
|
||||
- `Start-SPMigrationGUI.ps1`: grafische Oberflaeche; die aktuelle Programmversion wird im Fenstertitel angezeigt
|
||||
- `mapping.sample.json`: Beispiel fuer die aktuelle MappingTable
|
||||
- `column-mapping-defaults.sample.json`: Beispiel fuer wiederverwendbare Column-Mapping-Defaults
|
||||
|
||||
## Exportierte Struktur
|
||||
@@ -72,7 +96,7 @@ Fuer den Import sind vor allem diese Informationen relevant:
|
||||
- `ContentTypeId`
|
||||
- interne Feldnamen (`InternalName`)
|
||||
|
||||
Der Name des Inhaltstyps wird bewusst nicht als fuehrende Importinformation verwendet, da er sich im Zielsystem unterscheiden kann.
|
||||
Der Inhaltstyp wird zuerst ueber eine exakt passende ID beziehungsweise einen gleichnamigen Site-Content-Type aufgeloest. Ein beliebiger Basis-Content-Type wie `Item` oder `Document` wird nicht mehr still als Ersatz fuer einen fehlenden eigenen Content-Type verwendet.
|
||||
|
||||
## MappingTable.json
|
||||
|
||||
@@ -87,9 +111,12 @@ Beispiel:
|
||||
|
||||
```json
|
||||
{
|
||||
"SchemaVersion": 1,
|
||||
"SchemaVersion": 2,
|
||||
"ToolVersion": "1.2.0",
|
||||
"GeneratedAtUtc": "2026-04-15T08:00:00.0000000Z",
|
||||
"SourceWebUrl": "http://sharepoint/sites/Quelle",
|
||||
"SourceSharePointProduct": "SharePoint Server 2016",
|
||||
"SourceSharePointBuild": "16.0.5508.1000",
|
||||
"LibraryMappings": [
|
||||
{
|
||||
"ObjectType": "DocumentLibrary",
|
||||
@@ -155,6 +182,8 @@ Beispiel:
|
||||
|
||||
Fuer das Mapping ist vor allem relevant:
|
||||
|
||||
- `SchemaVersion`: aktuell Version 2; Version 1 wird beim Laden auf Version 2 normalisiert, neuere unbekannte Versionen werden abgelehnt
|
||||
- `ToolVersion`, `SourceSharePointProduct` und `SourceSharePointBuild`: dokumentieren die erzeugende Tool- und Quellfarm-Version
|
||||
- `TargetTitle`: Zielname von Liste oder Bibliothek
|
||||
- `TargetInternalName`: Zielfeld fuer die exportierte Metadatenspalte
|
||||
- `SystemColumns`: SharePoint-Standardfelder wie `EventDate`, `EndDate`, `Title` oder `Created`
|
||||
@@ -163,6 +192,7 @@ Fuer das Mapping ist vor allem relevant:
|
||||
- `ImportSupported`: steuert, ob eine Spalte beim Import ueberhaupt beruecksichtigt wird
|
||||
- Taxonomy-Felder (Einfach- und Mehrfachwerte) werden beim Import ueber den exportierten `TermGuid` gesetzt; dabei wird angenommen, dass dieselben Terme im Ziel bereits mit identischer GUID existieren
|
||||
- Die exportierte `WssId` wird bewusst nicht uebernommen: Sie ist nur innerhalb der Quell-SiteCollection gueltig. SharePoint loest beim Setzen des Feldwerts die zielseitige `WssId` auf und legt den Eintrag in der `TaxonomyHiddenList` bei Bedarf selbst an. Die Hidden List soll deshalb nicht separat migriert oder vorab befuellt werden.
|
||||
- Klassische `Lookup`- und `LookupMulti`-Spalten werden derzeit explizit als nicht importierbar markiert. Quellseitige Lookup-IDs sind in einer anderen Farm nicht portabel; ein korrekter Ausbau benoetigt ein fachliches Schluessel-Mapping und einen zweiphasigen Import.
|
||||
|
||||
Wenn eine Ziel-Liste oder Ziel-Bibliothek nicht existiert, gibt das Skript eine Warnung aus, dass dieser Container manuell angelegt werden soll.
|
||||
|
||||
@@ -204,13 +234,17 @@ Beispiel:
|
||||
|
||||
## Parameter
|
||||
|
||||
### Pflichtparameter
|
||||
### Web- und Pfadparameter
|
||||
|
||||
- `SourceUrl`: Quell-Web fuer den Export
|
||||
- `TargetUrl`: Ziel-Web fuer den Import
|
||||
- `SourceUrl`: Quell-Web; beim Export erforderlich
|
||||
- `TargetUrl`: Ziel-Web; beim Import erforderlich
|
||||
|
||||
`OutputPath` ist optional. Standard ist `.\SPMigrationOutput` im aktuellen Verzeichnis.
|
||||
|
||||
### Umgebungspruefung
|
||||
|
||||
- `ValidateEnvironment`: prueft Windows PowerShell, x64-Prozess, SharePoint-Cmdlets, Taxonomy-Assembly und die lokale SharePoint-2016/2019-Farm, ohne eine Migration zu starten
|
||||
|
||||
### Exportparameter
|
||||
|
||||
- `Export`: fuehrt den Export aus
|
||||
@@ -234,10 +268,17 @@ Hinweis:
|
||||
- Wenn `Overwrite` nicht gesetzt ist und eine Datei bereits existiert, wird bei aktiver Versionierung eine neue Version geschrieben; ohne Versionierung wird die Datei uebersprungen.
|
||||
- Nicht importierbare Systemfelder wie `Attachments`, `Created`, `Modified`, `Author` oder `Editor` werden automatisch aus der MappingTable herausgehalten bzw. beim Import uebersprungen.
|
||||
- Vor dem Speichern prueft das Skript fehlende Pflichtfelder. Wenn ein einzelnes Listen- oder Datei-Metadatenobjekt trotzdem nicht gespeichert werden kann, wird es mit Kontext-Warnung uebersprungen und der Import laeuft weiter.
|
||||
- Fehler bei einzelnen Dateien stoppen den restlichen Dateiimport nicht. Sie werden im Exportordner in einer Datei `ImportErrors-yyyyMMdd-HHmmss.csv` mit Importphase, Datei, Bibliothek, Ziel-Web und Fehlerursache protokolliert.
|
||||
- Beim Listenimport legt das Skript bei Bedarf ein verstecktes Textfeld `StartSPMigrationSourceUniqueId` in der Zielliste an. Wiederholte Imports aktualisieren damit vorhandene Elemente anhand der exportierten Source-`UniqueId` statt sie erneut anzulegen.
|
||||
|
||||
## Beispiele
|
||||
|
||||
### SSOM-Umgebung pruefen
|
||||
|
||||
```powershell
|
||||
.\Start-SPMigration.ps1 -ValidateEnvironment
|
||||
```
|
||||
|
||||
### Nur Export
|
||||
|
||||
```powershell
|
||||
@@ -257,7 +298,7 @@ Hinweis:
|
||||
-MappingTable "C:\Temp\SP-Export\MappingTable.json"
|
||||
```
|
||||
|
||||
### Export, MappingTable anpassen, dann Import
|
||||
### SharePoint 2016 exportieren, MappingTable anpassen und auf SharePoint 2019 importieren
|
||||
|
||||
```powershell
|
||||
.\Start-SPMigration.ps1 `
|
||||
@@ -266,7 +307,7 @@ Hinweis:
|
||||
-Export
|
||||
```
|
||||
|
||||
Danach `MappingTable.json` bearbeiten und dort `TargetTitle` sowie `TargetInternalName` anpassen.
|
||||
Danach den kompletten Ordner `C:\Temp\SP-Export` auf den SharePoint-2019-Farmserver kopieren und `MappingTable.json` bearbeiten. Dort insbesondere `TargetTitle` sowie `TargetInternalName` pruefen.
|
||||
|
||||
Anschliessend:
|
||||
|
||||
@@ -322,10 +363,26 @@ Anschliessend:
|
||||
- Die Zielaufloesung kann ueber `MappingTable.json` mit `TargetTitle` ueberschrieben werden.
|
||||
- Listenanhaenge werden derzeit noch nicht physisch mit importiert.
|
||||
- Ordner in normalen Listen werden beim Import derzeit uebersprungen.
|
||||
- `Lookup`- und `LookupMulti`-Spalten werden nicht importiert, weil Quell-IDs auf der Zielfarm keine stabile Bedeutung haben.
|
||||
- SharePoint-Gruppen in Personenfeldern werden exportseitig erkannt, aber noch nicht automatisch einer Zielgruppe zugeordnet; ein nicht aufloesbarer nichtleerer Wert wird als Feldfehler gemeldet.
|
||||
- Fehlende Ziellisten oder Zielbibliotheken werden derzeit nicht automatisch angelegt; das Skript gibt stattdessen eine Warnung zur manuellen Anlage aus.
|
||||
- Bereits vorhandene Dateien unter `Files` und `Lists` werden vor einem erneuten Export nicht automatisch entfernt. Fuer jeden produktiven Lauf sollte deshalb ein neuer, leerer `OutputPath` verwendet werden.
|
||||
- Schlaegt das Setzen von Metadaten nach dem Datei-Upload fehl, kann die bereits hochgeladene Datei als Teilimport im Ziel verbleiben. Der Fehler wird protokolliert; eine automatische Rollback-/Quarantaene-Logik ist noch nicht vorhanden.
|
||||
- Dateiversionen, Check-in/Publish/Approve-Zustaende und Listen-Versionen werden noch nicht vollstaendig rekonstruiert.
|
||||
- Grosse Listen werden derzeit als eine JSON-Datei verarbeitet; fuer sehr grosse Datenmengen fehlt noch ein paginierter Chunk-Export.
|
||||
- Sehr spezielle Feldtypen koennen je nach Farm-Konfiguration zusaetzliche Anpassungen benoetigen.
|
||||
- Das Skript ist fuer SharePoint On-Premise mit serverseitigem Objektmodell gedacht, nicht fuer SharePoint Online.
|
||||
- Das Skript ist fuer SharePoint Server 2016/2019 mit SSOM gedacht, nicht fuer SharePoint Online, CSOM, PnP PowerShell oder Subscription Edition.
|
||||
- SharePoint Server 2016 und 2019 haben das Ende des erweiterten Microsoft-Supports erreicht. Das Werkzeug unterstuetzt sie technisch weiter, ersetzt aber keine Plattform-Sicherheitsstrategie.
|
||||
|
||||
## Empfohlene naechste Ausbaustufen
|
||||
|
||||
1. Manifestgesteuerte Run-Ordner mit SHA-256-Pruefung, damit keine Altdateien oder falschen Sidecars importiert werden.
|
||||
2. Transaktionaler Dokumentstatus mit Metadaten-Save vor finalem Check-in sowie Rollback oder Quarantaene bei Teilfehlern.
|
||||
3. Zweiphasiges Lookup-Mapping ueber konfigurierbare fachliche Schluessel statt ueber lokale Item-IDs.
|
||||
4. Paginierter Listenexport und chunkweiser Import fuer grosse Listen.
|
||||
5. Einheitliches Errorlog und Abschlussreport fuer Export, Dateien, Listen und einzelne Listenelemente.
|
||||
6. Automatisierte Integrationstests auf je einer SharePoint-2016- und SharePoint-2019-Testfarm.
|
||||
|
||||
## Empfehlung
|
||||
|
||||
Zuerst immer mit `-Export` testen und die exportierten `*.properties.json`, Listen-JSONs und die `MappingTable.json` pruefen. Danach die Zielnamen und Feldmappings vervollstaendigen und erst dann den Import gegen das Zielsystem laufen lassen.
|
||||
Zuerst `-ValidateEnvironment` ausfuehren. Danach immer in einen neuen, leeren Ausgabeordner exportieren und die exportierten `*.properties.json`, Listen-JSONs und die `MappingTable.json` pruefen. Anschliessend Zielnamen und Feldmappings vervollstaendigen und den Import zuerst gegen ein Test-Web laufen lassen.
|
||||
|
||||
Reference in New Issue
Block a user