Association de fonctions dans le modèle de complément SharePoint

  • Article

L’approche que vous utilisez pour exécuter du code et déployer des artefacts lorsqu’un site SharePoint est mis en service est différente dans le nouveau modèle de complément SharePoint que dans le code de confiance totale. Dans un scénario standard de code de confiance totale (FTC) / solution de batterie de serveurs, les définitions de site prêtes à l’emploi ont été modifiées avec des fonctionnalités agrafées. Les fonctionnalités ont été utilisées pour empaqueter et déployer des artefacts, des configurations et des ressources de personnalisation associées à un site SharePoint, et les fonctionnalités ont été agrafées à la définition de site. Ensuite, les fonctionnalités agrafées ont été automatiquement installées et activées lors de l’approvisionnement du site.

Dans un scénario de modèle de complément SharePoint, vous pouvez agrafer des fonctionnalités, des compléments d’agrafage ou utiliser le modèle objet côté client SharePoint (CSOM) pour créer et configurer des collections de sites et des sous-sites, puis y déployer des artefacts, des configurations et des ressources de personnalisation. Ce modèle est souvent appelé lemotif mise en service à distance.

Conseils importants

En règle générale, nous aimerions fournir les instructions générales suivantes pour créer et configurer des collections de sites et des sous-sites, puis y déployer des artefacts, des configurations et des ressources de personnalisation.

  • La seule façon d’utiliser l’agrafage de fonctionnalités est lorsque vous agrafez des fonctionnalités à des collections de sites et que vous utilisez des solutions de bac à sable pour déployer les définitions de site et les fonctionnalités agrafées.
  • Vous pouvez utiliser le modèle d’agrafage de complément avec des compléments déployés par le locataire pour implémenter des fonctionnalités similaires à l’agrafage de fonctionnalités.
  • Vous pouvez utiliser le modèle d’approvisionnement à distance pour implémenter des fonctionnalités similaires à l’agrafage de fonctionnalités en activant des fonctionnalités supplémentaires par-dessus la définition de site prête à l’emploi via des API distantes.

Options permettant de créer et de configurer des collections de sites et des sous-sites, puis de déployer des artefacts, des configurations et des ressources de personnalisation sur celles-ci

Vous avez plusieurs options pour créer et configurer des collections de sites et des sous-sites, puis y déployer des artefacts, des configurations et des ressources de personnalisation.

  • Caractéristiques d’agrafage
  • Compléments d’agrafage
  • Utiliser le modèle d’approvisionnement à distance

Caractéristiques d’agrafage

Dans ce modèle, vous agrafez des fonctionnalités aux définitions de site.

  • Ce modèle n’est disponible qu’au niveau de la collection de sites.
  • Il n’est pas possible d’agrafer des caractéristiques à des sous-sites.
  • Il ne s’agit pas d’une approche optimale ou recommandée, car elle utilise des solutions de bac à sable déconseillées et ne vous configure pas correctement pour les mises à niveau.

Quand est-elle adaptée ?

Lorsque vous migrez du code hérité dans un environnement SharePoint local et que vous n’avez pas le temps de le réécrire correctement.

Mise en route

L’article suivant explique comment agrafer des fonctionnalités à une définition de site.

Compléments d’agrafage

Dans ce modèle, vous déployez des compléments stockés dans le catalogue d’applications sur des collections de sites, des chemins d’accès managés et des modèles de site spécifiques.

  • Pour plus d’informations sur le modèle d’agrafage de complément, consultez déploiement d’applications SharePoint 2013 via l’agrafage d’applications (article de blog MSDN - Richard DiZerega).
  • Étant donné que le complément est envoyé par un administrateur, les propriétaires de site ne peuvent pas supprimer le complément d’un site qui répond aux critères de déploiement. Même un administrateur de collection de sites ne peut pas supprimer le complément.
  • Ce déploiement centralisé partage également les mêmes ressources de complément centralisées (site web de complément et site web distant). Essentiellement, le complément est déployé, mais pas installé dans les sites. Tous les sites tirent parti du site web de complément et du site web distant à partir du instance installés dans le catalogue d’applications.
  • En raison d’un déploiement centralisé, les événements distants tels que « Gérer l’application installée », « Gérer l’application désinstallée » et « Gérer la mise à niveau de l’application » ne se déclenchent qu’une seule fois (lorsque le Add-In est installé dans le catalogue d’applications).
    • Cela peut rendre difficile l’utilisation du modèle d’agrafage de complément pour appliquer automatiquement des modifications aux sites où il est déployé, car ces événements ne se déclenchent pas lorsqu’il est déployé sur des sites.
  • Les composants de complément ne sont pas pris en charge lorsque les compléments sont agrafés à des sites.
  • Ce modèle nécessite des actions manuelles de l’utilisateur pour déployer les compléments.

Utiliser le modèle d’approvisionnement à distance

Dans ce modèle, vous utilisez le modèle objet côté client SharePoint (CSOM) pour créer et configurer des collections de sites et des sous-sites, puis vous y déployez des artefacts, des configurations et des ressources de personnalisation.

  • Ce modèle ne nécessite pas d’empaquetage d’artefacts, de configurations et de ressources de personnalisation dans des fonctionnalités distinctes ou des compléments. Tout peut être empaqueté dans un seul complément.

  • Lorsque vous utilisez ce modèle pour l’approvisionnement de site, vous remplacez généralement la page prête à l’emploi pour créer un site.

  • Pour plus d’informations sur ce modèle, voir approvisionnement de site (recette de complément SharePoint)

  • Si vous souhaitez déployer des compléments sur un site SharePoint, vous pouvez le faire via CSOM. Voici un exemple qui charge un complément Office via un fichier manifeste .app et l’installe dans un site SharePoint.

    //Create a FileStream object to access the Mail Office Add-in .app file
using (FileStream fsSource = new FileStream(System.Web.Hosting.HostingEnvironment.ApplicationPhysicalPath + "Innovation.Management.AFO.app",
  FileMode.Open, FileAccess.Read))
  {
//Return the subweb where you want to install the Add-in
      var subweb = ctx.Web;
      ctx.Load(subweb);
      ctx.ExecuteQuery();

//Load and Install the Add-in on the subweb
      AppInstance appInstance = subweb.LoadAndInstallApp(fsSource);
      ctx.Load(appInstance);
      ctx.ExecuteQuery();
  }

Exemples PnP

S’applique à

  • Office 365 multi-locataire (MT).
  • Office 365 dédiés (D)
  • SharePoint 2013 en local