Erste Schritte beim Erstellen von Websitevorlagen und Websiteskripts

Artikel
04/08/2023

Sie können Websitevorlagen erstellen, um wiederverwendbare Listen, Designs, Layouts oder benutzerdefinierte Aktionen bereitzustellen, damit Ihre Benutzer schnell neue SharePoint-Websites mit den benötigten Features erstellen können.

In diesem Artikel wird beschrieben, wie Sie eine einfache Websitevorlage erstellen, die eine SharePoint-Liste zum Nachverfolgen von Kundenbestellungen hinzufügt. Sie verwenden die Websitevorlage, um eine neue SharePoint-Website mit der benutzerdefinierten Liste zu erstellen. In diesem Artikel wird gezeigt, wie Sie SharePoint PowerShell-Cmdlets in SharePoint zum Erstellen von Websiteskripts und Websitevorlagen verwenden. Sie können auch REST-API für dieselben Aktionen verwenden. Die entsprechenden REST-Aufrufe sind zur Referenz in jedem Schritt dargestellt.

Erstellen des Websiteskripts in JSON

Ein Websiteskript ist eine Sammlung von Aktionen, die SharePoint beim Erstellen einer neuen Website ausführt. Aktionen beschreiben Änderungen, die auf die neue Website angewendet werden sollen, z. B. das Erstellen einer neuen Liste oder das Anwenden eines Designs. Die Aktionen werden in einem Skript JSON angegeben; dabei handelt es sich um eine Liste aller anzuwendenden Aktionen. Wenn ein Skript ausgeführt wird, schließt SharePoint jede Aktion in der aufgeführten Reihenfolge ab.

Jede Aktion wird vom Wert „verb“ im JSON-Skript angegeben. Aktionen können auch Unteraktionen aufweisen, die auch „verb“-Werte sind. Im folgenden JSON-Code gibt das Skript an, dass eine neue Liste mit dem Namen Kundenverfolgung erstellt werden sollen; Unteraktionen legen dann die Beschreibung fest und fügen mehrere Felder zum Definieren der Liste hinzu.

Sie müssen die SharePoint Online-Verwaltungsshell herunterladen und installieren. Ist auf Ihrem System bereits eine frühere Version der Shell installiert, müssen Sie diese Version deinstallieren und anschließend die neueste Version installieren.
Sie müssen eine Verbindung zu Ihrem SharePoint-Mandanten einrichten. Eine Anleitung finden Sie unter Herstellen einer Verbindung mit SharePoint Online PowerShell.

Erstellen und weisen Sie den JSON-Code, der das neue Skript beschreibt, einer Variablen zu, wie im folgenden PowerShell-Code dargestellt. Sie können die neueste JSON-Schemadatei anzeigen und auf sie verweisen: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json

 $site_script = '
 {
   "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json",
     "actions": [
       {
         "verb": "createSPList",
         "listName": "Customer Tracking",
         "templateType": 100,
         "subactions": [
           {
             "verb": "setDescription",
             "description": "List of Customers and Orders"
           },
           {
             "verb": "addSPField",
             "fieldType": "Text",
             "displayName": "Customer Name",
             "isRequired": false,
             "addToDefaultView": true
           },
           {
             "verb": "addSPField",
             "fieldType": "Number",
             "displayName": "Requisition Total",
             "addToDefaultView": true,
             "isRequired": true
           },
           {
             "verb": "addSPField",
             "fieldType": "User",
             "displayName": "Contact",
             "addToDefaultView": true,
             "isRequired": true
           },
           {
             "verb": "addSPField",
             "fieldType": "Note",
             "displayName": "Meeting Notes",
             "isRequired": false
           }
         ]
       }
     ]
 }
 '

Das vorherige Skript erstellt eine neue SharePoint-Liste mit dem Namen Kundenverfolgung. Es legt die Beschreibung fest und fügt der Liste vier weitere Felder hinzu. Beachten Sie, dass jedes dieser Felder als eine Aktion betrachtet wird. Websiteskripts sind auf 30 kumulierte Aktionen beschränkt (über ein oder mehrere Skripts, die in einer Websitevorlage aufgerufen werden könnten), wenn sie programmatisch mit dem Befehl Invoke-SPOSiteDesign angewendet werden. Wenn sie über UX oder mithilfe des Befehls Add-SPOSiteDesignTask angewendet werden, liegt der Grenzwert bei 300 kumulierten Aktionen (oder 100.000 Zeichen).

Hinzufügen des Websiteskripts

Jedes Websiteskript muss in SharePoint registriert werden, damit es verfügbar ist. Fügen Sie ein neues Websiteskript mithilfe des Cmdlets Add-SPOSiteScript hinzu. Im folgenden Beispiel wird gezeigt, wie das zuvor beschriebene JSON-Skript hinzugefügt wird.

C:\> Add-SPOSiteScript
 -Title "Create customer tracking list"
 -Content $site_script
 -Description "Creates list for tracking customer contact information"

Nach dem Ausführen des Cmdlets erhalten Sie ein Ergebnis, in dem die Websiteskript-ID des hinzugefügten Skripts aufgeführt wird. Notieren Sie sich diese ID, denn Sie werden sie später benötigen, wenn Sie die Websitevorlage erstellen.

Die REST-API, mit der ein neues Websiteskript hinzugefügt wird, ist CreateSiteScript.

Erstellen der Websitevorlage

Als Nächstes müssen Sie die Websitevorlage erstellen. Die Websitevorlage wird in einer Dropdownliste angezeigt, wenn jemand eine neue Website aus einer der Vorlagen erstellt. Sie kann ein oder mehrere Websiteskripts ausführen, die bereits hinzugefügt wurden.

Führen Sie das folgende Cmdlet aus, um eine neue Websitevorlage hinzuzufügen. Ersetzen Sie <ID> mit der Websiteskript-ID, die Sie beim Hinzufügen des Websiteskripts erhielten.

C:\> Add-SPOSiteDesign
 -Title "Contoso customer tracking"
 -WebTemplate "64"
 -SiteScripts "<ID>"
 -Description "Tracks key customer data in a list"

Das vorherige Cmdlet erstellt eine neue Websitevorlage mit dem Namen „Contoso-Kundenverfolgung“.

Parameter	Wert	Websitevorlagentyp
WebTemplate	64	Vorlage für Teamwebsite
WebTemplate	1	Teamwebsite (mit deaktivierter Gruppenerstellung)
WebTemplate	68	Kommunikationswebsitevorlage
WebTemplate	69	Vorlage für Kanalwebsites

In der JSON-Antwort wird die ID der neuen Websitevorlage angezeigt. Sie können diese in nachfolgenden Cmdlets verwenden, um die Websitevorlage zu aktualisieren oder zu ändern.

Die REST-API, mit der eine neue Websitevorlage hinzugefügt wird, ist CreateSiteDesign.

Verwenden der neuen Websitevorlage

Nachdem Sie ein Websiteskript und eine Websitevorlage hinzugefügt haben, können Sie dieses verwenden, um neue Websites mit der Self-Service Site Creation-Umgebung zu erstellen, oder die Websitevorlage auf eine existierende Website anwenden, indem Sie den Befehl Invoke-SPOSiteDesign in PowerShell verwenden. Wenn Sie Hubwebsites verwenden, können Sie sogar eine Websitevorlage einem Hub zuweisen, sodass sie auf alle zugeordneten Websites angewendet wird.

Erstellen einer neuen Website

Gehen Sie zur Startseite der SharePoint-Website, die Sie für die Entwicklung verwenden.
Wählen Sie Website erstellen aus.
Wählen Sie den Typ der Website aus, die Sie verwenden müssen. SharePoint erstellt eine Teamwebsite mithilfe der Microsoft Teams-Vorlage für die Zusammenarbeit oder eine Kommunikationswebsite mithilfe der Microsoft-Themenvorlage, es sei denn, eine andere benutzerdefinierte Websitevorlage ist als Standard festgelegt.
Wählen Sie Weiter aus.
Geben Sie unter Websitename einen Namen für die neue Website Kundenauftragsverfolgung ein.
Wählen Sie Fertig stellen aus.
Wechseln Sie als Nächstes zu Einstellungen, und wählen Sie Anwenden einer Websitevorlage aus.
Wählen Sie die soeben erstellte Websitevorlage aus.
Nach der Anwendung wird die neue Vorlage unter der Registerkarte in der Vorlagenanzeige mit dem Titel Von Ihrer Organisation angezeigt.
Wenn die neue Vorlage angewendet wurde, werden Sie die benutzerdefinierte Liste auf der Seite sehen.

Auf eine vorhandene Website anwenden

Sie können auch eine veröffentlichte Websitevorlage auf vorhandene Websites anwenden. Auf der Startseite der Website können Websitebesitzer zu Einstellungen und dann Anwenden einer Websitevorlage navigieren, um die von Ihrer Organisation und Microsoft bereitgestellten Vorlagen zu durchsuchen und anzuwenden.

Sie können Vorlagen in einem Massenvorgang auf vorhandene Websitesammlungen anwenden, indem Sie das Cmdlet Invoke-SPOSiteDesign verwenden.

Veröffentlichte Websitevorlagen können angewendet werden auf:

Mit einer Gruppe verbundene Teamwebsites
Teamwebsites, die nicht mit einer Microsoft 365-Gruppe verbunden sind
Kommunikationswebsites
Kanalwebsites
Klassische Teamwebsites
Klassische Veröffentlichungswebsites

Die REST-API, mit der eine Websitevorlage auf eine vorhandene Websitesammlung angewendet wird, ist ApplySiteDesign.

Zuordnen zu einer Hubwebsite

Wenden Sie eine veröffentlichte Websitevorlage auf eine neue oder vorhandene Hubwebsite an. Dadurch erben alle zugeordneten Websites die Vorlage und das Design der Hubwebsite. Navigieren Sie zur Startseite des Hubs, wechseln Sie zu Einstellungen und Anwenden einer Websitevorlage. Erfahren Sie mehr über das Aktivieren von Websitezuordnungen für Ihre Hubwebsite.

Sie können auch das Set-SPOHubSite-Cmdlet verwenden. Lesen Sie den Artikel PowerShell-Cmdlets für SharePoint-Hubwebsites.

Hinweis

Kanalwebsites werden automatisch am Beitritt zu einer Hubwebsite gehindert.

Freigeben über