Руководство пользователя
Общие сведения
Руководство описывает порядок применения Докфактора: режимы работы, форматы входных и выходных данных, типовые сценарии использования и контроль результатов обработки. Документ адресован операторам учётных подразделений, администраторам информационных систем и разработчикам, выполняющим интеграцию.
Назначение
Докфактор предназначен для автоматизированного распознавания первичных бухгалтерских документов: универсального передаточного документа (УПД), товарной накладной по форме ТОРГ-12, счёта-фактуры и иных документов сходной структуры. Результат — структурированное представление документа в формате JSON, пригодное для передачи в учётные, архивные и иные прикладные системы.
Условия применения
| Условие | Описание |
|---|---|
| Установка | Программа установлена по «Руководству по установке и настройке». |
| Локальный сервер модели | Локальный сервер выполнения модели запущен и доступен по адресу из файла настройки. |
| Файлы модели | Файлы модели размещены в согласованном каталоге. |
| Доступ к каталогам | Есть доступ на чтение к каталогу входных файлов и на запись к каталогу результатов. |
Режимы работы
Докфактор поддерживает два независимых режима: режим командной строки и режим сетевой службы. Выбор режима определяется сценарием применения у заказчика.
Режим командной строки
Назначение
Режим командной строки предназначен для локального запуска обработки одним оператором, администратором или внешним сценарием автоматизации. Пользователь передаёт путь к файлу или каталогу и получает результат в виде файла JSON.
Обработка одного файла
Для обработки одного файла используется команда вида:
ocr путь_к_входному_файлу --output путь_к_файлу_результата
Программа выполняет полный цикл: подготовку страниц, классификацию документа, извлечение реквизитов и табличной части, нормализацию, проверку результата и автоматическое исправление типовых ошибок. Результат сохраняется в указанный файл.
Пакетная обработка
Для пакетной обработки указывается каталог с входными файлами:
ocr путь_к_каталогу_входных_файлов --output-dir путь_к_каталогу_результатов
Программа последовательно обрабатывает файлы каталога; для каждого создаётся файл результата с соответствующим именем.
Коды возврата
По завершении программа возвращает целочисленный код. Нулевой код — успешное завершение, ненулевой — ошибка обработки или отсутствие части входных данных. Подробные сведения выводятся в стандартный поток ошибок и в журнал работы.
Режим сетевой службы
Назначение
Режим сетевой службы предназначен для интеграции с внешними прикладными системами. Программа запускается как локальная служба организации и принимает документы по протоколу HTTP.
Состав операций
| Операция | Назначение |
|---|---|
| Проверка готовности | Возвращает состояние службы и готовность к приёму заданий. |
| Загрузка документа | Принимает файл и создаёт задание на обработку. |
| Получение состояния | Возвращает состояние задания: ожидает, обрабатывается, завершено, завершено с ошибкой. |
| Получение результата | Возвращает структурированный JSON с результатами распознавания и проверки. |
Типовой сценарий
- Внешняя система проверяет готовность службы и получает подтверждение.
- Внешняя система передаёт файл в операцию загрузки и получает идентификатор задания.
- Внешняя система периодически опрашивает состояние задания по идентификатору.
- После состояния «завершено» внешняя система запрашивает результат — структурированный JSON.
Адрес и порт
Адрес и порт службы определяет администратор заказчика при запуске. Взаимодействие идёт в пределах локальной сети; доступ из внешних сетей возможен только при наличии средств защиты, развёрнутых заказчиком.
Формат входных данных
На вход принимаются электронные образы документов.
| Формат | Описание |
|---|---|
| Электронный документ, одна или несколько страниц. | |
| JPEG | Растровое изображение страницы. |
| PNG | Растровое изображение страницы. |
| TIFF | Растровое изображение, в том числе многостраничное. |
Формат выходных данных
Результат — структурированный JSON.
| Группа сведений | Содержание |
|---|---|
| Реквизиты документа | Вид документа, номер, дата, основание при наличии. |
| Стороны | Наименование, ИНН, КПП и иные реквизиты продавца и покупателя. |
| Строки таблицы | Наименование, количество, цена, сумма без налога, ставка и сумма налога, сумма с налогом. |
| Итоги | Сумма без налога, сумма налога, сумма с налогом. |
| Служебные сведения | Статус проверки, предупреждения, применённые автоисправления. |
Контроль результата
Докфактор выполняет встроенную проверку результата: выявляет подмены цифр, смешение колонок, неверные ставки налога, нарушения арифметики строк и итогов, ошибочное определение сторон. Результаты помещаются в служебные сведения JSON.
Перед использованием данных в учётных операциях рекомендуется анализировать статус проверки и перечень предупреждений. При существенных предупреждениях — выполнить ручную сверку результата с исходным документом.
Журналы работы
Программа ведёт журналы в каталоге, согласованном с файлом настройки. Журналы содержат сведения о принятых файлах, состоянии заданий и ошибках. Состав и расположение журналов настраивает администратор заказчика.
Действия в нештатных ситуациях
- При предупреждениях о нарушении арифметики или контрольной суммы ИНН — выполнить визуальную сверку соответствующих реквизитов с исходным документом.
- Если задание сетевой службы долго остаётся в обработке — обратиться к администратору для проверки службы и локального сервера модели.
- Если задание завершается с ошибкой — сохранить файл документа и сведения об ошибке и обратиться в техническую поддержку.