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

Введение.

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

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

Установка Entaxy.

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

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

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

  1. Для того чтобы отправить\получить сообщения необходимо создать профили, роли систем, а также входной\выходной коннекторы.

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

    system health

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

    hawtio logo

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

См. также - Управление профилями в шине, Профили внешних систем.

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

    ui add profile

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

    system profile

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

    system profile create

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

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

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

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

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

    system profile name
    system profile done

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

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

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

См. также Управление коннекторами в шине, Коннекторы.

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

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

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

    add connector button

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

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

    file conn in
    file conn in properties

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

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

    • response - обработка ответа;

    • entaxy - определение целевой системы;

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

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

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

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

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

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

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

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

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

    Подробнее о теге <set-destination> можно узнать здесь - set-destination.

    Для редактирования параметра Pre-Route нажимаем кнопку Edit

    pre route

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

    set destination
    file conn in done
    file connector in

Создание выходного файлового коннектора системы 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. В навигационном меню найдите раздел Ресурсы (Resources). Подробнее о ресурсах вы можете прочитать здесь.

  2. Внутри раздела Ресурсы найдите подраздел entaxy-file и перейдите на вкладку Resources.

    resources entaxy files

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

    json text

  4. Внутри "entaxy-file" найдите папку системы 1: "system1.file-connector-in.main"

    entaxy file connector1

  5. Загрузите ваш тестовый файл "test.json" в папку "system1.file-connector-in.main"

    entaxy file json

  6. Далее, перейдите в папку "system2.file-connector-out.main". Проверьте наличие файла внутри этой папки, чтобы удостовериться, что данные успешно передались.

    entaxy file json out

  7. Проверьте папку "system1.file-connector-in.main" и убедитесь, что она теперь пуста, так как данные были успешно перенесены в систему 2.

Настройка взаимодействия систем через универсальный сервис (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.

    file connector in legacy

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

    system1 uniform in choose step1
    system1 uniform in choose step2
    system1 in uniform

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

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

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

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

    uniform passive out step1
    uniform passive out step2

  4. Для корректного выбора выходного коннектора в зависимости от типа входного коннектора, необходимо внести изменения в свойства выходного профиля принимающей системы 2.

    Для этого перейдите на вкладку Properties, затем в разделе out-flow отредактируйте поле "Output connector selector". Подробнее о параметре "Output connector selector" можно узнать здесь - connector-selector.

    outputoutconnector

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

    useonlyconnector

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

Для того чтобы запустить обмен сообщениями между системами можно использовать 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