ID de document et service DocID
Dernière modification : lundi 19 avril 2010
S’applique à : SharePoint Server 2010
Dans cet article
Présentation des URL statiques
Administration des ID de document
Influence des ID de document sur les types de contenu
Attribution des ID de document
Persistance des ID de document
Comportement de la recherche des ID de document
Composant WebPart Zone de recherche d’ID de document
Fournisseurs d’ID de document personnalisés
La fonction ID de document crée des identificateurs qui peuvent être utilisés pour récupérer des éléments indépendamment de leur emplacement actuel. Le service ID de document qui la prend en charge génère et attribue les ID de document. Cette rubrique décrit les ID de document : leur fonctionnement et le fonctionnement du service qui prend en charge leur génération et leur affectation.
En règle générale, les utilisateurs ouvrent les éléments en effectuant une action lancée dans le navigateur Web, telles que la navigation vers une URL, qui indique ensuite à l’application Microsoft Office cliente d’ouvrir le fichier.
Présentation des URL statiques
La fonction URL statique peut être utilisée dans le navigateur Web pour rediriger les utilisateurs vers l’URL réelle d’un élément au moyen d’une redirection HTTP ou d’un appel de transfert serveur. Dans les deux cas, il n’est pas prévu que l’URL statique fonctionne partout où l’URL réelle d’un élément fonctionne. Par exemple, la sélection de l’option Ouvrir dans le menu Fichier des applications clientes ne gère pas les cas où les URL sont redirigées lorsque la méthode Open est appelée.
Administration des ID de document
Vous pouvez activer, administrer et désactiver le service ID de document au niveau de la collection de sites. Les URL statiques fonctionnent correctement au niveau de la collection de sites, car le navigateur Web gère la redirection avant d’appeler l’application Office cliente. Cela signifie que l’application cliente voit uniquement l’URL réelle. Lorsque la fonction ID de document est activée, Microsoft SharePoint Server 2010 ajoute des liens vers la page Paramètres de la collection de sites de l’interface utilisateur Administration centrale et active le service ID de document, qui démarre l’affectation des ID de document dans la collection de sites. Le service ID de document génère des ID de document pour tous les documents dans la collection de sites, mais n’en génère pas pour les autres types d’éléments de liste. Les ID de document sont générés chaque fois qu’un élément est ajouté, et les ID existants sont remplacés par défaut, sauf si l’élément qui a été créé spécifiquement indique à SharePoint Server 2010 de ne pas remplacer son ID existant. Durant les opérations de déplacement, SharePoint Server 2010 conserve l’ID de document. Durant les opérations de copie, SharePoint Server 2010 attribue un nouvel ID de document. Vous pouvez contrôler cela en définissant un opérateur booléen sur la colonne PersistID.
Lorsqu’un ID de document est affecté, il est exposé en tant que métadonnées, et le serveur expose une URL statique afin que l’élément auquel est affecté l’ID de document puisse être reconnu par son ID de document. L’URL statique tente de trouver l’élément en le recherchant.
Les administrateurs de recherche peuvent configurer le service de recherche pour rechercher les ID de document en ajoutant la colonne ID en tant que colonne de recherche gérée et en créant éventuellement une nouvelle étendue de recherche qui est utilisée pour rechercher les ID de document. SharePoint Server 2010 inclut une commande Windows PowerShell 1.0 qui effectue cela automatiquement.
La désactivation de la fonction supprime les liens vers la page Paramètres de la collection de sites, rend la page qui est utilisée pour rechercher les ID de document indisponible, désactive le service ID de document et arrête l’affectation des ID de document. Le serveur ne supprime pas les colonnes qu’il ajoute au niveau du site lorsque la fonction est tout d’abord activée afin que, même après la désactivation, les ID de document existants soient conservés. Une fois que la fonction est désactivée, les utilisateurs qui essaient d’utiliser une URL statique pour rechercher un élément par son ID de document voient un message d’erreur indiquant que « Cette collection de sites n’est pas configurée pour utiliser des ID de document ».
Influence des ID de document sur les types de contenu
Lorsque le service ID de document est activé, SharePoint Server 2010 ajoute de nouvelles colonnes au type de contenu document et au type de contenu ensemble de documents, qui stockent l’ID de document et exposent l’URL statique et les récepteurs d’événements qui affectent des ID de document. Le service comprend également une tâche élément de travail qui assigne des ID à tous les éléments existants dans la collection de sites. Le serveur ajoute les colonnes de site suivantes à la collection de sites dans un groupe appelé « ID de document ». En outre, les colonnes du site sont ajoutées au type de contenu document et au type de contenu ensemble de documents au niveau de la collection de sites.
La colonne DocID stocke l’ID de document affecté à l’élément. Elle possède les attributs suivants :
Nom : ID de document
Description : permet de trouver cet élément indépendamment de son emplacement actuel.
Type : texte
Indexed : false
Sealed : true
ReadOnly : true
CanBeDeleted : false
ShowInNewForm : false
ShowInEditForm : false
Colonne URL statique
La colonne URL statique contient l’URL de l’élément qui est utilisée pour rechercher l’ID de document. Elle possède les attributs suivants :
Nom : URL statique
Description : permet de récupérer cet élément indépendamment de son emplacement actuel.
Type : URL
Indexed : false
Sealed : true
ReadOnly : true
CanBeDeleted : false
ShowInNewForm : false
ShowInEditForm : false
La colonne PersistID est utilisée par la logique d’affectation d’ID de document pour déterminer si un ID de document existant doit être conservé ou réaffecté. Cette colonne est masquée, ne restitue pas l’interface utilisateur et ne peut pas être incluse dans n’importe quel affichage :
Nom : PersistID
Description : permet de spécifier si l’ID actuel d’un élément doit être conservé après la copie de cet élément vers un nouvel emplacement.
Type : booléen
Valeur par défaut : false
Indexed : false
Sealed : true
ReadOnly : true
CanBeDeleted : false
ShowInNewForm : false
ShowInEditForm : false
ShowInViewForms : false
Récepteurs d’événements
En plus de l’ajout des colonnes mentionnées ci-dessus au type de contenu document et au type de contenu ensemble de documents, SharePoint Server 2010 ajoute un récepteur d’événements aux événements SharePoint Foundation 2010 appropriés pour qu’ils s’exécutent chaque fois qu’un document ou qu’un ensemble de documents est téléchargé vers SharePoint Foundation 2010. Le serveur utilise des récepteurs d’événements synchrones comme ItemAdded(SPItemEventProperties)(pas [M:Microsoft.SharePoint.SPItemEventReceiver.ItemAdding(Microsoft.SharePoint.SPItemEventProperties]) pour garantir que les fournisseurs d’ID de document puissent utiliser les métadonnées d’élément lors de l’affectation des ID de document.
Attribution des ID de document
Lorsque des éléments sont ajoutés à une collection de sites, SharePoint Server 2010 leur affecte ou réaffecte des ID de document.
Lorsqu’un nouvel élément est ajouté, SharePoint Server 2010 vérifie tout d’abord si l’élément possède un ID de document. Si l’élément en possède un, le serveur vérifie si l’attribut PreserveID est défini à True ou False, puis le définit à False s’il est actuellement défini à True. Si l’élément ne possède pas déjà un ID de document, le serveur en obtient un pour l’élément auprès du fournisseur spécifié, l’écrit dans les métadonnées et définit l’attribut PreserveID à False.
Notes
La valeur URL statique n’est pas générée car SharePoint Server 2010 la crée dynamiquement lorsque le champ est rendu et affiché.
Persistance des ID de document
Le comportement par défaut pour l’affectation des ID de document part du principe que si un élément existe et possède déjà un ID, SharePoint Server 2010 doit remplacer cet ID par un ID de document. Cela se produit lorsqu’un élément existant dans SharePoint Foundation 2010 est copié : la copie conserve les mêmes métadonnées que l’original, y compris l’ID de document, mais elle génère toujours l’événement ItemAdding(SPItemEventProperties).
Notes
Lorsqu’un objet SPFile appelle sa méthode MoveTo(String), il ne génère pas d’événement ItemAdding(SPItemEventProperties).
Lorsqu’un élément est ajouté, SharePoint Server 2010 ne suppose pas que cet élément est une copie. Au lieu de cela, il offre un moyen pour les solutions personnalisées de savoir si elles implémentent un « déplacement sémantique », qui (à partir d’un point de vue du modèle d’objet) est une opération de copie et suppression utilisée pour substituer la logique de copie par défaut et traiter les éléments et leurs ID de document associés comme si le modèle d’objet avait accompli sur ceux-ci une opération de déplacement.
Notes
Vous pouvez utiliser un code personnalisé afin d’éviter le remplacement des ID de document ou des ID préalablement affectés aux éléments copiés vers SharePoint Server 2010 pour la première fois. Par exemple, vous pouvez suspendre tous les événements en appelant la méthode DisableEventFiring() dans le code avant la copie. Toutefois, cette approche n’est pas recommandée dans le cas où d’autres récepteurs d’événements doivent s’exécuter et où le code existe uniquement pour conserver les ID.
Comportement de la recherche des ID de document
SharePoint Server 2010 adopte une approche en deux parties lorsque le service ID de document recherche les ID de document pour fournir le meilleur compromis entre les ID de document qui fonctionnent immédiatement et ceux qui fonctionnent sur les grandes étendues :
Recherche. Rechercher un élément sur n’importe quel emplacement qui appartient à l’étendue de recherche actuelle. La recherche fonctionne généralement mieux en tant que requête de liste croisée. Toutefois, la recherche n’est fiable que comme son dernier index. Par conséquent, si un élément a été ajouté mais n’a pas encore été indexé par la recherche, il n’apparaît pas dans les résultats de recherche. En outre, si un élément a été déplacé depuis sa dernière indexation par la recherche, l’URL ancienne (maintenant rompue) apparaît dans les résultats de recherche.
Recherche spécifique au fournisseur d’ID. Lorsqu’un élément n’est pas trouvable à l’aide de la recherche (par exemple, s’il n’a pas encore été indexé), SharePoint Server 2010 rappelle le fournisseur d’ID de document et lui permet d’utiliser sa propre logique de recherche. Ainsi, les fournisseurs qui souhaitent utiliser des ID qui fonctionnent avant l’indexation de la recherche sur les derniers éléments peuvent rechercher ces ID. Le fournisseur détermine s’il convient d’effectuer des recherches de cette manière, et quelle est la logique la plus efficace pour ce faire.
Composant WebPart Zone de recherche d’ID de document
Le Composant WebPart Zone de recherche d’ID de document vous permet d’entrer un ID de document, puis il construit une « URL statique » et recherche l’élément.
Fournisseurs d’ID de document personnalisés
Vous pouvez utiliser des fournisseurs personnalisés pour affecter des ID de document à des éléments. Dans certaines organisations, des métadonnées d’élément spécifiques pilotent la façon dont les ID sont attribués. Cela permet de garantir que l’ID transfère des informations sur l’élément.
SharePoint Server 2010 prend en charge l’utilisation de modules de code personnalisé pour fournir les ID de document. Vous pouvez créer vos propres fournisseurs personnalisés en implémentant une classe qui dérive de l’interface IIDProvider, puis en déployant et en inscrivant ce fournisseur dans chaque collection de sites. Une fois un fournisseur personnalisé inscrit, le service ID de document utilise ce fournisseur au lieu du fournisseur par défaut.