Modules EN

en | uk | ru

ERP "UserSide" modules are divided into internal and external modules. External modules are separate scripts or programs that can run remotely from the main system, provided they have a connection to the system database. Internal modules are built into the system and can be enabled or disabled in the "Settings - Modules" section.

Frequently asked questions about modules are collected in the "Frequently Asked Questions" section.

Installing modules. General information for all modules

1. Allocate a separate directory for each module.

2. During operation, all modules write logs. The log directory path is specified in the configuration file. It is strongly recommended to create a separate log directory for each module. Do not forget to grant write permissions for this directory.

3. Modules are usually intended for continuous operation. Add them to the system cron with a 5-15 minute run interval (depending on the load). On the first start, run the module manually from the system console and make sure there are no errors and the data is imported or processed correctly.

General information for billing integration modules

1. The customer address is processed and recorded in the address accounting system built into ERP "UserSide". If the required building is not present in ERP "UserSide", it will be created. If the building already exists and was not added by the module, it will still be processed correctly and assigned to customers.

2. If a customer exists in ERP "UserSide" but is not found in the billing system, the customer is not deleted from ERP "UserSide". Instead, the customer is marked with the "not in billing" status. This is done for safety: otherwise, if an update fails, all customers could be deleted because they were not found in billing.

3. If a customer's Internet activity date is later than the network activity date, the network activity date is set equal to the Internet activity date.

4. When data is updated from billing, not all customer data is updated. For example, full name, address, and phone number may remain unchanged. Loading such data can be enabled in the "Settings - Billings" section for the required billing system.

Brief module descriptions

A detailed description is provided on each module page.

usm_billing imports information about customers, addresses, tariff plans, and other data from billing into USERSIDE. It can also support a custom in-house billing system. Separate modules for standard billing systems are based on this module: usm_abills, usm_bgbilling, usm_hydra, usm_lanbilling, usm_nodeny, usm_nodeny_plus, usm_utm5.

usm_asterisk interacts with Asterisk telephony. When a call is received, it instantly (before the handset is picked up) displays the caller's phone number on the operator's screen. If this phone number belongs to a customer, the module shows customer information (full name, balance, address, tariff plan, last activity date, and so on). If the phone number belongs to an employee, this is indicated. If the number is unknown, the operator is offered to create a potential customer card.

usm_cabletest periodically polls switches and receives cable tester information about the length of connected copper cables. The list of supported switch models is provided on the module page.

usm_checker periodically polls (multithreaded ping) active network equipment or customer devices to detect which equipment is active and which has gone down (or which customers are no longer active).

usm_gps receives information from hardware and software GPS trackers to display vehicle and employee locations on the coverage map. It helps identify who is closest to an incident, shows who moved where and when, and displays vehicle speed limit violations and similar data. The list of supported tracker protocols is provided on the module page.

usm_iferr periodically polls (via SNMP) error counters on equipment interfaces. This shows devices with interface errors, both by interface and by the number of problematic interfaces on each device. It also builds daily and weekly error growth deltas, making it possible to see devices where problems are still ongoing.

usm_observer periodically polls (via SNMP) any equipment for any parameters and sends notifications (email, SMS, and so on) when parameters change or go beyond limits. It makes it possible to flexibly configure monitoring for any devices: a specific port went down, an alarm sensor was triggered, battery operation started, a printer ran out of paper, and so on.

usm_peleng periodically polls switches, receives their FDB tables, and accumulates MAC address information by equipment and port. It helps detect loops, port flooding, and viruses, and helps find MAC address spoofing. UPLINK/DOWNLINK ports can be excluded from display. Customer or device information is pulled from USERSIDE by MAC address.

usm_pon periodically polls OLTs, receives and accumulates information about connected ONUs: signal level, distance to OLT, model, vendor, description, MAC, ID, and other data. It also stores the history of signal level changes by ONU. Customer information is pulled from USERSIDE by ONU MAC address or ID.

usm_radio periodically polls radio equipment and receives a list of connected radio customers: signal level, MAC address, connection speed, and similar data. The list of supported vendors is provided on the module page. Customer or device information is pulled from USERSIDE by MAC address.

usm_stat is launched periodically and records customer activity in the database at the time of launch. This makes it possible to see, for each customer, on which days and at what hours they were active in the network. It also records the total number of active customers at the time the module is launched.

Current module versions

usm_abills - 3.318.310
usm_asterisk - 1.0.20
usm_bgbilling - 3.318.111
usm_billing - 1.13.318
usm_cabletest - 1.1.5
usm_checker - 2.3.1
usm_gps - 2.5.0
usm_hydra - 3.318.178
usm_iferr - 1.3.0
usm_lanbilling - 3.318.349
usm_nodeny - 3.318.254
usm_nodeny_plus - 3.318.76
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.318.685