Russian (Русский) - Change language

Встраивание этапа верификации в сторонние системы

В данном разделе описывается встраивание этапа верификации с использованием Windows-аутентификации. Также возможна аутентификация FlexiCapture и SAML.

Загрузка интерфейса и функциональности станции верификации ABBYY FlexiCapture 12 осуществляется через элемент <iframe>. В качестве значения элемента src укажите ссылку вида:

<stationUrl>/WinAuth/Verify?projectId=[project identifier]&roleId=[role identifier]&stageId=[stage identifier]&disableSendToStage=false&hideTaskInfo=false&disableChangeDefinition=false&taskId=[Itask identifier]&returnTo=DeadEnd&mode=mini, где:

Имя параметра Обязательный Описание
<stationUrl> Адрес станции верификации, к которой обращается сторонняя система. По умолчанию задано значение <serverName>/FlexiCapture12/Verification.
WinAuth Параметр windows авторизации.
projectId Параметр является обязательным, если не задан taskId ID проекта. Если задан только ID проекта, будет взято любое задание этого проекта.
roleId ID роли оператора. Не зависит от остальных параметров. Если этот параметр не задан, задание откроется с максимально возможной для пользователя ролью.
stageId ID этапа заданного проекта.
disableSendToStage Если значение этого параметра равно true, возможность выбора этапа для отправки задания будет скрыта. По умолчанию кнопка Отправить задание на этап… отображается в интерфейсе.
hideTaskInfo Если значение этого параметра равно true, возможность просмотра информации о пакете будет скрыта. По умолчанию кнопка Информация о пакете отображается в интерфейсе.
disableChangeDefinition Если значение этого параметра равно true, будут скрыты возможности изменения раздела для страницы, изменения определений документов и распознавания документа. По умолчанию эти кнопки отображаются в интерфейсе.
taskId Параметр является обязательным, если не задан projectId ID задания, направленного на верификацию. Если этот параметр не указан, будет открыто любое задание, удовлетворяющее остальным параметрам.
returnTo=DeadEnd Маркер, позволяющий после завершения обработки задания перейти на финальную страницу без возможности продолжить работу со встроенной станцией верификации.
mode=mini Маркер, позволяющий перейти в минимизированный режим (без отображения верхнего и нижнего колонтитулов).

Если указаны все параметры, приоритетным будет ID задания.

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

Настройка станции верификации осуществляется через редактирование ключей в секции <appSettings>, находящейся в файле Web.config. Для отключения пунктов меню установите равным true значение соответствующего ключа:

  • DisableSendToRescan – отправить задания на пересканирование;
  • DisableTaskPostponement – отложить задания;
  • DisableSendToStage – выбрать конкретный этап для отправки задания;
  • DisableSendToExceptions – отправить задание в исключения.

Рекомендуется отключать функцию отображения верхнего и нижнего колонтитулов при встраивании станции верификации. Это обеспечит пользователю доступ только к обработке конкретного пакета и скроет не относящуюся к сценарию функциональность. Сделать это можно с помощью суффикса ?mode=mini в URL или установив значение ключа Headless равным true.

После завершения обработки задания и выхода из встроенной станции верификации в родительский элемент с помощью метода postMessage передаётся одно из следующих сообщений:

  • FC_Verification_TaskClosed – задание закрыто и отправлено на экспорт;
  • FC_Verification_TaskSentToStage – задание отправлено на другой этап;
  • FC_Verification_TaskSentToExceptions – задание отправлено в исключения;
  • FC_Verification_TaskPostponed – задание отложено;
  • FC_Verification_TaskSentToRescan – задание отправлено на пересканирование;
  • FC_Verification_CantGetTask – по каким-то причинам не удалось взять задание;
  • FC_Verification_TaskRejected  – задание было отменено.

Пример получения сообщения

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

10.11.2020 12:08:08


Please leave your feedback about this article