Перейти к содержанию
+7 (800) 234-36-06 IT.encode@encode.one
Скачать в PDF

Введение

Encode Track Line API представляет собой серверное программное обеспечение для централизованного управления производственными линиями. Система разработана для координации и мониторинга производственных процессов в режиме реального времени.

Ключевые возможности:

  • Централизованное управление программным обеспечением Encode Track Line на производственных линиях
  • Мониторинг статусов выполнения в реальном времени
  • Интеграция с системами уровня L3 через HTTP API

Начало работы

Доступ к веб-интерфейсу системы

Подключение к серверу

Encode Track Line API предоставляет веб-интерфейс для управления и мониторинга через протокол HTTP. Для доступа используйте любой современный веб-браузер (Chrome, Firefox, Edge, Safari).

URL для доступа

  • Локальный доступ: http://localhost:3000
  • Удаленный доступ: http://<IP-адрес-сервера>:3000

Важно: Используйте именно протокол http:// при вводе адреса, так как система работает по стандартному HTTP-протоколу.

Перед подключением проверьте:

  • Сервер Encode Track Line API запущен и работает
  • IP-адрес сервера доступен в вашей сети
  • Порт 3000 открыт и не заблокирован файерволом
  • Нет конфликтов с другими сервисами на порту 3000
  • Ваш браузер имеет доступ к серверу через указанный порт

Настройка производственных линий

Добавление новой производственной линии

etl_api_create_conf.png

  1. В верхней навигационной панели выберите раздел "Настройки"
  2. В левом меню навигации нажмите "Добавить линию"
  3. В открывшейся форме заполните следующие поля:
    • Наименование линии: уникальное название для идентификации линии
    • Адрес: IP-адрес или доменное имя сервера базы данных линии
    • Порт: порт для подключения к базе данных
    • База данных: название базы данных линии
    • Диалект: тип СУБД (обычно PostgreSQL)
    • Имя пользователя: логин для доступа к базе данных
    • Пароль: пароль для доступа к базе данных
  4. После заполнения всех полей нажмите кнопку "Сохранить"

Редактирование настроек существующей линии

etl_api_edit_conf

  1. Перейдите в раздел "Настройки"
  2. В левом меню выберите нужную линию из списка существующих
  3. В открывшейся форме внесите необходимые изменения
  4. Нажмите "Сохранить" для применения изменений

Работа с производственными линиями

Просмотр и управление заданиями

etl_api_view_fabric_line

  1. Перейдите в раздел "Управление" через верхнее меню
  2. В левом меню выберите интересующую производственную линию
  3. В основном окне отобразится подробная информация:
    • Список всех заданий на линии
    • Детальная информация по каждому заданию
    • Текущие статусы выполнения заданий
    • Временные метки и другие производственные параметры

Мониторинг API-транзакций

Данный интерфейс позволяет отслеживать все взаимодействия между системами L3 и производственными линиями в режиме реального времени.

etl_api_transaction

  1. В разделе "Управление" выберите пункт "Транзакции" в левом меню
  2. Для каждой транзакции отображаются:
    • уникальный идентификатор;
    • вызываемый метод;
    • дата и время создания и обновления;
    • статус;
    • описание статуса;

Статусы транзакций:

  • Success — запрос выполнен успешно;
  • In Progress — запрос находится в процессе выполнения;
  • Error — при выполнении произошла ошибка.

Настройки системы

Режимы работы Encode TrackLine API

В разделе «Настройки» → «Режимы» доступны режимы работы системы, позволяющие управлять взаимодействием с производственными линиями и дополнительными сервисами.

Режимы включаются и отключаются с помощью переключателей.

Доступны следующие режимы:

  • Обмен данными с линиями.
  • Проксирование лицензии.
  • Локальный сервис обновлений.

api_operation_modes

Обмен данными с линиями

Функционал

Режим обмена данными с линиями обеспечивает централизованное взаимодействие между системой уровня L3, сервером ETL API и производственными линиями, включающими одну или несколько станций с установленным ПО ETL2.

Функционал включает:

  • передачу заданий от системы уровня L3 на производственные линии через ETL API;
  • централизованное управление заданиями на станциях производственной линии;
  • поддержка типов станций в составе производственной линии:

  • CENTRAL — центральная станция, отвечает за синхронизацию заданий и управление другими станциями;

  • ADDITIONAL — дополнительная станция, может работать совместно с центральной станцией или параллельно;

  • передачу результатов выполнения заданий в систему уровня L3;

  • выполнение команд управления заданиями:

  • запуск задания (task:start);

  • остановка задания (task:stop);
  • формирование и отправка отчёта (task:report);

  • возможность запуска задания (task:start) в режиме «только чтение» (параметр readonly);

Порядок управления станцией

  1. Перейдите в раздел «Настройки» → «Режимы» и включите параметр «Обмен данными с линиями».
  2. Откройте раздел «Управление» → «Производственные линии».
  3. Выберите нужную производственную линию.
  4. Перейдите на вкладку «Станции».
  5. Нажмите на кнопку «Синхронизировать»
  6. В строке нужной станции, нажмите кнопку в виде стрелки «Отправить команду».
  7. В открывшемся модальном окне выбрать команду:

    • task: start — запуск задания; a. доступен параметр readonly — запуск задания в режиме «только чтение»;

    • task: stop — остановка задания;

    • task: report — отправка отчёта по заданию.

station_management_commands

  • В параметре task_id выбрать задание, к которому применяется команда
    (доступно для команд task: start и task: report).

select_tasks_id 8. Нажмите «Отправить».

Динамическая подкачка кодов

Функционал

Динамическая подкачка кодов обеспечивает автоматическое получение дополнительных кодов в процессе выполнения задания сериализации без предварительного заказа кодов.

Функционал включает:

  • автоматическое инициирование запроса при недостатке кодов;
  • получение кодов через ETL API и систему уровня L3;
  • загрузку полученных кодов в базу данных линии;

Принцип работы

  1. ETL API направляет запрос в систему L3 на получение дополнительного пакета кодов.
  2. Система L3:

  3. резервирует необходимое количество кодов;

  4. формирует пакет кодов;
  5. передаёт его в ETL API.

  6. ETL API:

  7. принимает пакет кодов;

  8. записывает его в базу данных линии.

Проксирование лицензии

Функционал

Режим проксирования лицензии обеспечивает использование лицензии через сервер ETL API в случаях, когда на станции отсутствует доступ к интернету, а у ETL API он есть.

Функционал включает:

  • предоставление доступа к лицензии через сервер ETL API;
  • централизованную проверку наличия действующей лицензии;
  • передачу лицензии от сервера ETL API к станции по запросу;
  • возможность работы станции без прямого подключения к внешним сервисам лицензирования;
  • поддержку работы системы в изолированной инфраструктуре.  

Принцип работы

  1. ETL API направляет запрос на центральный сервер для получения информации о лицензии.
  2. Центральный сервер:

    • проверяет наличие действующей лицензии;
    • формирует ответ о статусе лицензии;
    • передаёт результат в ETL API.
  3. ETL API:

    • принимает ответ от сервера лицензирования;
    • передаёт информацию о лицензии в ETL2.

Локальный сервис обновлений

Функционал

Режим локального сервиса обновлений обеспечивает обновление системы Encode TrackLine в инфраструктуре без прямого доступа к интернету.

Функционал включает:

  • загрузку обновлений с внешнего сервера на локальный сервер;
  • распространение обновлений внутри локальной сети;
  • возможность работы ETL API и станций без прямого доступа к интернету;
  • управление доступными версиями программного обеспечения для обновления станций;
  • централизованный контроль версий, разрешённых к установке на производственных линиях;
  • управление процессом обновления через автоматическую и ручную синхронизацию.
  • ручную загрузку дистрибутивов обновлений через интерфейс системы.
  • использование локального сервера обновлений для хранения и распространения дистрибутивов;

Принцип работы

  1. На стороне клиента разворачивается локальный сервер обновлений.
  2. Локальный сервер получает дистрибутивы обновлений с внешнего сервера по интернету или архиву.
  3. В интерфейсе ETL API отображаются доступные версии ПО по веткам (например, ci, main) и платформам (Linux, Windows).
  4. Для каждой версии используется переключатель, определяющий возможность её установки на станциях производственной линии.
  5. Станции получают обновления только тех версий, для которых разрешено обновление.
  6. Обновления применяются без необходимости прямого подключения к интернету.

Загрузка архива обновления

Кнопка «Загрузить архив» предназначена для ручной загрузки дистрибутивов обновлений в локальный сервис.

При загрузке файла:

• выполняется проверка корректности содержимого архива;
• при успешной загрузке версия добавляется в список доступных.

После загрузки:

• версия отображается в соответствующей ветке и платформе;
• для версии можно включить разрешение на установку с помощью переключателя.

Ограничение версий обновления

Доступность обновления определяется состоянием переключателей версий:

  • если версия включена — обновление до данной версии разрешено;
  • если версия отключена — обновление до неё недоступно;
  • станции могут обновляться только для максимально разрешённых версий.

Пример:

  • версия 3.0.7 — включена;
  • версия 3.0.11 — отключена;

→ станции смогут обновиться до версии 3.0.7, но не смогут обновиться до версии 3.0.11.

local_update_service

Синхронизация обновлений

Доступны два режима синхронизации:

  • автоматическая синхронизация — выполняется по расписанию в ночное время;
  • ручная синхронизация — запускается пользователем по кнопке.

Ручная синхронизация позволяет применить обновления без ожидания планового запуска.