Прикладной блок «Экспорт документа в файл»
Contents
Блок является устаревшим и оставлен для совместимости с предыдущими версиями системы.
Назначение. Блок «Экспорт документа в файл» предназначен для экспорта документа из системы DIRECTUM в заданную папку файловой системы в файл с заданным именем. Экспорт документов возможен как в исходном формате (задается приложением-редактором), так и в формате Electronic Structured Document (ESD), который позволяет экспортировать документы с дополнительными реквизитами.
Базовый блок – «Сценарий».
Свойства, унаследованные от базового блока:
Имя |
Заголовок |
Тип |
Отличия от свойств базового блока |
Name |
Наименование |
Строка (Константа) |
Значение по умолчанию Экспорт эл. документа в файл |
Link |
Ссылка |
Строка (Константа) |
Доступное |
Comment |
Примечание |
Строка (Константа) |
Доступное |
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, если выбран формат «По приложению», то расширение формируется в зависимости от расширения, указанного в справочнике Приложения-редакторы для экспортируемого документа; |
| • | если все условия выполнены, то содержимое документа экспортируется в указанный файл. В случае возникновения исключительных ситуаций (ошибок) во время выполнения блока, он завершится с соответствующим результатом (см. Результаты выполнения) и содержимое документа файла не экспортируется. |
Подробнее см. раздел «Пример использования блока «Экспорт документа в файл».
| © Компания DIRECTUM, 2018 | Сообщество пользователей DIRECTUM |