Options de déploiement des solutions SharePoint Framework pour Microsoft Teams

Les développeurs ont plusieurs options lorsqu'ils déploient des solutions SharePoint Framework (SPFx) à utiliser dans Microsoft Teams. Cet article explique les options prises en charge dans SharePoint Online.

SharePoint Online prend en charge deux options pour déployer des solutions SPFx dans le app stores de Microsoft Teams :

1. Créez automatiquement le manifeste et le paquet de l'application Microsoft Teams
2. Utiliser le package de manifeste & d’application Microsoft Teams fourni par les développeurs

Créez automatiquement le manifeste et le paquet de l'application Microsoft Teams.

Cette fonctionnalité est idéale lorsque vous disposez d'une mise en œuvre simple à exposer automatiquement dans Microsoft Teams.

Dans ce scénario, lorsqu'une solution SPFx est téléchargée dans le catalogue d'applications du locataire SharePoint Online, si la solution contient des composants pour Microsoft Teams, le bouton Synchroniser avec Teams du ruban est activé.

Ce bouton va lancer le processus suivant dans SharePoint Online :

1. SharePoint créera dynamiquement le fichier manifeste de l'application Microsoft Teams.
2. SharePoint créera dynamiquement le paquet d'applications Microsoft Teams.
3. SharePoint déploiera le paquet d'applications Microsoft Teams généré dans l'app store Microsoft Teams du locataire.

Lorsque SharePoint crée le manifeste de l'application, il utilise les valeurs de la solution SPFx pour générer certains noms. Le tableau suivant répertorie les propriétés du fichier manifeste de l'application Microsoft Teams et les valeurs qui leur sont attribuées.

Si une solution SPFx contient plusieurs composants Web destinés à être utilisés dans Microsoft Teams, SharePoint Online répétera le processus ci-dessus pour chacun d'entre eux.

Package de manifeste & d’application Microsoft Teams fourni par les développeurs

Lorsque vous avez besoin de plus de contrôle sur le manifeste ou le paquet d'applications Microsoft Teams, vous pouvez créer votre propre paquet. Dans ce cas, lorsqu’un administrateur sélectionne le bouton Synchroniser avec Teams , SharePoint Online recherche le fichier suivant dans le fichier *.sppkg : ./teams/TeamsSPFxApp.zip.

Si ce fichier est présent, SharePoint Online le déploiera dans l'app stores Microsoft Teams du locataire au lieu de le créer dynamiquement. Cette option offre aux développeurs un contrôle total sur le package d’application manifeste & de l’application Microsoft Teams.

Cette option est idéale pour les scénarios suivants :

• Les développeurs veulent avoir un contrôle total sur le contenu du manifeste de l'application Microsoft Teams.
• Scénarios complexes de Microsoft Teams, comme la spécification de bots, d'applications de réunion, etc.
• Spécifiez l’ID et la description du nom & de l’application Microsoft Teams lorsque la solution SPFx contient plusieurs composants. Par exemple, si une solution SPFx contient plusieurs composants WebPart qui peuvent être utilisés comme onglets dans Microsoft Teams, la génération automatique du manifeste sélectionne l’un des deux composants à utiliser comme ID d’application Microsoft Teams, description du nom & .

Pour utiliser votre propre package d’application manifeste & d’application Microsoft Teams au lieu de laisser SharePoint Online le créer dynamiquement, procédez comme suit :

1. Créez un manifeste d'application Microsoft Teams conformément à la documentation de Microsoft Teams :

   • Microsoft Teams : Créez un pack d'applications pour votre application Microsoft Teams.
   • Microsoft Teams : Schéma de manifeste pour Microsoft Teams

   Importante

   dans le manifeste de l’application Teams, veillez à ajouter l’entrée suivante :

   "webApplicationInfo": {
   "resource": "https://{teamSiteDomain}",
   "id": "00000003-0000-0ff1-ce00-000000000000"
   }
   

   Cela est nécessaire pour s’assurer de la réussite de tout appel d’API dans le composant réussira à partir de clients riches Microsoft Teams. teamSiteDomain sera le même client que celui utilisé par le client Teams. Cela ne fonctionne pas entre les inter-clients/inter-domaines et vous ne pouvez donc pas coder en dur un autre domaine.

2. Créez le paquet d'applications Microsoft Teams nommé TeamsSPFxApp.zip en compressant le contenu du dossier ./teams.

   Importante

   Ne compressez pas le dossier, mais le contenu du dossier. Si vous compressez le dossier, un sous-dossier de niveau supérieur sera ajouté au fichier ZIP résultant, ce qui n'est pas un paquet d'applications valide dans Microsoft Teams.

3. Enregistrez le fichier TeamsSPFxApp.zip dans le dossier /teams de la solution SPFx.

4. Créez le paquet SPFx de la même manière que vous le feriez avec une solution SPFx ordinaire, en utilisant gulp package-solution . Il inclut le package d’application Microsoft Teams personnalisé dans * .sppkg.

Référencer dynamiquement les URL des sites SharePoint sous–jacents

Le manifeste de l’application Microsoft Teams doit pointer vers l’emplacement d’hébergement déployé des composants SPFx. Toutefois, ces URL ne sont pas connues au moment de la création du manifeste de l'application Microsoft Teams ou du paquet d'applications.

Par conséquent, lorsque vous spécifiez le paquetage d'applications dans cette option de déploiement, vous devez utiliser les chaînes suivantes qui seront remplacées au moment de l'exécution par Microsoft Teams :

• {teamSiteDomain}l'URL du locataire SharePoint Online où la solution SPFx est déployée et installée.
• {teamSitePath}: le chemin d'accès au site SharePoint où les composants SPFx ont été installés
• {locale}: la locale actuelle du client Microsoft Teams

Lorsque vous utilisez un composant Web dans une solution Microsoft Teams personnalisée, vous pouvez utiliser ces chaînes pour définir l'URL de la page qui chargera le composant Web. Par exemple, utilisez le tableau suivant comme guide pour créer l'URL des composants Web utilisés dans les applications Microsoft Teams :