Opened 4 years ago

Closed 4 years ago

#496 closed улучшение (готово)

РЭ: Недостаточно общей информации о плате VE-01/02

Reported by: san Owned by: Vladimir
Priority: critical Component: Руководство по эксплуатации
Keywords: Cc: alx, andrei

Description

Общаясь с пользователями нашего оборудования в рамках техподдержки, могу отметить что мало кто может сам разобраться c настройкой платы VE-01/02, обычно пользователи не понимают "как это работает", т.е. самых общих вещей: как обрабатывается входящий вызов, исходящий, зачем нужны регулярные выражения и т.д..
Я попытался взглянуть на описание платы в РЭ глазами пользователя, и я думаю проблема непонимания начинается здесь.
Структура описания:

7 УПРАВЛЕНИЕ ГОЛОСОВЫМ ШЛЮЗОМ VE-xx 
7.1 Общая информация 
7.2 Особенности обновления платы VE-01
7.3... 7.8 Вкладки и окончания 
7.9 Настройка платы VE-02 (VoIP шлюз + внешние интерфейсы) 

Раздел 7.1 состоит из:

  • краткое описание назначения платы
  • краткое отступление для описания протокола Sip
  • краткое описание назначения вкладок

На мой взгляд этой общей информации пользователю явно недостаточно, для понимания общих принципов работы платы.

Предлагаю добавить в раздел 7.1:

  1. Функциональную схему платы с описанием основных блоков (часть информации можно взять отсюда: https://trac.adc-line.ru/sip_ua/wiki/FunctionsSipProxy )
  2. Алгоритм обработки входящих вызовов (первый проход поиска, второй проход, роутинг, sip-пользователи (частично описано в РЭ "7.4.30 Тип окончания – PRI / Выбор канального окончания при входящем вызове")
  3. Обработка исходящих вызовов (роутинг, ... ?)
  4. Регулярные выражения, зачем они нужны плате, примеры, и различия при использовании в разных настройках(роутинг, рег.выражение набора, рег. выражение вызова) Частично информация есть здесь https://trac.adc-line.ru/mc-04/wiki/Mc04regexp

Change History (7)

in reply to:  description comment:1 by alx, 4 years ago

Replying to san:

На мой взгляд этой общей информации пользователю явно недостаточно, для понимания общих принципов работы платы.

Общее описание написано очень давно. Более двух лет назад общая архитектура плат существенно изменилась - в ней появились прокси-сервер и сервер регистрации, появились принципиально новые функции и возможности. В основном предложения данного тикета дублируют другие уже существующие тикеты (см. например #100, #163).

Вот мысль поглубже описать использование регулярных выражений, кажется, новая. Я поддерживаю.

первый проход поиска, второй проход, ...(частично описано в РЭ "7.4.30 Тип окончания – PRI / ...

А вот это странно... Почему описание описание алгоритма поиска свободного канального окончания помещено в раздел одного из типов окончаний (PRI)? У читателя может создаться впечатление, что только для окончаний типа PRI этот алгоритм и действует... Сейчас напишу по этому поводу новый тикет...

comment:2 by san, 4 years ago

дублируют

#100 пожалуй сюда не относится, он говорит только об интерфейсе настройки Sip-пользователей, а в #163, да есть предложение описать архитектуру платы.

in reply to:  2 comment:3 by alx, 4 years ago

Replying to san:

#100 пожалуй сюда не относится, он говорит только об интерфейсе настройки Sip-пользователей,

Ты предложил описать "Алгоритм обработки входящих вызовов". Если кратко, то этот алгоритм такой: вызов принимается прокси-сервером, прокси сначала ищет вызываемого среди SIP-пользователей, и затем, если в списке пользователей он не найден, направляет вызов в шлюз. Согласись, преждевременно описавать этот алгоритм, если ничего еще не написано ни о существовании SIP-пользователей, ни о существовании прокси-сервера. Как я только что писал в #497, логично сначала давать определение некоего понятия, а только потом им оперировать. В применении к данной ситуации было бы логично сначала написать, что в плате есть прокси-сервер (#163), а уже потом описывать какие-то детали его работы.

Аналогично, сначала имеет смысл рассказать о том, что в плате есть сервер регистрации (#100), а уже потом писать, что прокси-сервер ищет вызываемого среди зарегистрированных пользователей.

Аналогично о маршрутизации: не рассказав читателю о том, что в прокси-сервере есть таблица маршрутов (#101), нелогично описывать, как работает роутинг. Последовательность должна быть в изложении... :)

comment:4 by san, 4 years ago

Согласись, преждевременно описывать этот алгоритм, если ничего еще не написано ни о существовании SIP-пользователей.

Согласен.
На данный момент в описании присутствует описание вкладки Sip-пользователи, однако толком не дано определение кто это такие, т.е. формально требование #100 уже выполнено, интерфейс "упомянут", но пользователю не легче.

Последовательность должна быть в изложении

Я для того и создал тикет, предлагаю описать сначала основные вещи, в том числе и просто что они существуют сказать(п.1).

in reply to:  4 comment:5 by alx, 4 years ago

Replying to san:

На данный момент в описании присутствует описание вкладки Sip-пользователи, однако толком не дано определение кто это такие, т.е. формально требование #100 уже выполнено, интерфейс "упомянут", но пользователю не легче.

Очевидно, поэтому тикет и не закрыт...

Только сейчас обратил внимание: в тикете #100 говорится не о том, что появились пользователи SIP, а о том, что там изменился интерфейс.

Я для того и создал тикет, предлагаю описать сначала основные вещи, в том числе и просто что они существуют сказать(п.1).

С этим я согласен. Я лишь напомнил, что такие тикеты уже есть...

comment:6 by Vladimir, 4 years ago

В РЭ-40 (на сайте) структура описания такая:
7 УПРАВЛЕНИЕ ГОЛОСОВЫМ ШЛЮЗОМ VE-01/ VE-02 193
7.1 Общая информация 193
7.1.1 Программно-аппаратная архитектура платы VE-01/VE-02 194
7.1.2 Регулярные выражения (описание шаблонов номеров) 195
7.1.3 Алгоритм поиска канального окончания при входящем вызове 197
7.1.4 Функция маршрутизации SIP в платах VE-01/VE-02 198
7.2 Вкладка Настройки 202
7.3 Особенности обновления платы VE-01 204
7.4 Вкладка SIP окончания 204

Информация по ссылкам
https://trac.adc-line.ru/sip_ua/wiki/FunctionsSipProxy
https://trac.adc-line.ru/mc-04/wiki/Mc04regexp
в РЭ-40 тоже была, тогда что ещё надо изменить в РЭ-41 по сравнению с РЭ-40 ?
Или уже можно закрыть этот тикет?

comment:7 by Vladimir, 4 years ago

Resolution: готово
Status: newclosed

Замечаний больше нет, поэтому закрываю этот тикет.

Note: See TracTickets for help on using tickets.