Обзор пользовательского
интерфейса ApRbot
Добро пожаловать на страницу документации ApRbot, где Вы можете изучить платформу и основы работы.
1. Загрузка документов в проект
1.1. Загрузка (способ №1) с помощью файлового менеджера

1.1.1. Нажать кнопку «Добавить документ +». В появившемся меню нажать «Загрузить». После этого откроется файловый менеджер, в котором нужно выбрать один или несколько документов для загрузки и нажать кнопку «Открыть»
1.2. Загрузка (способ №2) с помощью Drag-and-drop

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

1.3.1. При необходимости можно указать название папки, в которую будет загружен документ. Для этого, в поле «Добавить в папку» вводим новое название папки или выбираем из списка ранее созданных папок

1.3.2. Далее нужно нажать кнопку «Добавить». Документ успешно загружен в проект

1.3.3. Если не выбирать папку, то документы загружаются в корневую папку первого уровня «/»

2. Редактирование документов
В приложении предусмотрен функционал по разделению документов на случай, если файл содержит в себе несколько документов

2.1. Чтобы попасть в редактор документов, нужно открыть документ из списка в проекте и нажать соответствующую кнопку
для редактирования документов
2.2. Далее откроется интерфейс редактора, который состоит из трех основных блоков:

2.2.1. Окно с отображением текущей страницы документа (далее Превью)

2.2.2. Интерфейс с отображением перечня страниц в исходном файле, загруженного в проект (далее Файл)

2.2.3. Интерфейс по редактированию документов на основе исходного файла (далее Документ)
2.3. Чтобы создать отдельный Документ из исходного Файла, нужно выделить необходимые страницы в Файле левой клавишей мыши и перенести их на кнопку «+ Новый документ»
2.4. После этого создается новый документ из выделенных страниц. Также его можно переименовать
2.5. Для удаления страниц из нового Документа нужно выделить их левой клавишей мыши, после чего нажать соответствующую кнопку удаления

2.6. Для удаления самого Документа нужно нажать на него (пока не появится синяя рамка) и нажать соответствующую кнопку удаления
2.7. После завершения работы в редакторе документов, для сохранения результатов нужно нажать кнопку «Сохранить и вернуться в проект»
Дополнительные комментарии:

2.8. Если нужно отдельный документ только из одной страницы, эту страницу можно не выделять, а сразу же переносить на кнопку «+ Новый документ»

2.9. При редактировании документов, исходный Файл не меняется
Разметка документов
3.1. Разметка документов человеком

3.1.1. Чтобы попасть в нужный проект, нужно найти его среди списка на главной странице и нажать на само название проекта
3.1.2. Чтобы отобразить нужный тип документа, необходимо в фильтре слева в поле «Типы документов» снять галочку «Все типы» и поставить галочку напротив нужного типа документов и нажать кнопку «Применить»
3.1.3. Для перехода в режим Разметки открываем документ путем нажатия на ссылку документа в таблице.
Интерфейс разметки (далее Аннотатор) состоит из двух основных блоков:

3.1.3.1. Окно с отображением текущей страницы документа (далее Документ)

3.1.3.2. Поля для извлеченных значений из документа (далее Поля)
3.1.4. Для выделения текста в Документе используется левая кнопка мышки
3.1.5. После выделения нужного участка текста, он автоматически попадает в буфер (копируется)
3.1.6. Чтобы вставить текст в нужное поле, нужно «кликнуть» левой кнопкой мышки в нужное поле
3.1.7. Если поле заполнено неверно, то текст можно удалить. Сделать это можно нажав левой кнопкой мышки на значок корзины в нужном поле

3.1.8. Если текст остался, но значок корзины пропал, то необходимо обновить страницу
3.1.9. Если извлеченные данные содержат ошибку (например, из-за ошибки распознавания текстового слоя Finereader),
ошибку можно исправить вручную
3.1.10. Для завершения разметки необходимо нажать на соответствующую кнопку
Дополнительные комментарии:

3.1.11. Если какое-то поле авторазметкой заполнено неправильно, то нужно очистить его и заполнить верными данными.

3.1.12. Если какое-то поле не удастся заполнить ни разу, например, поле «Номер телефона судьи» в документе «Исполнительный документ», сообщить об этом.

3.1.13. Если выделяется только часть нужного текста, то текст не вносится.

3.1.14. Поля с символами, например, №, размечаются без номера, кроме случаев, когда выделить без номера не получается.

3.1.15. Если в процессе заполнения произошло что-то не описанное в инструкции, сообщить об этом.
3.1. Разметка документов роботом

3.2.1. Чтобы включить робота для разметки документов, нужно выбрать документы и нажать кнопку «Обновить разметку»
3.2.2. Когда робот разметит документы, то строчка подсветится желтым цветом и статус разметки станет «Размечено ApRbot»
4. Создание нового типа документа
4.1. Чтобы создать новый тип документа, нужно на странице «Типы документов» нажать на кнопку «Добавить тип документа +»
4.2. Далее откроется интерфейс по созданию и редактированию типов документов. В строчке «Название типа документа» вводим имя типа документа
4.3. Чтобы ввести название поля, дважды щелкните по нему
4.4. Выберите тип поля из выпадающего списка
4.5. Чтобы добавить новое поле, наведите курсор слева на строчку, над или под которой требуется добавить поле, пока не увидите иконку +. Щелкните, чтобы добавить новое поле.
4.6. Чтобы добавить новой блок, наведите курсор слева на последнюю строку, под которой требуется добавить блок, пока не увидите иконку +. Щелкните и выберите добавить новой блок.
4.7. Чтобы переименовать блок, щелкните на иконку редактирования. В всплывающем окне введите имя блока.
4.8. Чтобы превратить блок из списочного в табличный, включите «Повторяемый блок»
4.9. После завершения работы, для сохранения результатов нужно нажать кнопку «Сохранить изменения»
5. Формулы
5.1. Создание формулы на странице «Редактирование типа документов»

5.1.1. Чтобы добавить формулу, нужно на странице «Редактирование типа документов» нажать на иконку fx
5.1.2. Далее откроется форма по созданию формул
5.1.3. В строчке вводим название поля или выбираем его из списка ниже. Вводим операцию
5.1.4. После завершения, нажимаем галочку или enter
5.2. Создание формулы на странице «Список документов»

5.2.1. Чтобы добавить формулу на странице «Список документов», нужно нажать на поле
5.2.2. Далее откроется форма, в которой нужно ввести формулу
5.2.3. После завершения, нажимаем галочку или enter. На странице «Список документов» появилась формула
6. Комплекты
В комплект документов можно включить несколько документов.

6.1. Чтобы задать комплект документу щелкните на пустое поле комплекта и из выпадающего меню выберите нужный комплект
6.2. Чтобы редактировать название или удалить комплект, в выпадающем меню наведите курсор на нужный комплект пока не увидите троеточие, нажмите на него
6.3. Чтобы создать новый комплект в поиске введите его название и нажмите «Создать»
6.4. Чтобы переключиться в Редакторе документов между несколькими документами комплекта, нужно нажать соответствующую вкладку
в столбце «Документы»
6.5. Чтобы переключиться в Аннотаторе между несколькими документами комплекта, нужно нажать соответствующую вкладку
в навигационном меню