Transformieren von Farmlösungen in das SharePoint-Add-In-Modell

Artikel
04/08/2023

Wenn Sie Ihre SharePoint-Umgebung mithilfe von Farmlösungen erweitert haben und die Erweiterungen zum SharePoint-Add-In-Modell migrieren möchten, um die Transformation zu SharePoint Online zu vereinfachen, müssen Sie Ihre Farmlösungen in das SharePoint-Add-In-Modell transformieren.

Das Transformieren Ihrer Farmlösungen in das SharePoint-Add-In-Modell umfasst das Analysieren vorhandener Erweiterungen, das Entwerfen und Entwickeln des neuen SharePoint-Add-In sowie das Testen und Bereitstellen Ihres Add-In in Ihrer Produktionsumgebung.

Dieser Artikel beschreibt die Verfahren und Best Practices bei der Transformation Ihrer Farmlösungen in das SharePoint-Add-In-Modell.

Planen der Transformation

Wenn Sie Farmlösungen in das SharePoint-Add-In-Modell transformieren, sollten Sie sicherstellen, dass die Auswirkungen auf die Benutzer minimal sind. Analysieren Sie Ihre aktuellen Farmlösungen sorgfältig, und entwerfen Sie dann Ihr neues SharePoint-Add-In so, dass die Anforderungen Ihrer Organisation erfüllt werden. Wir empfehlen den folgenden Prozess, um eine erfolgreiche Transformation sicherzustellen.

Bereitschaft

Informieren Sie sich über folgende Themen:

Das SharePoint-Add-In-Modell, unterschiedliche Arten von Add-Ins sowie Hostingoptionen. Weitere Informationen finden Sie unter SharePoint-Add-Ins.
Remote-Zugriffstechnologien für den Zugriff auf Ihre lokalen Daten.

Bewertung der Lösung

Analysieren Sie die funktionalen und geschäftlichen Anforderungen, indem Sie:

bereitgestellte Farmlösungen in Ihrer aktuellen Umgebung identifizieren. die Verwendung von Drittanbietertools erwägen, um bereitgestellte Erweiterungen zu finden. eine detaillierte Analyse der einzelnen identifizierten Farmlösungen durchführen.
die Anforderungen mit Ihren Benutzern überprüfen. Bitten Sie Ihre Benutzer, Ihnen zu zeigen, wie sie die vorhandenen Farmlösungen bei ihrer täglichen Arbeit verwenden.
Neue Funktionen identifizieren, dokumentieren und entwerfen, die in das neue SharePoint-Add-In eingeschlossen werden. Überprüfen Sie Ihre Liste neuer Featureanfragen von Benutzern, um weitere Ideen zu erhalten.
Nicht genutzte Features identifizieren und mit Ihren Benutzern vereinbaren, diese Funktion im neuen SharePoint-Add-In wegzulassen.
Für jede Farmlösung ermitteln, ob sie mit einem SharePoint-Add-In ersetzt werden soll. Einige Lösungen, wie SharePoint-Administrationserweiterungen, können nicht in das SharePoint-Add-In-Modell dupliziert werden. Weitere Informationen finden Sie unter SharePoint Application Lifecycle Management und SharePoint-Add-Ins im Vergleich zu SharePoint-Lösungen.

Lösungsplanung

Entwerfen Sie mithilfe des SharePoint-Add-In-Modells die neue Anwendung basierend auf Folgendem:

Den im Schritt Bewertung der Lösung gesammelten Anforderungen.
Der Analyse des vorhandenen Codes. Bei der Codeanalyse sollten Sie Codeabschnitte identifizieren, die gelöscht werden können (weil der Code beispielsweise nicht mehr verwendet wird oder sich die Anforderungen geändert haben).

Entwickeln und Testen der Version des SharePoint-Add-In-Modells Ihrer Anwendung

Dies ist in der Regel der zeitaufwändigste Schritt beim Transformationsprozess.

Bereitstellen Ihres neuen Add-Ins

Je nach Ihren Anforderungen führen Sie die Farmlösungen evtl. parallel zum neuen SharePoint-Add-In aus oder Sie ziehen die Farm-Lösung zurück und erlauben Benutzern nur die Verwendung des neuen SharePoint-Add-In. Stellen Sie in beiden Szenarios sicher, dass Ihre Bereitstellung stabil ist, und senden Sie Ihren Benutzern entsprechende Mitteilungen.

Wenn Ihr Inhalt in vorhandenen Websitesammlungen von Ihren Farmlösungen abhängig war (beispielsweise, wenn Inhalt unter Verwendung eines Inhaltstyps erstellt wurde), müssen Sie vor dem vollständigen Zurückziehen der Farmlösung Ihren vorhandenen Inhalt transformieren, um Ihre neue SharePoint-Add-In-Modelllösung zu verwenden. Stellen Sie sicher, dass Sie genügend Zeit haben, um diese Aufgabe auszuführen, da sie zeitaufwändig sein und sich schwierig gestalten kann.

Transformationsansätze zur Bereitstellung Ihres neuen SharePoint-Add-In

Nach Abschluss der Entwicklung und Einheitstests Ihres neuen SharePoint-Add-In beginnen Sie mit dem Transformieren Ihrer Farmlösung zum neuen SharePoint-Add-In mithilfe der Transformationsansätze in den folgenden Tabellen.

Transformationsansatz	Beschreibung	Vorteile	Nachteile
Direkt	Stellen Sie Ihr neues SharePoint-Add-In in Ihrer vorhandenen SharePoint-Umgebung bereit. Sie müssen sicherstellen, dass Ihre Website das neue SharePoint-Add-In verwendet, bevor die Farmlösung zurückgezogen wird.	Weniger allgemeine Auswirkungen auf die Benutzer. Weniger Ressourcen erforderlich, weil Sie Ihre vorhandene SharePoint-Umgebung verwenden. Keine Notwendigkeit von Drittanbietertools. Minimale Ausfallzeiten der Website. Upgrade jeweils einer Websitesammlung, statt der gesamten Farm auf einmal. URLs ändern sich nicht.	Nachverfolgung des Fortschritts aller betroffenen Assets auf einer Website schwierig. Erhöhte Wahrscheinlichkeit der Erstellung verwaister Elemente (wenn ein Asset auf eine Datei im Dateisystem zeigt, die nicht vorhanden ist).
Swing oder Inhaltsmigration	Extrahieren Sie Ihre Inhalte aus Ihren vorhandenen Websitesammlungen, in denen Ihre Farm-Lösungen derzeit bereitgestellt werden, und stellen Sie den Inhalt in einer neuen Websitesammlung bereit, die das neue SharePoint-Add-In verwendet. Wenn Sie Inhalt zu SharePoint Online migrieren, wird dieser Vorgang normalerweise verwendet.	Bereinigen Sie die SharePoint-Umgebung ohne vorherige Farmlösungsabhängigkeiten. Die neue Websitesammlung wird von der Produktionsumgebung isoliert. Veröffentlichen Sie die aktualisierte Websitesammlung, wenn Sie bereit sind. .	Erfordert Drittanbietertools zur Unterstützung bei der Inhaltsmigration. Erfordert eine zusätzliche SharePoint-Umgebung. Website-Ausfallzeiten. URLs ändern sich möglicherweise, wenn Sie beide Websites parallel für einen längeren Zeitraum ausführen.

Best Practices für bestimmte Farmlösungen

Wenden Sie die folgenden Best Practices bei der Transformation spezifischer Lösungen an.

Seitenlayouts und Gestaltungsvorlagen

Benutzerdefinierte Seitenlayouts und Gestaltungsvorlagen sind möglicherweise auf Veröffentlichungswebsites oder Teamwebsites mit aktivierten Veröffentlichungsfeatures vorhanden.

So ersetzen Sie Seitenlayouts und Gestaltungsvorlagen:

Laden Sie das neue Seitenlayout oder die neue Gestaltungsvorlage auf Ihre Website hoch. Laden Sie neue Gestaltungsvorlagen und Seitenlayouts entweder manuell oder mithilfe von Remote-APIs in Ihre Websitesammlung hoch. Remote-APIs umfassen das clientseitige Objektmodell (CSOM) oder REST. Dadurch wird sichergestellt, dass die Gestaltungsvorlagen und Seitenlayouts keine Abhängigkeiten von einer Farmlösung aufweisen.
Konfigurieren Sie Ihre Website, um die neuen Seitenlayouts und Gestaltungsvorlagen zu verwenden.
Ziehen Sie die vorherige Version der Seitenlayouts und Gestaltungsvorlagen zurück.

Webparts und Steuerelemente

So ersetzen Sie Webparts und Steuerelemente:

Durchsuchen Sie alle vorhandenen Seiten, um zu bestimmen, welche Seiten Webparts haben.
(Optional) Überprüfen Sie Out-of-the-Box-Webparts, um festzustellen, ob sie Ihre benutzerdefinierten Webpart ersetzen können.
Ersetzen Sie vorhandene Webparts mit App-Part-Instanzen oder mit anderen Methoden (z. B. eingebettetes JavaScript in Seiten oder Seitenlayouts), um dieselbe Funktionalität zu erzielen.
Verwenden Sie eingebettetes JavaScript, um Benutzeroberflächenelemente zu bearbeiten.

Hinweis

So ersetzen Sie vorhandene Webparts durch App-Parts:

Aktivieren Sie das Sideloading von Add-Ins in Ihr Office 365-Abonnement. Wenden Sie sich an Ihren Office 365-Administrator.
Verwenden Sie CSOM zum Aktivieren des Sideloading von Add-Ins auf Ihrer Website. Weitere Informationen finden Sie im Core.SideLoading-Codebeispiel.
Installieren Sie das App-Part auf Ihrer Website.
Deaktivieren Sie das Sideloading von Add-Ins auf Ihrer Website.
Deaktivieren Sie das Sideloading von Add-Ins in Ihr Office 365-Abonnement. Wenden Sie sich an Ihren Office 365-Administrator.

Seitenbearbeitung

Möglicherweise müssen Sie Seitenbearbeitung während der benutzerdefinierten Websitebereitstellung implementieren. Das Codebeispiel Provisioning.Pages zeigt Techniken zur Seitenbearbeitung, z. B. das Erstellen einer Wiki-Seite, das Hinzufügen von HTML-Inhalten zur Seite, das Erstellen einer Liste höher gestufter Links, das Erstellen von Seiten mit unterschiedlichen Layouts, das Hinzufügen von sofort einsatzbereiten Webparts zur Seite und das Entfernen der Seite.

Websitespalten, Listendefinitionen und Inhaltstypen

Wenn Ihre Websitespalten, Listendefinitionen und Inhaltstypen mithilfe der Feature Framework-Elemente erstellt wurden (bereitgestellt mit Farmlösungen), müssen Sie für die Transformation Swing oder Inhaltsmigration verwenden. Dies gilt nicht für Feature Framework-Elemente, die mit Sandkastenlösungen bereitgestellt wurden. Um die Inhaltsmigration zu verwenden, müssen Sie Drittanbietertools zum Entfernen der Farmlösungsabhängigkeiten einsetzen.

Module oder Feature Framework

Module verwenden Verweise auf Dateien, was bedeutet, dass die Dateien nicht angepasst und im Dateisystem bereitgestellt werden. Wenn Ihre Farmlösungen Module verwenden, passen Sie die Dateien durch Bereitstellung alternativer Versionen derselben Dateien für die Inhaltsdatenbank an, durchsuchen und aktualisieren Sie Ihre Lösungen, um auf die neuen Dateien in der Inhaltsdatenbank zu verweisen, und ziehen Sie dann die Farmlösung zurück, die auf Dateien im Dateisystem zeigte.

Websitevorlagen und Webvorlagen

Sie sollten sich auf die Transformation von Feature Framework-Elementen konzentrieren, die von der Websitevorlage oder Webvorlage bereitgestellt werden. Stellen Sie beispielsweise sicher, dass die Seite „default.aspx“ der Website nicht ersetzt wird, wenn Sie die Farmlösung zurückziehen.

Zeitgeberaufträge

Wenn Sie SharePoint Online verwenden, können Sie Zeitgeberaufträge nicht erstellen und verwalten. Sie können stattdessen eine Konsolenanwendung erstellen, die Windows Task Planer oder einen Azure WebJob verwendet, um die Konsolenanwendung remote zu planen und auszuführen.

Beim Erstellen eines benutzerdefinierten Zeitgeberauftrags bestimmen Sie, ob Sie ein bestimmtes Konto oder ein OAuth-basiertes Token verwenden müssen, dass App-spezifisch ist. Das Core.TimerJobs.Samples-Codebeispiel zeigt, wie Sie Ihren eigenen benutzerdefinierten Zeitgeberauftrag erstellen.