Типовые маршруты
Прикладной блок «Экспорт электронного документа в файл»
Назначение. Блок «Экспорт электронного документа в файл» предназначен для экспорта электронного документа из системы DIRECTUM в заданную папку файловой системы в файл с заданным именем. Экспорт электронных документов возможен как в исходном формате (задается приложением-редактором), так и в формате Electronic Structured Document (ESD), который позволяет экспортировать документы с дополнительными реквизитами.
Базовый блок - «Сценарий».
Свойства, унаследованные от базового блока:
|
Имя |
Заголовок |
Тип |
Отличия от свойств базового блока |
|
Name |
Наименование |
Строка (Константа) |
По умолчанию имеет значение «Экспорт электронного документа в файл» |
|
Script |
Вычисление |
Строка (Вычисление) |
Скрытое |
Дополнительные свойства:
|
Имя |
Заголовок |
Тип |
Описание |
|
EDocument |
Электронный документ |
Электронный документ (Константа или параметр) |
Электронный документ, который должен быть экспортирован. Обязательное |
|
Folder |
Папка |
Строка (Константа или параметр) |
Путь к локальной или сетевой папке, в которую будет экспортирован электронный документ. Обязательное |
|
Format |
Формат |
Признак (Константа) |
Признак, определяющий, в каком формате будут экспортироваться файлы. Возможные значения «ESD», «По приложению». Обязательное. По умолчанию имеет значение «По приложению» |
|
FileName |
Имя файла |
Строка (Константа или параметр) |
Имя файла, в который будет экспортирован электронный документ. |
|
VersionNumber |
Номер версии |
Целое число (Константа или параметр) |
Номер версии электронного документа, которая будет экспортирована |
|
NeedLock |
C блокировкой |
Признак (Константа) |
Признак, определяющий, нужно ли экспортировать электронный документ с блокировкой. Может принимать значения «Да» или «Нет». Обязательное. По умолчанию «Нет» |
Результаты выполнения. В результате выполнения блока возвращается одно из следующих значений:
|
Код |
Наименование |
Примечание |
|
E |
Успешно экспортировано |
Электронный документ EDocument успешно экспортирован в папку Folder в файл с заданным наименованием. |
|
D |
Электронный документ не определен |
Документ, указанный в свойстве EDocument, не найден (не задано свойство или документ был удален) |
|
V |
Некорректный номер версии |
Версия документа, указанная в свойстве VersionNumber, не найдена |
|
B |
Электронный документ экспортирован с блокировкой |
Электронный документ уже экспортирован с блокировкой. Повторный экспорт с блокировкой без предварительной разблокировки не возможен |
|
A |
Электронный документ зашифрован |
Документ зашифрован, и служба Workflow не может экспортировать документ |
|
F |
Папка не найдена |
Папка, заданная в свойстве Folder не существует |
Описание:
· при выполнении блока «Экспорт электронного документов в файлы» последовательно проверяется выполнение следующих условий:
· существование папки, указанной в свойстве Folder;
· наличие экспортируемого электронного документа Edocument;
· отсутствие шифрования электронного документа EDocument;
· существование версии VersionNumber, которая будет экспортирована.
· путь к папке в свойстве Folder может быть задан как сетевой (в этом случае пользователь, от имени которого запущена служба Workflow, должен обладать правами на сетевой ресурс на запись), так и локальный (при указании локального пути будет происходить обращение к локальным ресурсам сервера, на котором запущена служба Workflow). Указывать путь к папке можно как с ‘\’ на конце, так и без него (например, «C:\» равнозначно «C:»);
· если задано свойство FileName, то экспорт будет произведен в файл с указанным именем. Если указанное имя файла содержит символы, которые нельзя использовать в именах файлов в файловой системе (такие, как \:/*?"<>|.‘’“”), то они будут заменены на символ «_». Если данное свойство не задано, то в качестве имени файла будет использовано наименование электронного документа (если оно содержит недопустимые в имени файла символы, то они так же будут заменены на «_»);
· имя файла, заданное в свойстве FileName не должно совпадать с предопределенными именами устройств: CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9;
· если задано свойство VersionNumber, то будет экспортирована версия с указанным номером. Если свойство не задано, то версия будет выбрана по следующим правилам:
· если есть действующие версии документа, то экспортируется последняя действующая версия;
· если действующих версий нет, то экспортируется последняя версия в разработке;
· если версий в разработке нет, то экспортируется последняя устаревшая версия.
· расширение файла выбирается в зависимости от выбранного формата экспорта – если был выбран формат «ESD», то файл формируется с расширением ESD, если выбран формат «По приложению», то расширение формируется в зависимости от расширения, указанного в справочнике Приложения-редакторы для экспортируемого электронного документа;
· если все условия выполнены, то содержимое электронного документа экспортируется в указанный файл. В случае возникновения исключительных ситуаций (ошибок) во время выполнения блока, он завершится с соответствующим результатом (см. Результаты выполнения) и содержимое документа файла не экспортируется.
См. также:
· Прикладной блок «Импорт файла в электронный документ»;
· Прикладной блок «Мониторинг появления файла»;
· Прикладной блок «Создание электронного документа из файла».
|
© 2009, Компания DIRECTUM
|
|
Отправить комментарий к этому разделу на
support@directum.ru
|