Word Automation Services, modèle objet
Dernière modification : jeudi 1 avril 2010
S’applique à : SharePoint Server 2010
Dans cette rubrique, vous allez découvrir les objets principaux qui vous servent lors du développement avec les Word Automation Services.
Vue d’ensemble
Le modèle de programmation des Word Automation Services offre un modèle objet côté serveur que les applications utilisent pour demander des conversions de façon asynchrone en exécutant les actions suivantes :
Spécifier l’application de service qui effectue la conversion.
Définir les propriétés requises ou facultatives pour ce groupe de conversions.
Spécifier un ou plusieurs fichiers à convertir.
Soumettre la conversion à la file d’attente de documents.
Une fois que l’application a soumis la demande de conversion, le service utilise automatiquement une file d’attente de type premier entré, premier sorti (FIFO) pour commencer ces conversions, en fonction de la planification définie pour l’application de service. Chaque demande de conversion spécifie également un GUID que vous pouvez utiliser pour interroger l’état de cette demande de conversion.
Création d’un travail de conversion
Pour convertir des fichiers à l’aide des Word Automation Services, le modèle objet utilise l’objet ConversionJob pour faire le suivi d’un ensemble de conversions sous forme d’une seule unité. Par exemple, la conversion de 15 fichiers dans le format PDF et de 30 fichiers dans le format XPS requiert deux objets ConversionJob, un pour chaque ensemble de conversions ayant les mêmes propriétés.
Pour initialiser l’objet ConversionJob, le code requiert un seul paramètre qui spécifie le nom, l’ID ou le proxy de l’application de service qui correspond à cette application de service. Généralement, le nom de l’application de service, qui est spécifié à sa création, est le plus simple à l’usage.
Après la création d’un objet ConversionJob, un ID unique lui est attribué. L’objet ConversionJob expose cet ID via sa propriété JobId, ce qui rend possible l’interrogation du travail de conversion après sa soumission.
Configuration des paramètres
Après avoir créé un objet ConversionJob, vous pouvez utiliser plusieurs paramètres de ConversionJob pour spécifier la façon d’exécuter les conversions.
Le plus important de ces paramètres est la propriété UserToken, qui détermine les informations d’identification de l’utilisateur utilisées pour accéder aux documents à convertir et réécrire les documents dans la liste SharePoint Server 2010. L’accès anonyme est utilisé par défaut. Il est recommandé d’attribuer les informations d’identification de l’utilisateur qui soumet le travail de conversion à la propriété UserToken afin de garantir que les documents soient bien convertis.
En plus de la propriété UserToken, la propriété Settings contient une collection d’autres paramètres de conversion. Cette collection inclut des paramètres pour spécifier :
La mise à jour automatique ou non des champs.
L’écrasement automatique ou non des fichiers existants par les fichiers de sortie.
Le format du fichier de sortie.
Suivi d’avancement
Après la soumission d’un travail, celui-ci est traité de façon asynchrone dans l’ordre d’ajout à la file d’attente de documents. Cependant, vous pouvez à tout moment surveiller les travaux de conversion à l’aide des méthodes disponibles sur l’objet ConversionJobStatus :
La méthode GetAllJobs(String, Nullable<Guid>) retourne les ID de tous les travaux de conversion pour une instance spécifique du service (à nouveau filtrés par ID, proxy ou nom d’instance), qui peuvent ensuite être filtrés en fonction des travaux soumis par un utilisateur spécifique.
La méthode GetAllActiveJobs(String, Nullable<Guid>) retourne les ID de tous les travaux de conversion pour une instance spécifique du service dont un ou plusieurs éléments sont déjà traités (à nouveau filtrés par ID, proxy ou nom d’instance), qui peuvent ensuite être filtrés en fonction des travaux soumis par un utilisateur spécifique.
Au niveau du travail de conversion, vous pouvez créer l’objet ConversionJobStatus pour un travail spécifique en utilisant son ID (obtenu à partir des méthodes ci-dessus ou par connaissance de l’ID à la création du travail). Cet objet contient une liste de tous les éléments de la conversion dont le traitement a réussi, a échoué ou n’a pas encore eu lieu.