Файл описания

Файл описания – сопроводительный файл, который используется для определения принципа формирования пакета при добавлении изображений из Горячей папки. В зависимости от формата файла описания, отличается набор файлов для формирования пакета.

Замечание. Помимо импорта изображений документов для обработки возможен импорт файлов офисных форматов.

В программе используются файлы описания следующих типов:

1. Captiva QuickScan
   В пакет добавляются все файлы изображений, перечисленные в сопроводительном файле. Порядок следования файлов соответствует порядку в сопроводительном файле.
2. Capture Software for Kodak
   В пакет добавляются файлы изображений, находящиеся в папке Kodak-пакета, указанной в сопроводительном файле, в порядке возрастания имен. Файл описания в формате INI содержит раздел Properties, в ключе Batch которого указан путь к папке с изображениями:
   [Properties]
   BatchPath=\\computer\HotFolder\PathInHF"
   Изображения из подпапок также добавляются в пакет.
   Замечание. Данный тип не поддерживает возможность добавления регистрационных параметров.
3. Пустой файл
   Данный файл служит маркером, свидетельствующим о необходимости создать новый пакет. Содержание файла не имеет значения, существенно только его имя. Добавление изображений из горячей папки осуществляется в алфавитном порядке. При обнаружении файла, наименование которого соответствует маске, указанной в поле Название, система создает новый пакет. Таким образом, если задана маска DAT, и горячая папка содержит следующие файлы:
• Contract1.jpg
• Contract2.jpg
• Contract3.dat
• Contract4.jpg
• Contract5.jpg
• Contract6.dat

, то для файлов Contract1.jpg и Contract2.jpg будет создан первый пакет (при нахождении файла Contract3.dat), а для файлов Contract4.jpg и Contract5.jpg - второй (при нахождении файла Contract6.dat).

1. Файл XML
   Файл в XML-формате с документированной структурой. Предназначен для случаев, когда три предыдущих типа файлов не подходят, но есть возможность генерировать собственный файл сопровождения. В пакет добавляются файлы изображений, указанные в сопроводительном файле.

Структура файла

XML-документ должен содержать корневой элемент Batch со следующими дочерними элементами: RegistrationParams, Documents и Images.

Элемент Images, в свою очередь, должен включать в себя элементы Image, количество которых соответствует количеству страниц в создаваемом пакете.

Элемент Batch содержит следующие теги:

• Priority - приоритет пакета. Может иметь значения: Lowest, Low, Normal, High, Highest. Необязательный тег. Если приоритет не указан, используется приоритет, указанный в профиле импорта.
• Name - желаемое имя пакета.
• TypeName - имя типа пакета. Используется, только если в профиле импорта указан тип пакета По умолчанию.
  Если в качестве горячей папки используется папка экспорта на Станции Сканирования, то имя, указанное в теге, должно совпадать с именем типа пакета на Станции Сканирования. В этом случае будет создан пакет указанного типа.
• Attachments - вложения к пакету.
• SourceID - строковый идентификатор источника пакета.
• Description - описание.
• RegistrationParams - список регистрационных параметров пакета. Регистрационные параметры из файла описания добавляются к регистрационным параметрам, указанным в профиле импорта.
• Documents - список документов (не участвуют в автоматической сборке).
• Images - список отдельных страниц (участвуют в автоматической сборке).

Элемент Document содержит следующие теги:

• Index (обязательный атрибут) - индекс документа (начиная с нуля) среди документов пакета.
• Priority - приоритет. Может иметь значения: Lowest, Low, Normal, High, Highest. Необязательный тег.
• Name - имя документа.
• Barcode - значение штрих-кода.
• RegistrationParams - список регистрационных параметров документа.
• Attachments - вложения к документу.
• Images - список страниц документа.

Элемент Parameter (дочерний элемент RegistrationParams) содержит следующие теги:

• Name (атрибут) - название регистрационного параметра.
• Value - значение регистрационного параметра.

Элемент Image содержит следующие теги:

• Index (обязательный атрибут) - индекс страницы (соответствующего документа для страниц из элемента Images) среди страниц документа (документов пакета); нумерация начинается с нуля.
• PageIndex (атрибут) - номер страницы (начиная с нуля) в многостраничном импортируемом файле.
• SourcePath (атрибут) - путь к папке с исходными изображениями.
• SourceFile (атрибут) - исходный файл с изображением страницы (путь относительно SourcePath).
• SourceFilePageIndex (атрибут) - номер страницы (начиная с нуля) в многостраничном исходном файле.
• SourceDetails (атрибут) - произвольное описание источника (название сканера).
• Attachments - вложения к странице.
• Value - путь к импортируемому файлу, указанный для страницы относительно горячей папки.

Элемент Attachment содержит следующие теги:

• Name - имя файла вложения. Если имя не указано, будет использовано имя исходного файла.
• Value - путь к файлу вложения. Можно указать путь относительно корня горячей папки.

Программу сканирования рекомендуется настроить таким образом, чтобы отсканированные изображения помещались в саму горячую папку или ее подпапки первого уровня. При создании пакета в него будут добавлены все изображения, пути к которым указаны в элементах Image соответствующего файла сопровождения.

Порядок добавления изображений соответствует порядку их следования в файле.