Настройка получения событий с ящиком Контур.Диадок
Статья описывает настройку получения событий Контур.Диадок для OSGi/Alfresco-архитектуры. Принимающая часть сверена с ecos-edi-integration:1.9.0 (ecos-edi-commons:2.15.0-SNAPSHOT).
Бандл провайдера получает события из Диадока и преобразует их в универсальную структуру Event. Связующий бандл ecos-edi-integration принимает эти события через Camel и обрабатывает документы, подписи и пакеты для сохранения в Alfresco.
Примечание
Источники данных, авторизационные данные, формы ящиков и отправляющие синхронизации предоставляются другими компонентами. Приведённые ниже формы и расположение журналов относятся к примеру настройки; сверяйте их с совместимой версией микросервиса integrations и бандла провайдера. Параметры расписания, блокировки и лага определяются отправляющей синхронизацией.
1. Создание DataSource до ЭДО провайдера
Для подключения к API провайдера создайте источник данных с URL выбранного контура.
Описание работы DataSource смотрите в дочерних статьях раздела REST Data Source Он создается через журнал Источники данных (Рабочее пространство «Раздел администратора» - Интеграция).
Для начала проясним, нас интересует в большинстве случаев - REST DataSource, так как большинство ЭДО провайдеров предоставляют именно HTTP API. Требования к DataSource ЭДО провайдера, отличного от Контур.Диадок - смотрите в соответствующих статьях. Предоставляю пример настроенного DataSource для продуктивного Контур.Диадок:
Как несложно заметить, заполнены только обязательные поля (Id, Name) и URL. Именно на URL смотрит интеграция при запросе.
Примеры заполнения URL и расшифровка:
https://diadoc-api.kontur.ru - продуктивный Контур.Диадок, указанный на скрине выше.
https://diadoc-api-test.kontur.ru - тестовый Контур.Диадок.
https://test-edi-api.kontur.ru - тестовый Контур.EDI.
https://courier-demo-api.esphere.ru - тестовый Сфера.Курьер (Корус).
https://courier-api.esphere.ru - продуктивный Сфера.Курьер (Корус).
Для другого ЭДО-провайдера используйте источник данных, поддерживаемый его бандлом.
2. Создание Credentials для доступа к ЭДО провайдеру по API
По аналогии с Data Sources, нужно так же создать запись в системном журнале Credentials.
Пример заполнения авторизационных данных для тестового ящика (Id — произвольный):
3. Создание ящика с информацией об ЭДО провайдере
Заходим в журнал Конфигурация ящиков ЭДО (EDI boxes configuration) (Рабочее пространство «Раздел администратора» - Интеграция) и создаем там запись о нашем ящике.
Пример:
В конфигурации ящика выберите провайдера Контур. Пример списка провайдеров в форме:
В полях URL и Авторизационные данные выберите созданные ранее источник данных и credentials.
В ecos-edi-integration:1.9.0 зарегистрированы обработчики Контур, Корус и СБИС. Наличие обработчика в принимающем бандле не определяет набор операций API соответствующего провайдера или состав списка в форме.
После этого - вставляем идентификатор ящика и ключ разработчика.
Набор дополнительных реквизитов зависит от бандла провайдера и версии формы.
4. Настройка интеграции с ЭДО провайдером в рамках ящика
В журнале Синхронизации (Рабочее пространство «Раздел администратора» — Интеграция) создайте запись интеграции ЭДО. Пример формы:
Идентификатор и наименование - произвольные.
Поля Включена и Необходимо перезапустить? относятся к управлению отправляющей синхронизацией в показанном примере. Их наличие и поведение зависят от версии микросервиса.
В разделе Базовая конфигурация - необходимо выбрать ящик из пункта 3, и указать время блокировки и время лага в миллисекундах.
Время наложения блокировки задаётся в отправляющем компоненте для управления конкурирующими запусками. Ключ блокировки, длительность по умолчанию и поведение при занятой блокировке необходимо уточнять для используемой версии исполнителя синхронизации; принимающий бандл ecos-edi-integration их не определяет.
Время лага используется отправляющей синхронизацией для задержки обработки свежих событий. Алгоритм фильтрации и значение по умолчанию определяются её реализацией. Значение 60000 мс (60 секунд) можно использовать как исходную рекомендацию для тестового стенда, если оно соответствует реализации провайдера.
В разделе Конфигурация расписания показаны параметры планировщика отправляющей синхронизации.
Назначение параметров приведено ниже. Поддержку этих полей, их приоритет и значения по умолчанию проверяйте по версии исполнителя синхронизации:
Атрибут |
Логика работы |
|---|---|
|
Cron-выражение расписания. Правила проверки выражения и перехода к периодическому режиму определяются исполнителем синхронизации. |
|
Период запуска в миллисекундах для периодического режима. |
|
Начальная задержка в миллисекундах. Её применимость к выбранному виду триггера зависит от реализации планировщика. |
|
При прямом включении |
В разделе Конфигурация персистентности задаётся получатель событий:
Атрибут |
Описание |
|---|---|
|
Для штатного обработчика |
Список параметров |
Если поле поддерживается отправляющей синхронизацией, способ передачи параметров необходимо проверить в её реализации и совместимой версии |
5. Подключение и проверка обработки
Для этой архитектуры в микросервисе должны быть подключены совместимые OSGi-бандлы провайдера Диадока и связующей библиотеки ecos-edi-integration. Активатор связующего бандла создаёт и запускает Camel-контекст; при остановке бандла контекст останавливается.
Стандартная цепочка приёма:
direct-vm:ecosEventsReceiveVmRoute
-> direct:ecosEventsRedistributesRoute
-> direct:ecosCommonEventRoute
Для обработки Event должен содержать тип провайдера, соответствующий зарегистрированному ProviderHandler, и непустой идентификатор собственного ящика в ourId.attributes.boxId. При отсутствии типа, обработчика или идентификатора ящика процессор выбрасывает IllegalArgumentException.
Перед обработкой документов маршрут применяет настройку inboundPackagesProcessing:
Для внутреннего пакета с
counterpartyId.attributes.internal=trueналичие контрагента не проверяется этим фильтром.В режиме
BOX_IDневнутреннее событие пропускается, если контрагент не найден. Поиск идёт черезalfresco/counterpartyByBoxIdс собственнымboxId,counterpartyBoxIdи типом провайдера.При остальных значениях ограничение по наличию контрагента не применяется. Это не гарантирует успешного завершения последующей обработки.
В этой версии связующего бандла настройка режима читается из Alfresco и кешируется на пять минут. Для проверки подключения убедитесь, что событие дошло до входного маршрута, прошло фильтр и было передано обработчику. При BOX_ID отдельно проверьте сопоставление контрагента и идентификаторов ящиков; пропуск события отражается в журнале сообщений.