Modelo de objetos de Word Automation Services
Última modificación: jueves, 01 de abril de 2010
Hace referencia a: SharePoint Server 2010
En este tema, obtendrá información acerca de los objetos principales que se usan para el desarrollo de Servicios de automatización de Word.
Información general
El modelo de programación de Servicios de automatización de Word proporciona un modelo de objetos del lado servidor que las aplicaciones usan para solicitar conversiones de forma asincrónica mediante las siguientes acciones:
Especificación de la aplicación de servicio que realiza la conversión.
Establecimiento de las propiedades requeridas y opcionales para este grupo de conversiones.
Especificación de uno o varios archivos para convertir.
Envío de la conversión a la cola de documentos.
Una vez que la aplicación envía la solicitud de conversión, el servicio usa automáticamente una cola FIFO (primero en entrar, primero en salir) para iniciar esas conversiones de acuerdo a la programación establecida para la aplicación de servicio. Cada solicitud de conversión también especifica un GUID que se puede usar para consultar información de estado acerca de esa solicitud de conversión.
Creación de un trabajo de conversión
Para convertir archivos mediante Servicios de automatización de Word, el modelo de objetos usa el objeto ConversionJob para realizar el seguimiento de un conjunto de conversiones como una sola unidad. Por ejemplo, la conversión de 15 archivos en formato PDF y 30 archivos en formato XPS requiere dos objetos ConversionJob, uno por cada conjunto de conversiones con las mismas propiedades.
Para inicializar el objeto ConversionJob, el código requiere un único parámetro que especifica el nombre, el identificador o el proxy de la aplicación de servicio que corresponde a la aplicación de servicio. Por lo general, el nombre de la aplicación de servicio, que se especifica cuando se crea, es el más fácil de usar.
Una vez que se crea un objeto ConversionJob, se le asigna un identificador único. El objeto ConversionJob expone este identificador a través de su propiedad JobId, lo que permite consultar el trabajo de conversión después de que se haya enviado.
Configuración de opciones
Una vez que se crea un objeto ConversionJob, se pueden usar varias opciones de configuración en el objeto ConversionJob para especificar la forma en que se desea realizar las conversiones.
Lo más importante de esta configuración es la propiedad UserToken, que determina las credenciales de usuario que se usan para tener acceso a los documentos que se van a convertir y para volver a escribir documentos en la lista de SharePoint Server 2010. De manera predeterminada, se usa el acceso anónimo. Como procedimiento recomendado, asigne las credenciales del usuario que envía el trabajo de conversión a la propiedad UserToken a fin de garantizar que los documentos se convierten correctamente.
Además de la propiedad UserToken, la propiedad Settings contiene una colección de otras opciones de conversión. Dicha colección incluye opciones que especifican lo siguiente:
Si los campos se deben actualizar automáticamente o no.
Si los archivos de salida deben sobrescribir automáticamente a los archivos existentes.
El formato del archivo de salida.
Supervisión del progreso
Una vez que se envía un trabajo, se procesa de forma asincrónica en el orden en que se agregó a la cola de documentos. Sin embargo, puede supervisar los trabajos de conversión en cualquier momento mediante los métodos disponibles en el objeto ConversionJobStatus:
El método GetAllJobs(String, Nullable<Guid>) devuelve los identificadores para todos los trabajos de conversión de una instancia específica del servicio (de nuevo, filtrados por el nombre de la instancia, el identificador o el proxy) que, después, pueden filtrarse de manera opcional para los trabajos enviados por un usuario específico.
El método GetAllActiveJobs(String, Nullable<Guid>) devuelve los identificadores de todos los trabajos de conversión de una instancia específica del servicio para la que aún deben procesarse uno o varios elementos (de nuevo, filtrados por el nombre de la instancia, el identificador o el proxy) que, después, pueden filtrarse de manera opcional para los trabajos enviados por un usuario específico.
En el nivel de trabajo de conversión se puede crear el objeto ConversionJobStatus de un trabajo específico mediante su identificador (obtenido a partir de los métodos anteriores o porque se conoce el identificador de la creación de trabajos). Este objeto contiene una lista de todos los elementos de conversión correctos, con errores o que aún deben procesarse.