Endpoints

В этой статье описана работа с направлениями передачи данных (endpoints): от создания и настройки подключения до подключения объектов и автоматизации процесса ретрансляции.

Здесь вы узнаете:

• Как подключать объекты к endpoint

Как настроить автоматическое подключение новых объектов

Что такое endpoint

Endpoint — это направление передачи данных во внешнюю систему. В нём настраиваются параметры подключения: адрес сервера, порт, протокол передачи данных и параметры авторизации.

После создания endpoint к нему можно подключить один или несколько объектов.

Список endpoints

Чтобы открыть список endpoint, перейдите в раздел «Ретрансляция» → «Endpoints».

В этой вкладке отображаются все доступные направления передачи данных и их текущее состояние.

Здесь вы можете:

— создавать новые endpoints

— изменять настройки существующих endpoints

— подключать объекты

— настраивать автоматическое подключение новых объектов

— просматривать статистику передачи данных

— включать, отключать и удалять endpoints

Верхняя панель

На верхней панели доступны следующие действия:

1. Добавить — создание нового endpoint

2. Statistics — выбор периода для отображения статистики

3. Искать — поиск endpoint в таблице

4. Очистить фильтры — сброс всех фильтров

Выбор периода отображения статистики

Параметр Statistics влияет на отображение мини-графиков в колонках:

Err — ошибки
Отправка (Send) — отправка данных
Ack — подтверждённые пакеты

Мини-графики помогают быстро оценить состояние ретрансляции за выбранный период.

На графике отображаются:

— динамика показателя

— общее количество событий за выбранный период

При наведении курсора отображается информация по выбранной точке графика.

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

12 hours — последние 12 часов
Day — последние сутки
Week — последняя неделя
2 weeks — последние две недели
Month — последний месяц

Колонки таблицы Endpoints

Actions — доступные действия с endpoint

ID — уникальный идентификатор endpoint

Partner ID — идентификатор партнёра-владельца endpoint

Имя партнёра — название партнёра-владельца endpoint

Хост — IP-адрес или доменное имя внешнего сервера

Порт — порт подключения к внешнему серверу

Формат — используемый протокол передачи данных

Статистика / Объекты — количество объектов, подключённых к endpoint

Статистика / Активные — количество активных объектов, которые сейчас передают данные и находятся на связи

Статистика / Auto — количество договоров, для которых включено автоматическое добавление объектов

Статистика / Queue — количество пакетов в очереди на отправку

Статистика / Err — мини-график ошибок за выбранный период

Статистика / Отправка (Send) — мини-график попыток отправки за выбранный период

Статистика / Ack — мини-график принятых пакетов за выбранный период

On/off — состояние endpoint (включён или выключен)

Статус — состояние endpoint: активен, выключен или нет активных объектов

Uspw — данные авторизации (скрыто по умолчанию)

Testing — признак тестового endpoint. Доступен только администратору

TimeZone — часовой пояс

Комментарий — дополнительная информация

Speed Limit — максимальная скорость, передаваемая во внешнюю систему

Расписание — расписание работы ретрансляции

Mapping fields — настройки сопоставления полей для специальных форматов

Вы можете настроить, какие колонки с параметрами отображать в таблице.

Для этого:

1. Нажмите на стрелку

в заголовке любой колонки

2. Выберите пункт Columns

3. Отметьте галочками нужные колонки

4. Снимите галочки с тех колонок, которые не хотите отображать

В этом же меню доступны:

— сортировка по возрастанию

— сортировка по убыванию

— фильтрация данных

Действия с endpoint

В колонке «Действия» (Actions ) доступны следующие действия:

Вкл. или выкл. — включить или отключить endpoint

Редактировать — открыть форму для редактирования endpoint. Также можно дважды щёлкнуть по строке таблицы, чтобы открыть настройки endpoint

Auto add — настроить автоматическое подключение объектов

Статистика — открыть статистику по выбранному endpoint

Машины или объекты — открыть список подключённых объектов

Удалить — удалить endpoint

Как создать endpoint

1. Нажмите на верхней панели «Добавить»

2. Заполните параметры подключения

Основные параметры

Название — название endpoint

Хост — адрес внешнего сервера, на который будут отправляться данные

Порт — порт подключения внешней системы

Формат — протокол или формат передачи данных

Путь — дополнительный путь или URL-маршрут, если он требуется используемым протоколом

Uspw — данные авторизации для подключения к внешней системе

Time zone — часовой пояс, который будет использоваться по умолчанию для объектов данного endpoint

Speed Limit — максимальная скорость, которая будет передаваться во внешнюю систему

Галочка «Включено» — включение или отключение endpoint

Testing — позволяет создать тестовый endpoint. Параметр доступен только администраторам

Json config — дополнительные настройки подключения в формате JSON

Комментарий — произвольный комментарий для пользователей системы

Mapping fields — настройки сопоставления полей для специальных форматов передачи данных

Расписание — расписание, в течение которого разрешена передача данных через данный endpoint

3. Нажмите «Сохранить»

После сохранения endpoint станет доступен для подключения объектов.

Как редактировать endpoint

1. Нажмите кнопку «Редактировать»

в колонке действий или дважды щёлкните по строке endpoint

2. Измените необходимые параметры

3. Нажмите «Сохранить»

Изменения автоматически применяются ко всем объектам, которые используют этот endpoint.

Если система обнаружит endpoint с такими же параметрами, она предложит объединить их. Перед подтверждением внимательно проверьте настройки.

Если объединение не подтвердить, изменения не будут сохранены.

Как включить или отключить endpoint

Чтобы временно остановить или возобновить передачу данных:

1. Нажмите кнопку включения

или отключения

в колонке действий

Если endpoint отключён, все объекты, подключённые к нему, перестают передавать данные во внешнюю систему.

Как удалить endpoint

1. Нажмите кнопку удаления

в колонке действий

2. Подтвердите удаление

Перед удалением система покажет количество объектов, которые используют этот endpoint.

После удаления передача данных через endpoint будет полностью остановлена.

Объекты endpoint

Чтобы посмотреть объекты, подключённые к endpoint:

1. Найдите нужный endpoint

2. Нажмите кнопку «Машины/Объекты»

в колонке действий

Откроется список объектов, которые передают данные через выбранный endpoint.

Из этого окна можно:

— подключать новые объекты

— изменять параметры ретрансляции отдельных объектов

— временно отключать передачу данных

— удалять объекты из endpoint

Колонки списка объектов

Agent ID — идентификатор объекта

Машина — название объекта мониторинга

IMEI — уникальный идентификатор устройства

Договор — договор объекта

External ID — идентификатор объекта во внешней системе

On/off — включена или выключена ретрансляция объекта

Err — мини-график ошибок по объекту

Отправка (Send) — мини-график попыток отправки по объекту

Ack — мини-график принятых пакетов по объекту

Действия с объектами:

— включить или выключить объект в этом endpoint

— удалить объект из этого endpoint

Как добавить объекты

1. Нажмите в окне «Объекты/Машины» кнопку «Добавить»

2. Выберите один или несколько объектов

3. При необходимости измените External ID. По умолчанию в качестве External ID используется IMEI устройства

4. Нажмите «Добавить», чтобы подключить выбранные объекты к endpoint

Если список объектов большой, воспользуйтесь поиском сверху в поле «Искать» — введите название или номер объекта.

Как редактировать объект

1. Дважды щёлкните по объекту в списке

2. Внесите изменения в форму редактирования объекта

В форме можно изменить объектные параметры ретрансляции:

Endpoint — направление передачи данных, через которое объект отправляет информацию во внешнюю систему
External ID — идентификатор объекта во внешней системе
Чекбокс «Включено» — включает или отключает передачу данных только для выбранного объекта
Ограничение скорости — максимальная скорость, которая будет передаваться во внешнюю систему для этого объекта
Временная зона — часовой пояс, используемый для передачи данных этого объекта
Uspw — данные авторизации для данного объекта
Json config — дополнительные настройки ретрансляции в формате JSON
Расписание — расписание передачи данных для объекта.

Параметры Host, Port, Format и Path в этой форме изменить нельзя. Они наследуются от endpoint.

Если необходимо изменить подключение к внешней системе, откройте настройки endpoint или выберите другой endpoint.

3. Сохраните настройки

Автоматическое подключение объектов к endpoint

Функция Auto add позволяет автоматически подключать новые объекты к endpoint.

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

Как настроить Auto add

1. Нажмите кнопку Auto add

в колонке действий

2. Откроется окно, для включения автоматического добавления объектов список договоров. Нажмите «Добавить»

3. Выберите один или несколько договоров

4. Нажмите «Добавить»

После сохранения все новые объекты выбранных договоров будут автоматически подключаться к данному endpoint.