Общий принцип работы SOIKA

Действия будут входить в отдельный продукт Robin OCR 1.0 и не относятся к студии стандартным сборкам студии.

Аутентификация:

1. При первом подключении необходимо заходить через браузер, chrome предпочтительно. admin, admin.

2. Для получения доступа к функциям rest-сервиса требуется аутентификация – BasicHttpAuth, логин и пароль передаются в заголовке http, при этом логин в открытом виде, а пароль – зашифрованный MD5.

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

4. В двух вкладках открывают сразу же 2 модуля. Модуль администратора: http://localhost/administrator. Модуль валидации: http://localhost/validation. 

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

6. Личный логин и пароль пользователей связан с личными настроенными сценариями.

Документы:

1. У пользователя будет создано 2 папки, импорт и экспорт, сколько угодно файлов в них. 

2. Поддерживаемые форматы изображений: JPEG, PDF, TIFF, BMP, PNG, DOCX, GIF. При добавлении PDF или TIFF добавляются все страницы из документа.

3. Если в папке, поданной на вход в поле "Файл" подается неверный формат, то робот будет выдавать ошибку.

4.  Если при распознавании произошла жёсткая ошибка, то упадёт обратно на импорт или отправится с модуль контроля качества.
   

Как работает:

1. Нужно минимум 2 запроса, чтобы отправить документ. Сначала  отправляется запрос на создание пакета, в запрос передается единственное изображение пакета или первое. Запрос возвращает GUID пакета. Если изображений в пакете должно быть несколько, то в последующих запросах эти изображения добавляются к пакету (по одному). Завершающим запросом надо запустить пакет на обработку. Во второй и последующие запросы передается GUID созданного пакета.

2. Можно поставить таймер и запрашивать статус по времени. Тогда лишаем пользователя возможности запускать процессы параллельно. 

3. Формат результата настраивается заранее в сценарии.

4. Пользователь будет получать результат в виде коллекции с json/xml файлами.

5. Список классов пакета пользователь должен знать перед запуском действия.

6. Классы пакетов будут настроены в системе инженером, нужно выбрать класс, подходящий для обработки изображения. Имя класса пакета нужно указывать при создании пакета (обязательно). Имя класса пакета - это имя настроенного проекта. Имя пакета надо задавать в запросе. Можно в скрипте робота задавать имя как константу (то есть не пользователь выбирает, а задается в скрипте) , система будет переименовывать пакет, добавляя к имени индекс.

7. Когда робот будет завершать работу с ошибкой, в тексте ошибки нужно дополнительно выводить последний статус обработки документа. 

8. Если статус документа не "export", то робот не сможет получить результат и пропустит документ. Пользователь сам должен будет передвинуть документ в другой статус на сервере.

9. Если в результате json-объект,  то сможем ли мы обработать его действиями по работе с json. если нет, то возвращать строкой, содержащий текст в  json-формате.