Модули: различия между версиями

Материал из WiKi - UserSide
 
(не показано 50 промежуточных версий 2 участников)
Строка 1: Строка 1:
Модули к ERP "UserSide" делятся на внутренние и внешние. Внешние модули представляют собой - отдельные скрипты или программы, которые могут в т.ч. работать удаленно от основной системы (имея при этом соединение с базой данных системы), а внутренние уже заложены в систему и могут включаться/выключаться в разделе "[[Настройка - Основная|Настройка - Основная - Модули]]"
[[Modules_EN|en]] | [[Модули|ru]]
 
Модули к ERP "UserSide" делятся на внутренние и внешние. Внешние модули представляют собой - отдельные скрипты или программы, которые могут в т.ч. работать удаленно от основной системы (имея при этом соединение с базой данных системы), а внутренние уже заложены в систему и могут включаться/выключаться в разделе "[[Настройка - Модули]]"


Частые вопросы по модулям собраны в соответствующем разделе "[[Частые вопросы]]"
Частые вопросы по модулям собраны в соответствующем разделе "[[Частые вопросы]]"
Строка 5: Строка 7:
== Установка модулей. Общая информация для всех модулей ==
== Установка модулей. Общая информация для всех модулей ==


1. Для каждого модуля - выделите отдельный каталог. '''Абсолютно произвольный.''' САП "UserSide" напрямую не взаимодействует с модулями. Они полностью автономны и могут работать также на отдельных компьютерах в других подсетях.
1. Для каждого модуля - выделите отдельный каталог.
 
2. В процессе работы все модули ведут логи работы. Путь для каталога с логами указывается в файле конфигурации '''us_config.tmp'''. Крайне рекомендуется для каждого из модулей создавать отдельный каталог для логов, т.к. почти у всех модулей названия файлов-логов совпадают, что приведет к неразберихе. Не забудьте указать права на запись для этого каталога.
 
Распространенные названия файлов логов:
rep_alllog.txt - запуск и окончание всех циклов работы модуля с фиксацией времени
rep_logupd.txt - текущий цикл работы модуля
rep_mysql.txt -  все mysql команды, исполняемые модулем. Полезно при поиске ошибок.
pid.txt - файл-флаг по которому модуль ориентируется о том, что он уже запущен, для предотвращения повторного одновременного запуска


3. Для некоторых модулей требуется наличие дополнительных perl-пакетов ''(DBI, Socket, Encode и т.д.)'' Если у вас они не установлены - модуль выдаст ошибку при запуске и perl-пакет необходимо будет установить ''(с помощью CPAN или PPM)''.
2. В процессе работы все модули ведут логи работы. Путь для каталога с логами указывается в файле конфигурации. Крайне рекомендуется для каждого из модулей создавать отдельный каталог для логов. Не забудьте указать права на запись для этого каталога.


4. Модули служат, как правило, для постоянной работы. Их необходимо записать в системный cron/планировщик с частотой запуска 5-15 минут ''(в зависимости от нагрузки)''. При первом запуске рекомендуется запустить модуль вручную из системной консоли и убедиться, что ошибок не возникает и данные импортируются/обрабатываются корректно.
3. Модули служат, как правило, для постоянной работы. Их необходимо записать в системный cron с частотой запуска 5-15 минут ''(в зависимости от нагрузки)''. При первом запуске рекомендуется запустить модуль вручную из системной консоли и убедиться, что ошибок не возникает и данные импортируются/обрабатываются корректно.


== Общая информация для модулей взаимосвязи с биллингами ==
== Общая информация для модулей взаимосвязи с биллингами ==


1. Адрес абонента обрабатывается и фиксируется во встроенную в ERP "UserSide" систему учёта [[Улицы и дома|улиц и домов]]. В случае если необходимого дома нет в САП "UserSide" он будет создан. В случае если дом уже есть и добавлен в систему не средствами модуля, то он все-равно будет корректно обработан и прописан абонентам.  
1. Адрес абонента обрабатывается и фиксируется во встроенную в ERP "UserSide" систему учёта [[Адресная система|адресов]]. В случае если необходимого дома нет в ERP "UserSide" он будет создан. В случае если дом уже есть и добавлен в систему не средствами модуля, то он все-равно будет корректно обработан и прописан абонентам.  


2. Если абонент есть в ERP "UserSide", но не найден в биллинге, то он не удаляется из САП "UserSide", а помечается статусом "[[Статус абонентов|нет в биллинге]]". Так сделано в целях безопасности - в противном случае при сбое в обновлении - все абоненты могут быть удалены, т.к. не будут найдены в биллинге.
2. Если абонент есть в ERP "UserSide", но не найден в биллинге, то он не удаляется из ERP "UserSide", а помечается статусом "[[Статус абонентов|нет в биллинге]]". Так сделано в целях безопасности - в противном случае при сбое в обновлении - все абоненты могут быть удалены, т.к. не будут найдены в биллинге.


3. Если у абонента [[Активность|дата активности в интернете]] позже даты активности в сети, то дата активности в сети приравнивается к дате активности в интернете.
3. Если у абонента [[Активность|дата активности в интернете]] позже даты активности в сети, то дата активности в сети приравнивается к дате активности в интернете.
Строка 29: Строка 23:
4. При обновлении данных из биллинга - не все данные абонента обновляются - например ФИО, адрес, телефон могут оставаться без изменений. Загрузку таких данных можно включить в разделе "[[Настройка - Биллинги]]" для необходимого биллинга.
4. При обновлении данных из биллинга - не все данные абонента обновляются - например ФИО, адрес, телефон могут оставаться без изменений. Загрузку таких данных можно включить в разделе "[[Настройка - Биллинги]]" для необходимого биллинга.


5. Некоторые модули могут импортировать из биллинга пароль на авторизатор/вход в личный кабинет биллинга или пароль доступа в интернет. В этом случае такой пароль можно использовать как пароль входа в [[Личный кабинет|личный кабинет]] абонента в ERP "UserSide".
== Краткое описание модулей ==
Подробное описание указано на странице каждого из модулей
 
 
[[usm_billing]] - обеспечивает импорт информации об абонентах, адресах, тарифных планах и т.п. из биллинга в USERSIDE. Возможна поддержка собственного самописного биллинга. На базе этого модуля созданы отдельные модули для стандартных биллингов: [[usm_abills]], [[usm_bgbilling]], [[usm_hydra]], [[usm_lanbilling]], [[usm_nodeny]], [[usm_nodeny_plus]], [[usm_utm5]]
 
 
[[usm_asterisk]] - взаимодействует с телефонией Asterisk. При поступлении звонка - моментально ''(ещё до поднятия трубки)'' отображает на экране у оператора номер телефона звонящего и если этот номер телефона принадлежит абоненту - информацию об абоненте ''(ФИО, баланс, адрес, тарифный план, дата последней активности и т.п.)''. Если этот номер телефона принадлежит сотруднику - это будет указано. Если это неизвестный номер телефона - будет предложено создать карточку потенциального абонента.
 
 
[[usm_cabletest]] - '''периодически''' опрашивает коммутаторы и получает с них информацию кабельного тестера о длина включённых медных кабелей. Перечень поддерживаемых моделей коммутаторов указан на странице модуля.
 
 
[[usm_checker]] - '''периодически''' опрашивает ''(многопоточно пингует)'' активное сетевое оборудование или абонентские устройства с целью выявления какое оборудование активно, а какое упало ''(или какие абоненты перестали быть активными)''.
 
 
[[usm_gps]] - принимает информацию от железных и софтовых gps-треккеров с целью отображения местоположения автотранспорта и сотрудников на карте покрытия. Позволяет понять кто ближе всего к аварии. Видно кто в какое время и где двигался. Видны нарушения скоростного режима автотранспорта и т.п. Список поддерживаемых протоколов треккеров указан на странице модуля.
 
 
[[usm_iferr]] - '''периодически''' опрашивает ''(по SNMP)'' счетчики ошибок на интерфейсах оборудования. Это позволяет видеть устройства с ошибками на интерфейсах ''(как в разрезе интерфейсов так и с количеством проблемных интерфейсов по каждому из устройств)''. Также строится дельта прироста ошибок за сутки и за неделю, что позволяет видеть устройства где проблемы продолжаются прямо сейчас.
 
 
[[usm_observer]] - '''периодически''' опрашивает ''(по SNMP)'' любое оборудование по любым параметрам и уведомляет ''(почта, sms и т.п.)'' об изменении параметров или выхода параметров за пределы. Позволяет гибко настроить любой мониторинг любых устройств: потух порт номер такой-то, сработал датчик сигнализации, начата работа от батарей, кончилась бумага в принтере и т.п.
 
 
[[usm_peleng]] - '''периодически''' опрашивает коммутаторы, получает с них FDB-таблицу и накапливает информацию по MAC-адресам в разрезе оборудования и его портов. Позволяет выявлять факты колец, флуда на портах, вирусов. Помогает находить подмены MAC-адресов. Возможно исключение из отображения uplink/downlink-портов и т.п. По MAC-адресу из USERSIDE подтягивается информация об абоненте или устройстве.
 
 
[[usm_pon]] - '''периодически''' [[PON|опрашивает OLT]], получает и накапливает информацию о включённых ONU. Уровень сигнала, дистанция до OLT, модель, вендор, описание, MAC, ID и т.д. Историей изменения уровня сигнала в разрезе ONU. По MAC-адресу/ID ONU из USERSIDE подтягивается информация об абоненте.
 
 
[[usm_radio]] - '''периодически''' [[Радио|опрашивает радиооборудование]] и получает список подключенных радиоабонентов. Уровень сигнала, MAC-адрес, скорость соединения и т.п. Перечень поддерживаемых вендоров указан на странице модуля. По MAC-адресу из USERSIDE подтягивается информация об абоненте или устройстве.
 
 
[[usm_stat]] - '''периодически''' запускается и фиксирует в базу факт [[Активность|активности]] абонентов на момент запуска. Это позволяет в дальнейшем видеть по каждому из абонентов в какие дни и часы он был активным в сети. Также фиксируется и общее количество активных абонентов на момент запуска модуля.


== Текущие версии модулей ==
== Текущие версии модулей ==
  [[us_asterisk]] - 0.1b.7
  [[usm_abills]] - 3.288.274
  [[us_bgbilling]] - 1.5.14
  [[usm_asterisk]] - 1.0.20
  [[us_control]] - 1.1.10
  [[usm_bgbilling]] - 3.288.104
  [[us_gps]] - 1.2.15
  [[usm_billing]] - 1.12.288
  [[us_hydra]] - 3.3.25
  [[usm_cabletest]] - 1.1.5
  [[us_ideco]] - 3.11.66
  [[usm_checker]] - 2.3.1
  [[us_lanbilling]] - 3.19.157
  [[usm_gps 2|usm_gps]] - 2.5.0
  [[us_mikbill]] - 3.8.25
  [[usm_hydra]] - 3.288.164
  [[us_nodeny]] - 3.22.190
  [[usm_iferr]] - 1.3.0
  [[us_nodeny_plus]] - 3.5.10
  [[usm_lanbilling]] - 3.288.297
  [[us_radio]] - 1.0.1
  [[usm_nodeny]] - 3.288.248
  [[us_stat]] - 3.7.14
  [[usm_nodeny_plus]] - 3.288.73
  [[us_stg]] - 3.1.10
  [[usm_observer]] - 1.3.0
[[us_utm5]] - 3.26.434
  [[usm_peleng]] - 3.26.123
  [[usm_abills]] - 3.22.153
  [[usm_pon]] - 1.10.34
  [[usm_billing]] - 1.1.7
  [[usm_radio]] - 3.13.14
  [[usm_peleng]] - 3.21.110
  [[usm_stat]] - 3.10.26
  [[usm_ping]] - 3.17.62
  [[usm_utm5]] - 3.288.664
  [[usm_pon]] - 1.6.20

Текущая версия от 20:50, 2 июня 2024

en | ru

Модули к ERP "UserSide" делятся на внутренние и внешние. Внешние модули представляют собой - отдельные скрипты или программы, которые могут в т.ч. работать удаленно от основной системы (имея при этом соединение с базой данных системы), а внутренние уже заложены в систему и могут включаться/выключаться в разделе "Настройка - Модули"

Частые вопросы по модулям собраны в соответствующем разделе "Частые вопросы"

Установка модулей. Общая информация для всех модулей

1. Для каждого модуля - выделите отдельный каталог.

2. В процессе работы все модули ведут логи работы. Путь для каталога с логами указывается в файле конфигурации. Крайне рекомендуется для каждого из модулей создавать отдельный каталог для логов. Не забудьте указать права на запись для этого каталога.

3. Модули служат, как правило, для постоянной работы. Их необходимо записать в системный cron с частотой запуска 5-15 минут (в зависимости от нагрузки). При первом запуске рекомендуется запустить модуль вручную из системной консоли и убедиться, что ошибок не возникает и данные импортируются/обрабатываются корректно.

Общая информация для модулей взаимосвязи с биллингами

1. Адрес абонента обрабатывается и фиксируется во встроенную в ERP "UserSide" систему учёта адресов. В случае если необходимого дома нет в ERP "UserSide" он будет создан. В случае если дом уже есть и добавлен в систему не средствами модуля, то он все-равно будет корректно обработан и прописан абонентам.

2. Если абонент есть в ERP "UserSide", но не найден в биллинге, то он не удаляется из ERP "UserSide", а помечается статусом "нет в биллинге". Так сделано в целях безопасности - в противном случае при сбое в обновлении - все абоненты могут быть удалены, т.к. не будут найдены в биллинге.

3. Если у абонента дата активности в интернете позже даты активности в сети, то дата активности в сети приравнивается к дате активности в интернете.

4. При обновлении данных из биллинга - не все данные абонента обновляются - например ФИО, адрес, телефон могут оставаться без изменений. Загрузку таких данных можно включить в разделе "Настройка - Биллинги" для необходимого биллинга.

Краткое описание модулей

Подробное описание указано на странице каждого из модулей


usm_billing - обеспечивает импорт информации об абонентах, адресах, тарифных планах и т.п. из биллинга в USERSIDE. Возможна поддержка собственного самописного биллинга. На базе этого модуля созданы отдельные модули для стандартных биллингов: usm_abills, usm_bgbilling, usm_hydra, usm_lanbilling, usm_nodeny, usm_nodeny_plus, usm_utm5


usm_asterisk - взаимодействует с телефонией Asterisk. При поступлении звонка - моментально (ещё до поднятия трубки) отображает на экране у оператора номер телефона звонящего и если этот номер телефона принадлежит абоненту - информацию об абоненте (ФИО, баланс, адрес, тарифный план, дата последней активности и т.п.). Если этот номер телефона принадлежит сотруднику - это будет указано. Если это неизвестный номер телефона - будет предложено создать карточку потенциального абонента.


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


usm_checker - периодически опрашивает (многопоточно пингует) активное сетевое оборудование или абонентские устройства с целью выявления какое оборудование активно, а какое упало (или какие абоненты перестали быть активными).


usm_gps - принимает информацию от железных и софтовых gps-треккеров с целью отображения местоположения автотранспорта и сотрудников на карте покрытия. Позволяет понять кто ближе всего к аварии. Видно кто в какое время и где двигался. Видны нарушения скоростного режима автотранспорта и т.п. Список поддерживаемых протоколов треккеров указан на странице модуля.


usm_iferr - периодически опрашивает (по SNMP) счетчики ошибок на интерфейсах оборудования. Это позволяет видеть устройства с ошибками на интерфейсах (как в разрезе интерфейсов так и с количеством проблемных интерфейсов по каждому из устройств). Также строится дельта прироста ошибок за сутки и за неделю, что позволяет видеть устройства где проблемы продолжаются прямо сейчас.


usm_observer - периодически опрашивает (по SNMP) любое оборудование по любым параметрам и уведомляет (почта, sms и т.п.) об изменении параметров или выхода параметров за пределы. Позволяет гибко настроить любой мониторинг любых устройств: потух порт номер такой-то, сработал датчик сигнализации, начата работа от батарей, кончилась бумага в принтере и т.п.


usm_peleng - периодически опрашивает коммутаторы, получает с них FDB-таблицу и накапливает информацию по MAC-адресам в разрезе оборудования и его портов. Позволяет выявлять факты колец, флуда на портах, вирусов. Помогает находить подмены MAC-адресов. Возможно исключение из отображения uplink/downlink-портов и т.п. По MAC-адресу из USERSIDE подтягивается информация об абоненте или устройстве.


usm_pon - периодически опрашивает OLT, получает и накапливает информацию о включённых ONU. Уровень сигнала, дистанция до OLT, модель, вендор, описание, MAC, ID и т.д. Историей изменения уровня сигнала в разрезе ONU. По MAC-адресу/ID ONU из USERSIDE подтягивается информация об абоненте.


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


usm_stat - периодически запускается и фиксирует в базу факт активности абонентов на момент запуска. Это позволяет в дальнейшем видеть по каждому из абонентов в какие дни и часы он был активным в сети. Также фиксируется и общее количество активных абонентов на момент запуска модуля.

Текущие версии модулей

usm_abills - 3.288.274
usm_asterisk - 1.0.20
usm_bgbilling - 3.288.104
usm_billing - 1.12.288
usm_cabletest - 1.1.5
usm_checker - 2.3.1
usm_gps - 2.5.0
usm_hydra - 3.288.164
usm_iferr - 1.3.0
usm_lanbilling - 3.288.297
usm_nodeny - 3.288.248
usm_nodeny_plus - 3.288.73
usm_observer - 1.3.0
usm_peleng - 3.26.123
usm_pon - 1.10.34
usm_radio - 3.13.14
usm_stat - 3.10.26
usm_utm5 - 3.288.664