Partager via


Interface IRouter pour les routeurs personnalisés

Chaque routeur personnalisé doit implémenter l'interface IRouter. Cette interface contient une seule méthode, OnSubmitFile.

Quand un fichier est soumis au centre d'enregistrements, Microsoft Office SharePoint Server 2007 appelle le routeur personnalisé approprié s'il en existe un, à l'aide de la méthode OnSubmitFile. Le routeur effectue ensuite son opération sur le document envoyé et les métadonnées associées. Le routeur personnalisé traite le fichier soumis et ses métadonnées associées. Ce processus est opaque pour Microsoft Office SharePoint Server 2007. Quand le routeur personnalisé a terminé, il renvoie un des trois résultats suivants au centre d'enregistrements :

  • Le routeur a terminé correctement, et le centre d'enregistrements continue avec son processus et son stockage standard du fichier envoyé.

  • Le routeur a terminé correctement, mais le centre d'enregistrements annule son processus et son stockage standard du fichier envoyé.

  • Le routeur a échoué ; le centre d'enregistrements interrompt son processus et son stockage standard du fichier envoyé et renvoie une erreur à l'application appelante.

Dans chaque cas, le routeur peut aussi renvoyer des informations supplémentaires sur le routage. Dans les deux derniers résultats, le centre d'enregistrements renvoie également ces informations à l'application appelante.

Traitement personnalisé des documents soumis

Plusieurs des paramètres de la méthode OnSubmitFile sont passés par référence, ce qui permet au routeur personnalisé de modifier ces valeurs si nécessaire. Ceci inclut les paramètres fileToSubmit, properties, destination, et resultData. Pour cette raison, le routeur personnalisé peut effectuer les actions suivantes :

  • Modifier le document soumis. Supposons qu'un développeur veuille stocker le fichier soumis réel à un emplacement différent. Il peut programmer le routeur pour stocker le fichier ailleurs, et remplacer le fichier soumis dans le paramètre fileToSubmit par un fichier texte contenant une URL vers l'emplacement de stockage du fichier réel.

  • Modifier les métadonnées du document soumis. Par exemple, le routeur personnalisé peut analyser le document soumis pour extraire des métadonnées supplémentaires, puis écrire ces métadonnées dans le paramètre properties.

  • Modifier la destination de stockage du document soumis. Par exemple, le routeur personnalisé peut analyser le document soumis, et mettre à jour la destination du document sur la base des informations du document.

  • Communiquer des informations détaillées sur les résultats de son traitement. Le routeur personnalisé peut écrire toutes les informations détaillées nécessaires sur le traitement dans le paramètre resultData. Si le routeur échoue ou s'il informe le centre d'enregistrements qu'il doit annuler son propre traitement du document soumis, le centre d'enregistrements renvoie ces informations à l'application appelante.

Annulation du traitement de documents soumis

Le routeur peut renvoyer une valeur SuccessCancelFurtherProcessing, qui informe le centre d'enregistrements que le routeur a terminé correctement son traitement, mais que le centre d'enregistrements ne doit pas effectuer son propre traitement. Dans ce cas, le centre d'enregistrements arrête son traitement et le document soumis et ses métadonnées associées ne sont pas stockés dans le référentiel. Les développeurs peuvent utiliser cette fonctionnalité pour implémenter une solution dans laquelle le routeur effectue tout le traitement et le stockage de documents d'un certain type de routage d'enregistrement qui est soumis à un centre d'enregistrement.

Dans les cas où le routeur indique au centre d'enregistrements d'annuler le traitement du fichier, le centre d'enregistrements renvoie une valeur correspondant à la réussite de l'opération à l'application appelante, mais renvoie également le contenu du paramètre resultDetails. Les développeurs peuvent utiliser ce paramètre pour communiquer des informations détaillées sur le traitement du routeur à l'application appelante.

Voir aussi

Autres ressources

Modèle de site Centre des enregistrements
Traitement des fichiers du Centre d'enregistrements
Routeur personnalisé du Centre d'enregistrements