Modules EN
ERP "UserSide" modules are divided into internal and external modules. External modules are separate scripts or programmes that can operate remotely from the main system (with a connection to the system database), while internal modules are already built into the system and can be enabled/disabled in the "Settings - Modules" section.
Frequent questions about modules are collected in the corresponding section "Frequently Asked Questions".
Installing modules. General information for all modules
1. For each module - allocate a separate directory.
2. During operation, all modules keep logs of their work. The path for the catalogue with logs is specified in the configuration file. It is highly recommended to create a separate catalogue for logs for each module. Do not forget to specify write permissions for this catalogue.
3. Modules are usually used for ongoing operation. They should be written to the system cron with a frequency of 5-15 minutes (depending on the load). At the first launch it is recommended to run the module manually from the system console and make sure that no errors occur and data are imported/processed correctly.
General information for billing interaction modules
1. The customer's address is processed and recorded in the addresses accounting system built into ERP "UserSide". In case the required building does not exist in ERP "UserSide" it will be created. If the building already exists and is added to the system not by the resources of the module, it will still be correctly processed and assigned to customers.
2. If a customer is in ERP "UserSide", but is not found in billing, he is not deleted from ERP "UserSide", but is marked with the status "not in billing". This is done for security purposes - otherwise in case of update failure - all customers may be deleted, as they will not be found in the billing.
3. If a customer's Internet activity date is later than the online activity date, then the online activity date is equated to the online activity date.
4. When updating data from billing - not all customer data is updated - e.g. name, address, phone number may remain unchanged. Loading of such data can be enabled in the "Settings - Billings" section for the required billing.
A brief description of the modules
A detailed description is provided on the page of each module
usm_billing - provides import of information about customers, addresses, tariff plans, etc. from billing into USERSIDE. It is possible to support your own self-written billing. On the basis of this module separate modules for standard billing systems are created: 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 - instantly (even before picking up the phone) displays on the operator's screen the phone number of the caller and if this phone number belongs to a customer - information about the customer (name, balance, address, tariff plan, date of last activity, etc.). If this phone number belongs to an employee - this will be indicated. If it is an unknown phone number - you will be prompted to create a potential customer card.
usm_cabletest - periodically polls switches and gets information from them from the cable tester about the length of switched copper cables. The list of supported switch models is given on the module page.
usm_checker - periodically polls (multithreaded pings) active network equipment or customer devices to identify which equipment is active and which has crashed (or which customers are no longer active).
usm_gps - accepts information from hardware and software gps trackers in order to display the location of vehicles and employees on a coverage map. Allows you to see who is closest to an accident. You can see who was travelling at what time and where. You can see violations of vehicle speed limits, etc. The list of supported tracker protocols is given on the module page.
usm_iferr - periodically' polls (via SNMP) error counters on equipment interfaces. This allows you to see devices with errors on interfaces (both by interface and with the number of problematic interfaces for each device). It also builds the delta of error growth per day and per week, which allows you to see devices where problems continue right now.
usm_observer - periodically' polls (via SNMP) any equipment for any parameters and notifies (mail, sms, etc.) when parameters change or go out of limits. Allows flexible configuration of any monitoring of any devices: port number so-and-so has failed, alarm sensor has been triggered, battery operation has started, printer has run out of paper, etc.
usm_peleng - periodically polls switches, gets FDB-table from them and accumulates information on MAC-addresses by equipment and its ports. It allows detecting rings, flooding on ports, viruses. Helps to find MAC-address spoofing. It is possible to exclude uplink/downlink ports, etc. from the display. Information about a customer or device is pulled from USERSIDE by MAC-address.
usm_pon - periodically queries OLT, receives and accumulates information about enabled ONUs. Signal strength, distance to OLT, model, vendor, description, MAC, ID, etc. History of signal level changes by ONU. Information about the customer is pulled up by MAC address/ID of ONU from USERSIDE.
usm_radio - periodically queries radio equipment and retrieves a list of connected radio customers. Signal strength, MAC address, connection speed, etc. The list of supported vendors is listed on the module page. Information about the customer or device is pulled from USERSIDE by MAC-address.
usm_stat - periodically is launched and records the fact of activity of customers at the moment of launching. This allows you to further see for each of the customers in what days and hours he was active in the network. The total number of active customers at the moment of module launch is also recorded.
Current versions of the modules
usm_abills - 3.252.258 usm_asterisk - 1.0.20 usm_bgbilling - 3.252.102 usm_billing - 1.11.252 usm_cabletest - 1.1.4 usm_checker - 2.3 usm_gps - 2.4.0 usm_hydra - 3.252.162 usm_iferr - 1.2 usm_lanbilling - 3.252.295 usm_nodeny - 3.252.242 usm_nodeny_plus - 3.252.69 usm_observer - 1.2 usm_peleng - 3.25.119 usm_pon - 1.9.28 usm_radio - 3.12.13 usm_stat - 3.9.24 usm_utm5 - 3.252.653