Mise à jour des compléments SharePoint

  • Article

Vous pouvez mettre à jour votre complément SharePoint en utilisant le support de mise à jour intégré à SharePoint. Dans les 24 heures suivant le téléchargement d’une version mise à jour du complément dans le catalogue de compléments de l’organisation ou l’acceptation du complément dans l’Office Store, une notification indiquant qu’une mise à jour est disponible apparaît à côté du complément sur la page Contenu du site de chaque site web où il est installé. Comme vous pouvez le voir sur la figure 1, un lien est accessible pour que les utilisateurs installent immédiatement la mise à jour.

Figure 1. Processus de mise à jour d’un complément SharePoint

Étapes de l’interface utilisateur pour la mise à jour d’une application

Vous pouvez installer la mise à jour sans avoir au préalable désinstallé la version antérieure. L'infrastructure de la mise à jour teste l'installation et l'annule s'il existe des erreurs.

Importante

Vous ne pouvez pas modifier le type de complément à l’aide du système de mise à jour. Par exemple, vous ne pouvez pas profiter d’une mise à jour pour transformer un complément hébergé par SharePoint en complément hébergé par un fournisseur. Pour changer de type, vous devez migrer d’un ancien complément vers un nouveau complément. Étant donné que le programme de prévisualisation pour les compléments auto-hébergés a été fermé, vous ne pouvez pas mettre à jour un complément auto-hébergé vers un complément hébergé par un fournisseur. Vous devez convertir le complément tel qu’expliqué dans Conversion d’un complément SharePoint auto-hébergé en complément hébergé par un fournisseur.

Conditions requises pour la mise à jour d’un complément SharePoint

Avant de mettre à jour un complément SharePoint, vous avez besoin des éléments suivants :

  • Une installation SharePoint de test configurée pour l’isolation du complément. Consultez la section Configurer un environnement de développement pour les compléments SharePoint dans Office 365 pour obtenir des instructions sur la configuration d’un Site du développeur Office 365.

  • Les outils qui sont utilisés pour la création d’un complément SharePoint sont aussi généralement utilisés pour le mettre à jour. Par exemple, la plupart des développeurs utilisent Visual Studio et les outils de développement Microsoft Office pour Visual Studio pour créer des compléments SharePoint.

Concepts fondamentaux à maîtriser pour mettre à jour un complément SharePoint

Passez en revue les concepts indiqués dans le tableau suivant avant de mettre à jour votre complément.

Titre d’article Description
Choisir les motifs pour le développement et l’hébergement de votre Complément SharePoint Découvrez les différents types de Compléments SharePoint. Le processus de mise à jour diffère en fonction du type.
Processus de mise à jour des compléments pour SharePoint Découvrez le processus de mise à jour des Compléments SharePoint.
Mise à niveau des fonctionnalités Découvrez comment mettre à niveau des fonctionnalités (Kit de développement logiciel SDK SharePoint 2010).
Déploiement et installation de Compléments SharePoint : méthodes et options Découvrez les méthodes de publication, d’installation et de désinstallation d’un Complément SharePoint.
Gérer des événements dans les Compléments SharePoint Découvrez les récepteurs d’événements distants dans SharePoint.

Étapes principales de mise à jour d’un complément

Voici les principales étapes qui peuvent être nécessaires lorsque vous créez une mise à jour pour un complément SharePoint. Chaque étape est décrite en détail dans les sections ou les articles faisant l’objet d’un lien. Toutes les étapes ne sont pas nécessaires dans tous les projets de mise à jour. Ce que vous devez faire dépend des composants déjà présents dans votre complément et des composants que vous ajoutez. Seuls les éléments marqués par ** sont obligatoires.

Meilleures pratiques pour les mises à jour de complément

Les sections suivantes décrivent les pratiques à respecter et les points importants à prendre en compte lorsque vous planifiez une mise à jour.

Déterminer si la mise à jour est réellement nécessaire

Pour un complément SharePoint hébergé par un fournisseur, les améliorations apportées au complément ne nécessitent pas forcément la mise à jour du complément. Si toutes les modifications sont apportées à des composants distants et qu’elles n’ont pas à être reflétées dans les composants SharePoint, vous pouvez modifier les composants distants sans mettre à jour le complément. Tant que les URL et les chaînes de connexion utilisées par les composants SharePoint pour accéder aux composants distants ne changent pas, le complément SharePoint continue de fonctionner.

Par exemple, supposons que vous ajoutiez un bouton à une application web distante qui lit une colonne d’une liste SharePoint que l’application web n’avait pas lue auparavant. Si la colonne existe déjà dans la liste, vous n’avez rien à modifier dans SharePoint. Vous pouvez télécharger la page web révisée, ainsi que le code révisé correspondant ou JavaScript, vers l’application web distante. La nouvelle fonctionnalité est immédiatement disponible pour les utilisateurs lorsqu’ils démarrent le complément SharePoint.

Penser que la mise à jour est facultative pour les utilisateurs

Lorsqu’une nouvelle version de votre complément SharePoint devient disponible dans l’Office Store ou le catalogue de compléments de l’organisation, un message apparaît sur la vignette du complément sur la page Contenu du site et informe les utilisateurs qu’une mise à jour est disponible. Ce message s’affiche en moins de 24 heures. Cependant, rien dans l’infrastructure SharePoint n’oblige les utilisateurs à procéder aux mises à jour. Les modifications que vous apportez aux composants distants ne doivent donc pas « casser » les versions antérieures du complément. En règle générale, mais pas de manière universelle, vous pouvez ajouter des éléments aux composants distants, mais évitez de supprimer, renommer, déplacer ou modifier le schéma, la chaîne de connexion ou l’URL d’un composant existant.

Si un composant distant doit connaître la version de l’instance de complément qui l’appelle, vous pouvez transmettre cette information à partir de SharePoint. Par exemple, vous pouvez ajouter la version du complément en tant que paramètre de requête sur l’URL StartPage du complément.

Créer et déboguer la nouvelle version comme s’il s’agissait d’un nouveau complément

Vous devez séparer le développement et le débogage de la nouvelle version du complément du débogage du balisage et de la logique de la mise à jour. Pour ce faire, désinstallez la version antérieure du complément de votre site SharePoint de test de développement. Enregistrez une copie de sauvegarde du fichier de package de complément pour la version antérieure. Ajoutez et modifiez les composants du complément tel que nécessaire, puis testez-les et déboguez-les par rapport au site de test, comme s’il s’agissait d’un tout nouveau complément créé de A à Z.

Tester la mise à jour avec chaque version antérieure du complément

Lorsque la nouvelle version du complément fonctionne correctement en tant que « nouveau complément », restructurez le code et le balisage afin que le projet soit une mise à jour de l’ancien complément. Par exemple, incrémentez le numéro de version du complément, comme indiqué à la section Étapes principales de mise à jour d’un complément. Pour plus d’informations sur la manière de transformer un projet en mise à jour, consultez les rubriques enfants de cette rubrique.

Lorsque vous êtes prêt à tester votre mise à jour, retirez la nouvelle version du site de test et redéployez la version antérieure de façon à pouvoir tester la logique de mise à jour. Si vous avez fourni plusieurs versions antérieures du complément, installez chaque version antérieure sur un sous-site web distinct de votre site de test. Ensuite, téléchargez la dernière version du complément sur le catalogue de compléments de votre site de test et mettez à jour chaque instance du complément. Assurez-vous que chacune d’entre elles possède le dernier numéro de version du complément et la dernière version de tous les composants. S’il existe un site web de complément dans le complément, vérifiez que les composants de site web de complément ont été déployés conformément à la procédure décrite dans Vérifier le déploiement des composants de site web de complément.

Mettre à jour un complément sans attendre 24 heures

Lorsque vous développez une mise à jour pour un complément sur votre site de test SharePoint, il n’est pas pratique d’attendre 24 heures entre les mises à jour. Vous (et les utilisateurs d’un site SharePoint de production) pouvez mettre à jour un complément immédiatement après son téléchargement sur l’Office Store ou le catalogue de compléments de l’organisation en suivant ces étapes :

Pour mettre à jour un complément immédiatement

  1. Une fois la dernière mise à jour téléchargée sur le catalogue de compléments, ouvrez la page Contenu du site sur le site web où le complément est installé et cliquez sur le bouton ... sur la vignette du complément.

  2. Dans la légende qui s’affiche, choisissez l’onglet À propos de. Sur la page À propos de qui s’affiche, une notification indique qu’une nouvelle version est disponible.

  3. Choisissez le bouton Obtenir. La page Contenu du site se rouvre et une notification sur la vignette du complément indique que le complément est en cours de mise à jour.

La figure 2 illustre ces étapes.

Figure 2. Processus de mise à jour immédiate d’un complément SharePoint

Processus de mise à niveau d’application immédiate

Remarque

Si la fréquence de 24 heures pour l’affichage de la notification de « mise à jour disponible » sur la vignette du complément n’est pas assez élevée pour vous, vous pouvez utiliser la méthode décrite dans Procédure de mise à jour d’un complément SharePoint pour que la notification apparaisse immédiatement.

Mettre à jour la version du complément, les demandes d’autorisation et les conditions requises

Après avoir effectué une copie de sauvegarde du dossier de projet Visual Studio, ouvrez le projet de complément. Ouvrez le manifeste de complément et incrémentez le numéro de version sur l’onglet Général du concepteur de manifeste.

Si la version mise à jour du complément requiert plus (ou moins) d’autorisations pour accéder aux composants du site web hôte, apportez les modifications nécessaires à la section AppPermissionRequests du complément. Dans Visual Studio, utilisez l’onglet Autorisations du concepteur de manifeste.

Lorsqu’un complément est mis à jour, l’utilisateur est toujours invité à accorder des autorisations, que les autorisations aient changé ou non depuis la version précédente. Si la nouvelle version demande moins d’autorisations que la version précédente, les autorisations supplémentaires de la version précédente ne sont pas révoquées. La seule façon de restreindre le complément aux autorisations dont la dernière version a besoin est d’ouvrir la page {SharePointDomain}/_layouts/15/appinv.aspx après la mise à jour du complément, puis d’entrer manuellement le balisage d’autorisation conforme au schéma AppPermissionRequests .

Si la version mise à jour du complément comporte des composants requis qui n’existaient pas dans les versions précédentes (ou ne contient plus les composants requis qui existaient dans les versions précédentes), apportez les modifications nécessaires à la section AppPrerequisites du complément. Dans Visual Studio, utilisez l’onglet Composants requis du concepteur de manifeste.

Étapes suivantes

Continuez avec le point suivant de la section Étapes principales de mise à jour d’un complément ou accédez directement à l’un des articles suivants :

Voir aussi