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

L’approche que vous prenez pour définir des identificateurs uniques pour les documents dans SharePoint est différente dans le nouveau modèle de SharePoint par rapport au code de confiance totale. Dans un scénario classique de code de confiance totale/solution de batterie de serveurs, les responsables d’événements d’élément de liste exécutant du code de modèle objet côté serveur SharePoint été utilisés pour définir des identificateurs uniques pour les documents et ils ont été déployés via SharePoint Solutions.

Dans un scénario de modèle de 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 voulons fournir les instructions générales suivantes pour définir des identificateurs uniques pour les documents dans le nouveau modèle de SharePoint de document.

  • Utilisez le SharePoint modèle objet côté client (CSOM) et/ou les API REST SharePoint pour définir des identificateurs uniques pour les documents.
  • À l’heure actuelle, il n’existe aucun mécanisme prédécidé pris en charge pour l’association de code à distance pour remplacer le fournisseur d’ID de document prédécident, de sorte que cette fonctionnalité n’est pas prise en charge en natif pour être modifiée avec des API distantes.
  • Toutefois, comme dans de nombreux cas avec le modèle de add-in, d’autres itinéraires sont en cours d’exploration.

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

Pour l’essentiel, la définition d’un identificateur unique pour un document implique la définition de la valeur d’une colonne dans SharePoint liste/bibliothèque de documents.

Les API SharePoint (CSOM) et/ou REST peuvent être utilisées pour définir des valeurs de colonne, et par la suite, 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 comment définir des valeurs de colonne avec elles.

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

Vous avez 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 firent lorsque de nouveaux documents sont téléchargés vers SharePoint bibliothèques. Les récepteurs d’événements distants appellent CSOM ou l’API REST pour définir des identificateurs uniques pour les documents.

  • Ce modèle s’exécute immédiatement après le téléchargement d’un document 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 rapidement définies après le chargement d’un nouveau document sur SharePoint.
  • Ce modèle fonctionne uniquement sur les nouveaux documents téléchargés sur SharePoint, il ne permet pas de définir 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 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 vers SharePoint et que vous ne vous attendez pas à des opérations de chargement en bloc.

Prise en main

Les récepteurs d’événements et récepteurs d’événements de liste (SharePoint Add-in Recipe) expliquent comment implémenter des récepteurs d’événements dans le modèle de add-in et fournissent 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 SharePoint pour déterminer s’ils ont un identificateur unique. 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 REST API pour définir des identificateurs uniques pour les documents.

  • Ce modèle s’exécute en fonction de la planification que vous définissez pour celui-ci.
  • Ce modèle fonctionne sur tous les documents que le code est écrit pour l’analyse.
  • Nous vous suggérons d’utiliser SharePoint service de recherche pour exécuter des requêtes qui incluent des filtres afin de renvoyer une liste de documents qui ne comportent pas d’identificateurs uniques.
    • Ce modèle est plus rapide et s’effectue mieux que n’importe quel 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, voir la configuration de la recherche (SharePoint recette de module de recherche).
  • Il n’est pas recommandé d’interroger et de renvoyer de manière récursive les métadonnées sur tous les documents d’un environnement SharePoint en boucle dans les objets web et de liste.
    • Ce modèle effectue le plus lent et se resserre plus mal 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 une tâche Web Azure.

Quand est-elle adaptée ?

  • Lorsque vous avez besoin de définir des identificateurs uniques pour des documents et des récepteurs d’événements distants, vous ne disposez pas d’une option.
  • Lorsque vous prévoyez de charger des documents en bloc.
  • Lorsque vous devez vous assurer que des ID de document uniques sont définies sur les documents.
    • Il n’existe aucun moyen pour un récepteur d’événements 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

Les travaux du timer à distance (SharePoint Add-in Recipe) expliquent comment implémenter des travaux du timer à distance dans le modèle de module et fournissent 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