Быстрый старт

Введение.

В этой инструкции описаны шаги для быстрой установки и старта использования Entaxy.

Будет выполнена установка, настройка и проверка взаимодействия двух систем через файловый и универсальный сервис.

Установка Entaxy.

Установку компактной версии можно выполнить по следующей инструкции: Установка компактной версии.

Настройка Entaxy после установки.

После установки Entaxy сразу готова к работе, имеет файловый и универсальный (legacy) коннектор и преднастроенный маршрут по умолчанию с подтверждением доставки сообщения. Для того чтобы отправить\получить сообщения необходимо создать профили, роли систем, а также входной\выходной коннекторы.

  1. Проверяем готовность системы Entaxy к работе. В браузере открываем: http://localhost:8181/system/health. При полной готовности система выдаст следующую информацию:

    system health

  2. Заходим в консоль управления. В браузере открываем: http://localhost:8181/hawtio/. Вводим username/password, по умолчанию: entaxy/entaxy

    entaxy login

Создаем профили систем.

  1. Переходим в раздел Профили и на вкладке Profiles нажимаем кнопку Add profile.

    ui add profile

    • На этапе создания профиля доступны две версии профиля - актуальная System profile и устаревшая System profile Legacy. Для включения всех новейших функций и возможностей рекомендуется использовать актуальную версию.

  2. Выбираем профиль System profile и нажимаем кнопку Next.

    system profile create

  3. В открывшемся окне видим перечень параметров:

    • *Factory Id - обязательное поле с предустановленным параметром common-system-profile.

    • *System Name - обязательное поле назначающее уникальное имя создаваемому профилю системы. Системное имя может быть любой уникальной строкой символов с минимальной длиной в 3 символа.

    • Description - необязательное поле для краткого описания или пояснения цели/функции системы.

  4. Заполняем требуемые поля: вводим название для системы 1, назовем ее, например, system1 и нажимаем кнопку Add.

    system profile name
    system profile done

  5. Повторяем те же действия для создания системы 2, называем ее, например, system2.

Настройка взаимодействия систем через файловый сервис

Создаем коннекторы систем. См. также Подробное описание коннектора.

Создание входного файлового коннектора системы 1.

  1. В разделе Профили выбираем профиль системы 1 - system1 и переходим на вкладку Connectors.

  2. На этом этапе доступно две версии коннекторов: файловый - создаваемый по кнопке Add Connector и универсальный (legacy) - создаваемый по кнопке Add Legacy Connector.

    add connector button

  3. Нажимаем кнопку Add connector.

  4. Для создания входного коннектора выбираем соответствующий коннектор file-connector-in и нажимаем кнопку Next.

    file conn in

  5. В открывшемся окне видим панель с перечнем разделов:

    • general - базовые настройки;

    • consumer - настройки параметров обмена сообщениями;

    • advanced - расширенные настройки;

    • common - универсальные настройки;

    • consumer (advanced) - расширенные параметры передачи сообщений;

    • filter - параметры фильтрации;

    • lock - параметры блокировки;

    • scheduler - параметры расписания;

    • sort - параметры сортировки.

  6. При создании входного коннектора в параметр базовых настроек Pre-Route необходимо вручную добавить endpoint с указанием названия принимающей системы с помощью тега <set-destination>System Name принимающей системы</set-destination>

  7. Редактируем параметр Pre-Route, нажимаем кнопку Edit

    pre route

  8. Вручную добавляем строку <set-destination>system2</set-destination> и нажимаем кнопку Save.

    set destination
    file conn in done

Создание выходного файлового коннектора системы 2.

  1. В разделе Профили выбираем профиль системы 2 - system2 и переходим на вкладку Connectors.

  2. Нажимаем кнопку Add connector.

  3. Для создания выходного коннектора выбираем соответствующий коннектор file-connector-out и нажимаем кнопку Next.

    file conn out

  4. Оставляем все параметры без изменений и нажимаем кнопку Add.

    file conn out step2
    file conn out done

Отправка и получение сообщений с использованием файловых коннекторов.

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

Инструкция и отправка тестовых сообщений

  1. Переходим в каталог /opt/karaf/data/shared, находим в нем папку системы 1 system1.file-connector-in.main

  2. Подготавливаем тестовое сообщение (например, создаем тестовый файл test.json)

    s1filemain

  3. Переходим в папку system1.file-connector-in.main и помещаем в нее тестовое сообщение (в нашем примере помещаем в папку файл test.json)

    s1filemain test

  4. Ждем несколько секунд, чтобы убедиться, что передача данных полностью осуществлена и тестовые данные отсутствуют в папке system1.file-connector-in.main

  5. Переходим в папку shared и убеждаемся в наличии в ней папки принимающей системы 2 system2.file-connector-out.main

    s2filemain

  6. Переходим в папку system2.file-connector-out.main и убеждаемся в присутствии в ней тестового сообщения (test.json)

    s2filemain test

Настройка взаимодействия систем через универсальный сервис (Legacy)

Создание логинов профилей систем.

  1. В разделе Profiles открываем профиль системы 1 system1 .

  2. Далее на вкладке Operations находим операцию createAccount и т.к. создаем логин для системы 1 system1 , то вводим login/password - system1/system1.

  3. Нажимаем кнопку Execute.

  4. Аналогичные действия выполняем для второй системы введя login/password - system2/system2.

    account system2

Создание коннекторов систем.

Создание входного универсального коннектора системы 1.

  1. В разделе Профили выбираем профиль системы 1 - system1 и переходим на вкладку Connectors.

  2. Нажимаем кнопку Add Legacy Connector.

  3. Для создания входного коннектора выбираем соответствующий коннектор uniform-service-passive-in-connector и нажимаем кнопку Next.

    system1 in uniform

Создание выходного универсального коннектора системы 2.

  1. В разделе Профили выбираем профиль системы 2 - system2 и переходим на вкладку Connectors.

  2. Нажимаем кнопку Add Legacy Connector.

  3. Для создания входного коннектора выбираем соответствующий коннектор uniform-service-passive-out-connector и нажимаем кнопку Next.

  4. Для корректного выбора выходного коннектора по типу входного в свойствах выходного профиля принимающей системы 2 на вкладке Properties в параметре out-flow редактируем поле *Output connector selector.

    outputoutconnector

  5. Нажимаем кнопку Edit и меняем тег <use-the-only-connector /> на <use-the-only-connector>false</use-the-only-connector>, затем нажимаем кнопку Save, после закрытия окна редактирования вновь нажимаем кнопку Save на вкладке Properties.

    useonlyconnector
    system2 out uniform

Отправка и получение сообщений с использованием универсальных коннекторов.

Для того чтобы запустить обмен сообщениями между системами можно использовать SOAP-запросы в шину.

Инструменты выполнения запросов

У нас уже есть готовые тесты для Postman, с помощью которых можно быстро проверить обмен сообщениями.

  1. Устанавливаем и запускаем Postman.

  2. Скачиваем и импортируем коллекцию тестов (Окружение, Коллекция запросов)

Подробную инструкцию по установке и запуску всех тестов можно посмотреть по следующему адресу: инструкции по тестированию.

Отправка тестовых сообщений

Для отправки тестовых сообщений необходимо выполнить запросы из группы uniform-exchange-connector

  1. SEND - отправка тестового сообщения из системы 1 в систему 2 (если необходимо, то можно посмотреть как сообщение появилось в artemis)

  2. GET - получение тестового сообщения из системы 1 системой 2 (если необходимо, то можно посмотреть как сообщение было получено из artemis)

  3. ACK - отправка подтверждения получения сообщения системы 2 (иначе сообщение будет восстановлено)

    postman send
    postman get
    postman ack