Partager via

Aspects importants du contexte de développement et de l’architecture des compléments SharePoint

  • Article

Cet article complète les informations de l’article Compléments SharePoint.

Le modèle de complément SharePoint propose les solutions d’hébergement suivantes pour les composants d’un complément SharePoint :

  • Hébergé par un fournisseur : Compléments qui incluent au moins un composant distant et peuvent également inclure des composants SharePoint. Les composants non-SharePoint sont déployés par votre logique sur votre compte matériel ou cloud, ou déployés sur le compte matériel ou cloud du client à l’aide des programmes d’installation et des instructions que vous fournissez.

  • Hébergé par SharePoint : compléments qui incluent uniquement les composants et la logique SharePoint qui s’exécute sur le client.

Pour obtenir des informations plus détaillées sur les options d’hébergement et des instructions pour faire votre choix, consultez la section Choisir les modèles de développement et d’hébergement d’un complément SharePoint.

Sites web de complément, sites web hôtes, fonctionnalités et composants SharePoint dans des compléments

Le site web sur lequel le complément SharePoint est installé est nommé site web hôte. Cependant, les composants importants du complément SharePoint, qu’ils soient des composants SharePoint ou externes, ne sont pas déployés sur le site web hôte. Les composants externes sont déployés sur les serveurs externes ou sur des comptes sur le cloud. Les composants SharePoint sont déployés sur un site web spécial qui dispose de son propre domaine. Ce site est appelé site web de complément.

Seul un ensemble limité d’éléments de l’interface utilisateur donnant aux utilisateurs accès aux autres composants du complément sont déployés sur le site web hôte. Ces composants de l’interface utilisateur sur le site web hôte sont déployés en tant que composants d’une fonctionnalité du site web hôte, une fonctionnalité flexible dans le package de complément et non dans un fichier .wsp. Les composants déployés sur le site web de complément sont toujours dans les fonctionnalités dans un fichier .wsp. Les deux types de fonctionnalités doivent avoir une étendue Web. Aucune autre étendue n’est possible pour les fonctionnalités dans les compléments SharePoint.

En règle générale, tout composant SharePoint qui ne comprend pas de code personnalisé fonctionnant sur les serveurs SharePoint peut être inclus dans un complément SharePoint (et être déployé sur le site web de complément). Cependant, il existe des exceptions et des nuances concernant la manière et l’emplacement de déploiement des composants. Pour plus d’informations sur ces nuances et sur les sites web hôtes, les sites web de complément isolés et les fonctionnalités des compléments, consultez la section Héberger des sites web, des sites web de complément et des composants SharePoint dans SharePoint.

Accéder au complément à partir de l’interface utilisateur

Lorsqu’un complément SharePoint est installé sur un site web, le complément est répertorié dans la page Contenu du site web hôte. Les utilisateurs peuvent démarrer le complément à partir de cette page. Ouvert de cette manière, le complément fonctionne en mode plein écran.

Une autre manière d’exposer un complément SharePoint est par l’intermédiaire d’un composant de complément, un type de composant WebPart représenté par la classe ClientWebPart. Ce type de composant WebPart est essentiellement un wrapper d’IFrame qui héberge une page du complément. Dans le cas le plus simple, la seule propriété importante du composant WebPart est une URL qui pointe vers la page.

Néanmoins, les composants WebPart peuvent disposer de propriétés personnalisées que les utilisateurs peuvent définir dans le composant ToolPart. Ces propriétés pourraient par exemple servir à définir des informations contextuelles, telles que le code postal de l’utilisateur. Pour inclure un tel composant de complément dans votre complément, vous créez une fonctionnalité de site web hôte dans le complément et ajoutez un balisage de composant WebPart déclaratif. Comme tout autre composant WebPart, il apparaît dans l’interface utilisateur SharePoint à partir de laquelle les utilisateurs ajoutent des composants WebPart. Vous pouvez disposer de plusieurs composants de complément déployés avec votre complément si vous avez besoin de davantage de variabilité. Par exemple, un complément météo peut disposer d’un composant de complément indiquant la météo actuelle et d’un second composant de complément indiquant les prévisions météorologiques hebdomadaires. Les deux composants disposent de tailles et de fonctionnalités différentes.

Remarque

Vous pouvez également déployer les composants de complément sur le site web de complément. Pour implémenter cela, le balisage du composant WebPart fait partie d’une fonctionnalité à l’intérieur d’un fichier .wsp dans le package de complément, et non dans la fonctionnalité web hôte.

Nous vous recommandons d’essayer de donner à vos compléments une apparence SharePoint autant que possible, bien que cela ne soit pas obligatoire et parfois pas la meilleure solution. Pour plus d’informations sur les instructions concernant l’expérience utilisateur, consultez la section Conception de l’expérience utilisateur pour les compléments dans SharePoint.

Il existe par exemple un page maître spéciale appelée app.master. Cette page est optimisée pour être utilisée par les pages des compléments. La page app.master fait partie d’une nouvelle définition de site incluse dans SharePoint.

Un autre outil que vous pouvez utiliser pour que vos compléments conservent une convivialité cohérente avec SharePoint est le contrôle de chrome fourni avec SharePoint. Ce contrôle vous permet d’ajouter la zone d’en-tête de navigation SharePoint à vos pages de complément, y compris les pages hébergées de façon externe. Pour plus d’informations sur la conception de l’expérience utilisateur dans les compléments SharePoint, consultez la section Conception de l’expérience utilisateur pour les compléments dans SharePoint. Pour plus d’informations sur le contrôle de chrome, consultez la section Utiliser le contrôle de chrome client dans les compléments SharePoint.

Structure d’un package de complément

Un package de complément SharePoint est un fichier doté d’une extension « .app » et qui est conforme aux conventions Open Packaging Conventions (OPC). (Vous pouvez ouvrir le fichier en ajoutant « .zip » en tant qu’extension supplémentaire du nom de fichier, puis l’ouvrir dans Windows Explorer.) Il contient un manifeste de complément spécifiant certaines propriétés du complément et des instructions pour l’infrastructure d’installation SharePoint. Pour plus d’informations sur le manifeste et le package de complément, reportez-vous à la rubrique Explorer la structure du manifeste de l’application et le package d’un complément SharePoint.

Autorisations, authentification et autorisation de compléments SharePoint

SharePoint présente un nouveau système d’autorisation et de sécurité pour les compléments.

Autorisations pour les compléments

Les compléments SharePoint disposent d’autorisations tout comme les utilisateurs et les groupes. Un complément peut posséder un ensemble d’autorisations différentes de celles dont dispose l’utilisateur qui exécute le complément.

Dans le fichier manifeste du complément, vous devez demander les autorisations qu’un complément doit exécuter. L’utilisateur qui ajoute le complément doit accorder ces requêtes et l’utilisateur ne peut accorder que les autorisations dont il dispose en tant qu’utilisateur. Afin de simplifier la gestion des autorisations pour les utilisateurs et les développeurs, toutes les autorisations demandées doivent être accordées, ou aucune. Le principal de complément dispose toujours du contrôle total sur le site web de complément, ainsi il doit seulement demander des autorisations aux ressources SharePoint dans le site web hôte ou d’autres emplacements hors du site web de complément.

Pour plus d’informations sur les autorisations de complément, voir Autorisations de compléments dans SharePoint.

Autorisation et délégation sélective

Les utilisateurs lançant un complément et les propriétaires de ressources accordant une autorisation de complément pour accéder à une ressource ne doivent pas fournir leurs informations d’identification ou un mot de passe au complément. En revanche, SharePoint permet aux utilisateurs et aux propriétaires de ressources de n’accorder que les autorisations spécifiques demandées par le complément. Cela est rendu possible par l’utilisation par SharePoint du protocole de transaction OAuth 2.0. Pour plus d’informations sur OAuth dans SharePoint, consultez la section Flux OAuth de jeton de contexte pour les compléments SharePoint.

Accès inter-domaines

Un complément SharePoint incluant une application web distante qui utilise JavaScript pour sa logique d’accès aux données peut utiliser une bibliothèque inter-domaines JavaScript pour obtenir l’accès aux données SharePoint dans la location d’installation du complément. Pour plus d’informations, voir Accéder à des données SharePoint à partir de compléments à l’aide de la bibliothèque inter-domaines.

Cycle de vie de complément

Le cycle de vie d’un complément SharePoint inclut la publication, l’installation, la mise à niveau et la désinstallation. Pour plus d’informations sur ces sujets, reportez-vous aux sections Publier des compléments SharePoint, Déploiement et installation de compléments SharePoint : méthodes et options et Processus de mise à jour des compléments SharePoint.

Veuillez noter qu’il existe un mécanisme permettant aux administrateurs locataires d’installer par lot un complément SharePoint sur plusieurs sites web. Pour plus d’informations, consultez la section Locations et étendues de déploiement des compléments SharePoint.

Options de stockage de données dans les compléments SharePoint

Les compléments SharePoint peuvent créer et accéder à n’importe quel type de données, y compris les données structurées, les documents et les fichiers multimédias. Ces données peuvent être stockées dans SharePoint ou à un emplacement externe.

Options de stockage des données structurées

Un complément SharePoint peut utiliser presque tout type de stockage de données structurées, à l’intérieur ou à l’extérieur de SharePoint, ainsi que sur les plateformes Microsoft et non-Microsoft. Voici quelques emplacements dans lesquels vous pouvez stocker des données structurées pour un complément SharePoint :

  • Listes SharePoint dans un site web de complément
  • SQL Azure
  • Sources de données externes connectées à SharePoint avec Microsoft Business Connectivity Services (BCS)
  • Service de nuage non Microsoft
  • Une base de données sur votre propre serveur

Conseil

Vous devrez probablement mettre à niveau votre complément SharePoint à un moment donné. Lorsqu’un complément SharePoint inclut des composants SharePoint sur un site web de complément, le processus de mise à niveau procède à une copie complète du site web de complément. Pour cette raison, la présence de longues listes SharePoint sur le site web de complément allonge le processus de mise à niveau et entraîne une utilisation intensive du processeur sur le serveur de base de données de contenu. Vous devez éviter de placer des « données volumineuses » dans les listes SharePoint sur le site web de complément.

Options de stockage de données non structurées

Les documents, images, vidéos, fichiers audio et autres types de données non structurées produites ou utilisées par un complément SharePoint peuvent être stockés dans ou en dehors de SharePoint. Les bibliothèques de documents sont un bon choix pour des documents et sont consultables par le biais d’une recherche SharePoint. Une bibliothèque d’éléments de site est souvent un choix approprié pour les fichiers multimédias.

Les autres options incluent le stockage d’objets blob dans votre compte Microsoft Azure ou sur vos propres serveurs. Vous pouvez également stocker des fichiers sur certaines plateformes non Microsoft ou sur certains services basés sur le nuage.

Paramètres des compléments et autres options de stockage de métadonnées

Les métadonnées pour un complément SharePoint, telles que les préférences des utilisateurs, les informations d’emplacement et d’autres paramètres, peuvent être stockées à plusieurs endroits. Une liste SharePoint masquée peut parfois être une bonne solution. Vous pouvez également utiliser le conteneur de propriétés du site web du complément. Une autre possibilité, pour un complément hébergé par un fournisseur, consiste à utiliser le stockage de table Microsoft Azure.

Options d’accès sécurisé aux données

Vos options en matière d’accès aux données sécurisées dépendent bien entendu de vos possibilités de stockage. L’accès aux données et la façon de les consulter sont décrits en détails dans plusieurs autres articles. Reportez-vous à la section Accès aux données sécurisé et modèles objets clients pour les compléments SharePoint.

Gestion des compléments

Les administrateurs de collection de sites et les administrateurs locataires peuvent surveiller les compléments et modifier les ressources qui leur sont attribuées. En outre, le personnel microsoft du magasin de compléments peut marquer les compléments et les désactiver.

Pour plus d’informations sur la gestion des compléments, consultez la section Installer et gérer les compléments SharePoint sur TechNet.

Surveillance des compléments

SharePoint propose la surveillance de l’intégrité des compléments et publie ces informations sur l’interface utilisateur à destination des propriétaires de sites web, des administrateurs clients et des administrateurs de batterie. La plupart de la documentation du système de surveillance se trouve sur TechNet. Par exemple Surveiller les compléments SharePoint. Cette section ne représente qu’une brève introduction afin d’expliquer comment les compléments que vous vendez sont surveillés.

Certains types de données sont signalés par application et d’autres types sont signalés par instance d’application. Les éléments principaux signalés par la structure de surveillance sont les suivants :

  • Utilisation du complément, par exemple, le nombre d'installations (création d'une nouvelle instance).
  • Consommation des ressources du serveur de chaque instance de complément.
  • Installation, mise à niveau et erreurs d'exécution de chaque instance de complément.
  • Un indicateur d’intégrité global pour chaque instance de complément de couleur verte, jaune et rouge.

Si le complément comprend des composants Site web Azure, la structure de surveillance interroge également Microsoft Azure toutes les heures pour obtenir des données d’erreurs et signale les erreurs critiques et les données de quotas de stockage dans l’interface utilisateur SharePoint. Les erreurs Base de données SQL Microsoft Azure ne sont pas signalées.

Les informations fournies par la structure de surveillance permettent aux administrateurs de déterminer si leur budget d'achat de compléments est dépensé de manière judicieuse, s'ils doivent déployer davantage de ressources sur les compléments et s'ils doivent désactiver un complément qui ne fonctionne pas correctement.

Enregistrement des dépendances de compléments

Si votre complément SharePoint dépend d’une fonctionnalité SharePoint qui n’est pas disponible et ne peut pas être mise à disposition sur le site web du complément, il ne fonctionnera pas correctement et vos clients se plaindront. Vous pouvez veiller à ce que votre complément ne soit pas installé lorsque les services et fonctionnalités requis ne sont pas disponibles en inscrivant les dépendances du complément dans le manifeste du complément. L’infrastructure d’installation des compléments SharePoint vérifie ces prérequis et bloque l’installation de votre complément si l’un d’eux n’est pas disponible.

Pour des services (par exemple, Excel, Access ou Visio Services), l’infrastructure vérifiera que le service est installé et fonctionne sous licence.

Pour les fonctionnalités, par exemple une liste des tâches, l’infrastructure vérifie que la fonctionnalité est déployée et :

  • activé dans l’étendue Batterie de serveurs, WebApplication ou Site (collection de sites)

ou

  • activable avec l’étendue Web dans le site web de complément qui est créé au moment de l’installation du complément.

Remarque

L’infrastructure d’installation du complément activera automatiquement ces fonctionnalités dans le site web de complément dès sa création.

Les sections qui suivent précisent les détails nécessaires pour enregistrer la configuration requise.

Inscrire implicitement les dépendances avec des demandes d’autorisation

Lorsque votre complément a besoin d’accéder à des composants SharePoint en dehors du site web de complément, il doit demander l’autorisation d’accès à ces ressources dans la section AppPermissionRequests du manifeste du complément. Ces demandes d’autorisation font également office d’enregistrements préalables puisque SharePoint déduira à partir de ces autorisations que votre complément exige que certaines fonctionnalités SharePoint soient disponibles. Dans de nombreux cas, SharePoint peut déduire que toutes les fonctionnalités indispensables à votre complément, ainsi que les sections restantes de cette rubrique, ne sont pas nécessaires. Néanmoins, des enregistrements de dépendances redondants ne sont pas inutiles.

Inscrire explicitement les dépendances avec AppPrerequisites

Lorsque votre complément affiche une dépendance qui n’est pas implicitement définie par ses demandes d’autorisation, vous devez enregistrer chaque dépendance avec un élément AppPrerequisite dans le manifeste de complément. Il y a trois attributs dans cet élément ; Type, ID et MinimumVersion. (facultatif).

Il existe trois valeurs potentiellement requises pour l’attribut Type : Feature, Capablility et AutoProvisioning. Une valeur « Feature » requise est simplement une fonctionnalité SharePoint que vous devez déployer et activer sur le site web de complément ou une étendue plus large qui inclut le site web de complément. Une valeur « Capability » (capacité) est un ensemble de fonctionnalités et de services qui doivent être disponibles sur le site web de complément. (La valeur AutoProvisioning est abordée dans la section suivante.)

L’attribut facultatif MinimumVersion spécifie la version la plus faible de la fonctionnalité ou de la capacité qu’exige votre complément. Les valeurs d’attribut sont de la forme n.n.n.n.n; par exemple 15.0.0.0.

L’attribut ID précise quelle fonctionnalité ou capacité est requise. Si l’attribut Type a la valeur Feature, l’attribut ID correspond au GUID entre crochets et séparé par des tirets de la fonctionnalité (par exemple, {151D22D9-95A8-4904-A0A3-22E4DB85D1E0}). Si l’attribut Type a la valeur Capability, l’attribut ID désigne le GUID de la capacité. Les capacités sont répertoriées ci-dessous. Pour retrouver le GUID d’une capacité, reportez-vous à l’élément AppPrerequisite (AppPrerequisiteCollection complexType) (manifeste de complément SharePoint).

  • Access Services 2010
  • Services d'accès
  • Service web de métadonnées gérées
  • Services PowerPoint
  • Services Banque d'informations sécurisés
  • Service de traduction automatique
  • Service de profil utilisateur
  • Service Graphiques Visio
  • Service Gestion du travail
  • Duet
  • Flux de travail
  • Recherche
  • EDU

Voici un exemple de balisage brut AppPrerequisites qui enregistre la capacité Flux de travail. Si vous utilisez Visual Studio, vous modifiez le manifeste du complément dans un outil de concepteur.

<AppPrerequisites>
  <AppPrerequisite Type="Capability" ID="{CDD8F991-B459-4512-8048-03D5A03FF27E}" MinimumVersion="15.0.0.0" />
</ AppPrerequisites>

Dans cette section

Voir aussi