Объектная модель служб Word Automation Services
Дата последнего изменения: 1 апреля 2010 г.
Применимо к: SharePoint Server 2010
В этом разделе описываются основные объекты, используемые при разработке решений для Word Automation Services.
Обзор
Модель программирования для Word Automation Services предоставляет серверную объектную модель, которую приложения используют для асинхронного запроса преобразований, выполняя следующие действия:
Задание приложения-службы, выполняющего преобразование.
Задание необходимых и необязательных свойств для этой группы преобразований.
Задание одного или нескольких файлов для преобразования.
Передача преобразования в очередь документов.
После отправки приложением запроса преобразования, служба автоматически использует очередь "первый пришел, первый вышел" (FIFO) для запуска этих преобразований на основе расписания, определенного для приложения-службы. Каждый запрос преобразования также определяет GUID, который можно использовать для запроса сведений о состоянии этого запроса.
Создание задания преобразования
Для преобразования файлов с помощью Word Automation Services объектная модель использует объект ConversionJob для слежения за набором преобразований как за единым блоком. Например, для преобразования 15 файлов в формат PDF и 30 файлов в формат XPS требуется два объекта ConversionJob, по одному на каждый набор преобразований с одинаковыми свойствами.
Чтобы инициализировать объект ConversionJob, коду требуется один параметр, определяющий имя, идентификатор или прокси приложения-службы, соответствующие приложению-службе. Обычно проще всего использовать имя службы, определяемое при ее создании.
После создания объекта ConversionJob ему назначается уникальный идентификатор. Объект ConversionJob предоставляет этот идентификатор с помощью своего свойства JobId, которое позволяет запрашивать задание преобразования после его отправки.
Настройка параметров
После создания объекта ConversionJob можно использовать ряд параметров объекта ConversionJob для определения способа выполнения преобразований.
Самым важным из этих параметров является свойство UserToken, определяющее учетные данные пользователя, используемые для доступа к преобразуемым документам и для записи документов обратно в список SharePoint Server 2010. По умолчанию используется анонимный доступ. Чтобы гарантировать успешное преобразование, рекомендуется назначать свойству UserToken учетные данные пользователя, отправляющего задание преобразования.
Кроме свойстваUserToken, свойство Settings содержит коллекцию других параметров преобразования. Эта коллекция содержит параметры, определяющие:
должны ли поля обновляться автоматически;
должны ли конечные файлы автоматически перезаписывать существующие;
форму конечных файлов.
Мониторинг выполнения
Отправленное задание выполняется асинхронно в том порядке, в котором оно добавлено в очередь документов. Задания преобразований можно отслеживать в любое время, используя доступные методы объекта ConversionJobStatus:
Метод GetAllJobs(String, Nullable<Guid>) возвращает идентификаторы всех заданий преобразования для конкретного экземпляра службы (с фильтрацией по имени экземпляра, идентификатору или прокси, опять же), которые затем при необходимости могут быть отфильтрованы по конкретному пользователю, их отправившему.
Метод GetAllActiveJobs(String, Nullable<Guid>) возвращает идентификаторы всех заданий преобразования для конкретного экземпляра службы, в которых еще не обработаны один или несколько элементов (с фильтрацией по имени экземпляра, идентификатору или прокси), которые затем при необходимости могут быть отфильтрованы по конкретному пользователю, их отправившему.
На уровне задания преобразования можно создать объект ConversionJobStatus для конкретного задания, используя его идентификатор (полученный с помощью вышеприведенных методов, или известный с момента создания задания). Этот объект содержит список всех элементов преобразования, которые были успешно обработаны, еще не обработаны, или обработка которых не удалась.