Fournisseur d’ID de document dans le modèle de complément SharePoint

  • Article

L’approche que vous utilisez pour définir des identificateurs uniques pour les documents dans SharePoint est différente dans le nouveau modèle de complément SharePoint et dans le code de confiance totale. Dans un scénario standard de code de confiance totale (FTC) / solution de batterie de serveurs, les gestionnaires d’événements d’élément de liste exécutant le code de modèle objet côté serveur SharePoint ont été utilisés pour définir des identificateurs uniques pour les documents et ils ont été déployés via des solutions SharePoint.

Dans un scénario de modèle de complément SharePoint, le modèle objet côté client SharePoint (CSOM) et/ou l’API REST SharePoint sont utilisés pour définir des identificateurs uniques pour les documents.

Conseils généraux

En règle générale, nous aimerions fournir les instructions générales suivantes pour définir des identificateurs uniques pour les documents dans le nouveau modèle de complément SharePoint.

  • Utilisez le modèle objet côté client SharePoint (CSOM) et/ou les API REST SharePoint pour définir des identificateurs uniques pour les documents.
  • Actuellement, il n’existe aucun mécanisme prête à l’emploi pris en charge pour associer du code traité à distance afin de remplacer le fournisseur d’ID de document prête à l’emploi. Par conséquent, cette fonctionnalité n’est pas prise en charge en mode natif pour être modifiée avec des API distantes.
  • Toutefois, comme dans de nombreux cas avec le modèle de complément, d’autres itinéraires sont explorés.

Comment les identificateurs uniques sont-ils définis sur les documents ?

Essentiellement, définir un identificateur unique pour un document signifie définir la valeur d’une colonne dans une bibliothèque de listes/documents SharePoint.

Les API SharePoint (CSOM) et/ou REST peuvent être utilisées pour définir des valeurs de colonne et, par conséquent, elles peuvent être utilisées pour définir des identificateurs uniques pour les documents. Consultez les articles suivants pour en savoir plus sur ces API et sur la façon de définir des valeurs de colonne avec elles.

Options permettant de définir des identificateurs uniques pour les documents

Vous disposez de plusieurs options pour définir des identificateurs uniques pour les documents stockés dans SharePoint.

  • Utiliser des récepteurs d’événements distants
  • Utiliser un processus en arrière-plan

Utiliser des récepteurs d’événements distants

Dans ce modèle, les récepteurs d’événements distants se déclenchent lorsque de nouveaux documents sont chargés dans des bibliothèques SharePoint. Les récepteurs d’événements distants effectuent des appels CSOM ou API REST pour définir des identificateurs uniques pour les documents.

  • Ce modèle s’exécute immédiatement après le chargement d’un document dans SharePoint.
    • Tant que le code du service associé au récepteur d’événements distants s’exécute en temps voulu, les ID de document sont définis rapidement après le chargement d’un nouveau document sur SharePoint.
  • Ce modèle fonctionne uniquement sur les nouveaux documents chargés sur SharePoint. Il ne définit pas d’identificateurs uniques pour les documents déjà stockés dans SharePoint.
  • Les opérations de chargement en bloc déclenchent plusieurs appels au service associé au récepteur d’événements distants. Planifiez en conséquence pour vous assurer que les opérations de chargement en bloc ne surchargeront pas le service.
  • Il n’existe aucun moyen pour un récepteur d’événements distants d’avertir SharePoint si la définition d’un ID de document unique a échoué.

Quand est-elle adaptée ?

Lorsque vous devez définir des identificateurs uniques pour les documents rapidement après leur chargement sur SharePoint et que vous ne vous attendez pas à des opérations de chargement en bloc.

Prise en main

L’article Récepteurs d’événements et récepteurs d’événements de liste (recette de complément SharePoint) décrit comment implémenter des récepteurs d’événements dans le modèle de complément et fournit des liens vers plusieurs exemples et articles.

Utiliser un processus en arrière-plan

Dans ce modèle, un processus en arrière-plan vérifie les documents dans SharePoint pour déterminer s’ils ont un identificateur unique défini. Si aucun identificateur unique n’est trouvé pour un document, le processus en arrière-plan définit un identificateur unique pour le document. Le processus en arrière-plan effectue des appels CSOM ou API REST pour définir des identificateurs uniques pour les documents.

  • Ce modèle s’exécute selon la planification que vous définissez pour lui.
  • Ce modèle fonctionne sur tous les documents que le code est écrit pour analyser.
  • Nous vous suggérons d’utiliser le service de recherche SharePoint pour exécuter des requêtes qui incluent des filtres afin de renvoyer une liste de documents qui n’ont pas d’identificateurs uniques définis sur eux.
    • Ce modèle est le plus rapide et est mieux mis à l’échelle que tout autre modèle de requête.
    • Ce modèle élimine la logique de requête personnalisée du service en arrière-plan.
    • Ce modèle nécessite une configuration de recherche.
    • Pour en savoir plus sur la configuration de la recherche, consultez Configuration de la recherche (recette de complément SharePoint).
  • Il n’est pas recommandé d’interroger et de retourner de manière récursive les métadonnées relatives à tous les documents dans un environnement SharePoint en effectuant une boucle dans des objets web et de liste.
    • Ce modèle est le plus lent et est mis à l’échelle moins bien que tout autre modèle de requête.
    • Vous pouvez rencontrer des limites de limitation d’API lors de l’utilisation de ce modèle.
    • Ce modèle inclut une logique de requête personnalisée dans le service en arrière-plan.
    • Ce modèle peut être implémenté avec un travail web Azure.

Quand est-elle adaptée ?

  • Lorsque vous devez définir des identificateurs uniques pour les documents et les récepteurs d’événements distants, vous ne disposez pas d’une option.
  • Quand vous prévoyez de charger des documents en bloc.
  • Lorsque vous devez vous assurer que les ID de document uniques sont définis sur les documents.
    • Il n’existe aucun moyen pour un récepteur d’événements d’avertir SharePoint si la définition d’un ID de document unique a échoué.
  • Lorsque vous devez traiter des documents déjà stockés dans SharePoint.

Prise en main

L’article Travaux du minuteur à distance (recette de complément SharePoint) décrit comment implémenter des travaux de minuteur à distance dans le modèle de complément et fournit des liens vers plusieurs exemples et articles.

Exemples PnP

S’applique à

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