База знаний

Номер статьи: 1318 | Категория: Общие вопросы | Тип: Вопрос/Ответ | Последнее обновление: 27.08.2015

Использование приложений (attachments) в FlexiCapture

Файлы для скачивания

Описание

Что называется "приложением" в контексте FlexiCapture? Как можно использовать приложения? Как добавить приложение к пакету/документу/странице?

Решение

В FlexiCapture 10 к пакетам, документам и страницам могут быть добавлены файлы любого формата в качестве приложений. Прикрепленные файлы никак не будут обработаны системой. Таким образом, с помощью приложений для пакетов, документов и страниц можно добавлять любые дополнительные материалы, которые не нуждаются в распознавании.

Как известно, при настройке сборки страниц в документы в редакторе определений документов пользователь может выбрать опцию Допускать страницы приложений. Такие страницы также никак не будут обработаны системой и будут просто включены в состав документа. Существует важное отличие подобных «страниц-приложений» от «файлов-приложений», которым посвящена эта статья. «Страницы-приложения» - это просто некоторые не требующие распознавания файлы, импортированные в систему с использованием Горячей папки или загруженные на Станции сканирования. «Файлы-приложения» могут быть файлами любого формата, а главное, это могут быть результаты некоторого преобразования исходных файлов страниц и документов. Наиболее распространенный сценарий использования этих приложений – добавление цифровой подписи, когда на Станции сканирования к страницам добавляется бинарный файл, полученный из исходного изображения (подробнее см. пример проекта).

Существует несколько способов добавления пользовательских приложений:

  1. При загрузке изображений из горячей папки в соответствии с настройками, указанными в файле описания.
  2. С помощью скрипта на Станции сканирования.
  3. На закладке Приложения в диалоговом окне свойств элемента (пакет, документ, страница), к которому приложения добавляется.
  4. С помощью скрипта (интерфейс IUserAttachments).
  5. Используя программный интерфейс (API).

Рассмотрим более подробно каждый из этих способов.

1.     XML-файл описания позволяет добавлять приложения к пакетам, документам и изображениям при импорте из горячей папки. О структуре подобного документа подробно можно прочитать в справке: Настройка программы -> Файл описания. Для того чтобы прикрепить файл приложения к элементу, необходимо добавить тег Attachments к соответствующему элементу в xml-описании.

<Attachments>
               <Attachment>path_to_the_file_relative_to_the_Hot_Folder</Attachment>
</Attachments>

Ниже приведен пример файла описания для пакета Batch. Пакет включает 5 изображений. К пакету добавлено приложение attachment1, кроме того, к первому изображению пакета добавлено приложение attachment2.

Пример

2.   На Станции сканирования может быть добавлен скрипт, добавляющий с помощью методов интерфейсов IAttachments и IAttachmentByteArray пользовательские приложения к пакету, странице или документу (в случае ручного разделения на документы).

Пример скрипта, добавляющего приложение к последнему созданному пакету (JScript):

var batch = Batches(Batches.Count - 1);
var ua = batch.Attachments.AddFromFile("attachment_name", "path_to_file");

3.    Закладка Приложения. Данная закладка диалогового окна свойств элемента позволяет прикрепить к нему файл, нажав на кнопку Новое... и указав путь, а также сохранить файл приложения на жесткий диск или удалить приложение. 

 

4.     Скрипт. Приложения могут быть добавлены к страницам, документам и пакетам с помощью методов интерфейса IUserAttachments.

Приложения к пакету могут быть добавлены из скриптов обработчиков событий (например, событие Создание пакета), а также на скриптовой стадии, когда скрипт работает для всего пакета (Type: Batch processing). Приложения к документам и страницам также можно добавлять при обработке событий (Создание документа, Добавление страницы), на скриптовых стадиях, а еще могут быть добавлены соответствующие пользовательские действия на станции верификации (см. пример проекта).

Стоит отметить, что метод IUserAttachments.AddNew просто создает новый экземпляр IUserAttachment, но не добавляет его в коллекцию. Для этого нужно использовать метод IUserAttachment.UploadAttachment. Простейший способ добавления приложения к документу:

IUserAttachment ua = Document.Attachments.AddNew("attachment_name");
ua.FromFile(@"attachment_file_path");
ua.UploadAttachment();

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

5.    Методы API позволяют удалять и прикреплять файлы к пакетам, документам и страницам. Для работы с приложениями доступны следующие методы:

GetAttachmentNames

Получить список названий всех приложений

LoadAttachment

Загрузить файл приложения

RemoveAttachment

Удалить приложение с Сервера Приложений

SaveAttachment

Сохранить приложение на Сервер Приложений

Ниже приведен пример кода, в котором создается новый пакет, загружается изображение, прикрепляется приложение к пакету и запускается обработка:

Пример кода

Подробнее об использовании Web Services API смотри эту статью.

Если к пакету/документу/странице добавлено приложение, это визуально отмечается скрепкой в соответствующей графе Attachments напротив названия:

 

 

 

Далее рассмотрим примеры проектов, где используются приложения.


Для того чтобы на панель инструментов добавить кнопку, вызывающую только что добавленный скрипт, нажмите Customize Toolbar…, загрузите нужную иконку и поставьте ее в соответствие скрипту:


Не забудьте включить панель инструментов скриптов (Вид >> Панели инструментов >> Скрипты).
).
Подробнее об использовании скриптов на Станции Сканирования можно прочитать в отдельной статье.
Пример скрипта для добавления цифровой подписи к изображениям на станции сканирования.

AddAttachment; JScript

GlobalModule; VBScript

545 считают это полезным.
Была ли эта информация вам полезна?