Déploiement d’extensions SharePoint Framework à l’échelle du client

L’option Déploiement à l’échelle du client pour les extensions SharePoint Framework (SPFx) est prise en charge pour les personnalisateurs d’application et les jeux de commandes d’affichage Liste. Il permet aux responsables de catalogue d’applications client de gérer facilement les extensions activées par défaut sur le client ou basées sur les modèles web/liste utilisés dans les sites.

Lorsque les développeurs créent une nouvelle solution d’extension SharePoint Framework à l’aide de packages Yeoman SharePoint Framework standard, l’automatisation est incluse dans le package de solution afin d’activer l’extension sur le client.

La solution SharePoint Framework devra être configurée pour utiliser le déploiement d’une solution délimitée de locataires pour les solutions SharePoint Framework afin d’activer automatiquement les extensions sur le client à l’aide de la fonctionnalité Déploiement à l’échelle du client. Cela signifie que l’attribut skipFeatureDeployment dans le package-solution.json devra être défini sur true.

Contrôler le déploiement à l’échelle du client à partir de la collection de sites du catalogue d’applications

La collection de sites du catalogue d’applications permet de déployer des compléments SharePoint et des composants SharePoint Framework sur le client. Cette collection de sites est créée par l’administrateur client et utilisée pour gérer les personnalisations mises à la disposition des utilisateurs finaux dans les collections de sites de contenu réelles.

La collection de sites du catalogue d’applications contient la liste des extensions à l’échelle du client, qui peut être utilisée pour gérer les activations d’extensions SharePoint Framework dans le client. Cette liste est accessible à partir de la page Contenu du site du site de catalogue d’applications.

Des extensions SharePoint Framework spécifiques peuvent être activées au niveau client en ajoutant des entrées à la liste des extensions à l’échelle du client. Chaque entrée peut être ciblée vers un modèle web ou un type de liste spécifique, selon les exigences fonctionnelles.

Ces configurations spécifiques de liste sont résolues au moment de l’exécution, lorsque les utilisateurs finaux accèdent aux pages des collections de sites de contenu. Ainsi, les modifications apportées à cette liste sont disponibles pour les sites existants et les nouveaux sites du client.

Les solutions SharePoint Framework peuvent contenir une automatisation pour ajouter automatiquement une entrée à la liste des extensions à l’échelle du client une fois la solution ajoutée.

Description de la liste de déploiement à l’échelle du client

L’ID du composant doit être présent dans le client pour lui ajouter une entrée.

Pour la colonne Modèle web, toutes les définitions de modèles web sont techniquement prises en charge. Le tableau suivant définit les modèles les plus fréquemment utilisés.

Pour la colonne Modèle de liste, tout ID de liste est techniquement pris en charge, mais seul un sous-ensemble de types de liste classique prend en charge les expériences modernes.

Les valeurs d’emplacement prises en charge sont les suivantes. Elles sont spécifiques pour le type de composant.

Automatisation du déploiement à l’échelle du client à partir du package de solution

Le générateur SharePoint Framework ajoute le fichier ./sharepoint/assets/ClientSideInstance.xml aux nouvelles solutions quand le type de composant initial sélectionné est une extension.

ClientSideInstance.xml est pris en compte dans l’activation de la solution au niveau du catalogue d’applications si l’attribut skipFeatureDeployment est défini sur true dans le fichier package-solution.json.

Par défaut, ce fichier contient la structure suivante. L’élément ClientSideComponentInstance demande à SharePoint d’ajouter automatiquement une entrée à la liste de déploiement à l’échelle du client si le package de solution est ajouté au catalogue d’applications.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <ClientSideComponentInstance
      Title="MyAppCust"
      Location="ClientSideExtension.ApplicationCustomizer"
      ComponentId="917a86f2-15c1-403e-bbe1-59c6bd50d1e1"
      Properties="{&quot;testMessage&quot;:&quot;Test message&quot;}">
  </ClientSideComponentInstance>
</Elements>

Si vous avez sélectionné SharePoint Online uniquement (dernière version) comme environnement cible sélectionné lors de la création de la solution SharePoint Framework, le fichierClientSideInstance.xmlest également référencé dans package-solution.json, de sorte qu’il est inclus dans le fichier *.sppkg lorsque vous empaquetez votre solution.

L’élément ClientSideComponentInstance prend en charge les attributs suivants.

La définition XML ci-dessous montre comment les valeurs facultatives peuvent être utilisées dans le cadre de l’inscription.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <ClientSideComponentInstance
      Title="MyAppCust"
      Location="ClientSideExtension.ApplicationCustomizer"
      ComponentId="917a86f2-15c1-403e-bbe1-59c6bd50d1e1"
      Properties="{&quot;testMessage&quot;:&quot;Test message&quot;}"
      ListTemplateId="100"
      WebTemplateId="GROUP#0"
      Sequence="10"
      HostProperties="{&quot;preAllocatedApplicationCustomizerTopHeight&quot;:&quot;50&quot;,&quot;preAllocatedApplicationCustomizerBottomHeight&quot;:&quot;50&quot;}">
  </ClientSideComponentInstance>
</Elements>

Lorsqu’un administrateur ajoute une solution contenant un fichier ClientSideInstance.xml au catalogue d’applications, un message d’avertissement spécifique s’affiche pour s’assurer que la présence de la configuration automatisée est connue.

Une fois la solution déployée, un administrateur peut modifier les paramètres de déploiement à partir de la liste des extensions à l’échelle du client.