Commencer la création de modèles de sites et de scripts de site

  • Article

Vous pouvez créer des modèles de site pour fournir des listes, des thèmes, des dispositions ou des actions personnalisées réutilisables afin que vos utilisateurs puissent créer rapidement de nouveaux sites SharePoint avec les fonctionnalités dont ils ont besoin.

Cet article décrit comment créer un modèle de site simple qui ajoute une liste SharePoint permettant de suivre les commandes des clients. Vous utiliserez le modèle de site pour créer un site SharePoint avec la liste personnalisée. Vous découvrirez comment utiliser des cmdlets SharePoint PowerShell pour créer des scripts de site et des modèles de sites. Vous pouvez également utiliser des API REST pour effectuer les mêmes actions. Les appels REST correspondants sont présentés pour référence à chaque étape.

Créer le script de site dans JSON

Un script de site est un ensemble d’actions que SharePoint exécute lors de la création d’un site. Les actions décrivent les modifications à appliquer au nouveau site, par exemple créer une liste ou appliquer un thème. Les actions sont spécifiées dans un script JSON, qui constitue une liste de toutes les actions à appliquer. Lorsqu’un script s’exécute, SharePoint effectue chaque action dans l’ordre indiqué.

Chaque action est spécifiée par la valeur « verb » dans le script JSON. Actions peuvent également comporter des actions secondaires qui sont aussi des valeurs « verb ». Le script JSON suivant crée une liste nommée Customer Tracking, puis des actions secondaires définissent la description et ajoutent plusieurs champs pour définir la liste.

  1. Téléchargez et installez SharePoint Online Management Shell. Si vous avez déjà installé une version précédente du shell, désinstallez-la puis installez la dernière version.

  2. Suivez les instructions de l’article Connexion à SharePoint Online PowerShell pour vous connecter à votre client SharePoint.

  3. Créez le code JSON qui décrit le nouveau script et affectez-le à une variable, comme indiqué dans le code PowerShell suivant. Vous pouvez afficher et référencer le dernier fichier de schéma JSON : 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
           }
         ]
       }
     ]
 }
 '

Le script précédent crée une liste SharePoint nommée Customer Tracking. Il définit la description et ajoute quatre champs à la liste. Notez que chacun de ces éléments est considéré comme une action. Les scripts de site sont limités à 30 actions cumulatives (sur un ou plusieurs scripts qui peuvent être appelés dans un modèle de site) s’ils sont appliqués par programme à l’aide de la commande Invoke-SPOSiteDesign. S’ils sont appliqués par l’expérience utilisateur ou à l’aide de la commande Add-SPOSiteDesignTask, la limite est de 300 actions cumulées (ou 100 000 caractères).

Ajouter le script de site

Chaque script de site doit être inscrit dans SharePoint afin d’y être disponible. Ajoutez un nouveau script de site à l’aide de la cmdlet Add-SPOSiteScript. L’exemple suivant montre comment ajouter le script JSON décrit plus haut.

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

Après avoir exécuté la cmdlet, vous obtenez un résultat qui indique l’ID du script de site ajouté. Notez cet ID, car vous en aurez besoin ultérieurement lors de la création de le modèle de site.

L’API REST CreateSiteScript permet d’ajouter un nouveau script de site.

Créez un modèle de site

Vous devez ensuite créer le modèle de site. Le modèle de site apparaît dans une liste déroulante lorsqu’un utilisateur crée un site à partir de l’un des modèles. Il peut exécuter un ou plusieurs scripts de site qui ont déjà été ajoutés.

  • Exécutez la cmdlet suivant pour ajouter un nouveau modèle de site. Remplacez <ID> par l’ID de script de site que vous avez noté lors de l’ajout du script de site.
C:\> Add-SPOSiteDesign
 -Title "Contoso customer tracking"
 -WebTemplate "64"
 -SiteScripts "<ID>"
 -Description "Tracks key customer data in a list"

La précédente cmdlet crée un nouveau modèle de site nommé Suivi client Contoso.

Paramètre Valeur Type de modèle de site
WebTemplate 64 Modèle de site d’équipe
WebTemplate 1 Site d’équipe (avec la création de groupe désactivée)
WebTemplate 68 Modèle de site de communication
WebTemplate 69 Modèle de site de canal

La réponse JSON affiche l’ID du nouveau modèle de site. Vous pouvez l’utiliser dans des cmdlets ultérieures pour mettre à jour ou modifier le modèle de site.

L’API REST pour ajouter un nouveau modèle de site est CreateSiteDesign.

Utiliser le nouveau modèle de site

Maintenant que vous avez ajouté un script de site et un modèle de site, vous pouvez l’utiliser pour créer des sites via l’expérience de création de sites libre-service ou appliquer le modèle de site à un site existant à l’aide de la commande Invoke-SPOSiteDesign dans PowerShell. Si vous utilisez des sites hub, vous pouvez joindre un modèle de site à un hub afin qu’il soit appliqué à tous les sites associés.

Création de sites

  1. Accédez à la page d’accueil du site SharePoint que vous utilisez pour le développement.
  2. Sélectionnez Créer un site.
  3. Choisissez le type de site que vous devez utiliser. SharePoint va créer un site d’équipe à l’aide du modèle de collaboration Microsoft Team ou d’un site de communication à l’aide du modèle Microsoft Rubrique, sauf si un autre modèle de site personnalisé est définie comme modèle par défaut.
  4. Cliquez sur Suivant.
  5. Sous le Nom du site, entrez un nom pour le nouveau site de Suivi de commande client.
  6. Cliquez sur Terminer.
  7. Ensuite, accédez à Paramètres, puis sélectionnez Appliquer un modèle de site.
  8. Sélectionnez le modèle de site que vous venez de créer.
  9. Une fois appliqué, votre nouveau modèle s’affiche sous l’onglet dans la visionneuse de modèles intitulée De votre organisation.
  10. Une fois le nouveau modèle appliqué, vous verrez la liste personnalisée sur la page.

Application à une collection de sites existante

Vous pouvez également appliquer des modèles de site publiés à des sites existants. Sur la page d’accueil du site, les propriétaires de site peuvent accéder à Paramètres,, puis Appliquer un modèle de site pour parcourir et appliquer les modèles fournis par votre organisation et Microsoft.

Vous pouvez appliquer des modèles à des collections de sites existantes en bloc à l’aide de la cmdlet Invoke-SPOSiteDesign.

Les modèles de site publiés peuvent être appliqués à :

  1. Sites d’équipe connectés à un groupe
  2. Sites d'équipe non connectés à un groupe Microsoft 365
  3. Sites de communication
  4. Sites de canal
  5. Sites d’équipe classiques
  6. Sites de publication classiques

L’API REST pour appliquer un modèle de site à une collection de sites existante est ApplySiteDesign.

Association avec un site hub

Appliquer un modèle de site publié à un site hub nouveau ou existant. Ensuite, tous les sites associés héritent du modèle de site hub et du thème. Accédez à la page d’accueil du hub et accédez à Paramètres, puis Appliquer un modèle de site. En savoir plus sur la façon d’activer les associations de sites pour votre site hub.

Vous pouvez également utiliser la cmdlet Set-SPOHubSite. Consultez l’article Applets de commande PowerShell pour des sites hub SharePoint.

Remarque

Les sites de canal ne peuvent pas rejoindre automatiquement un site hub.

Voir aussi