Usm nodeny plus EN: различия между версиями
Нет описания правки |
|||
Строка 2: | Строка 2: | ||
{{ActivEN}} | {{ActivEN}} | ||
'''usm_nodeny_plus''' - module for organising data import from the NoDenyPlus billing system into ERP ''UserSide'' | |||
'''This module is a replacement for the deprecated [[us_nodeny_plus_EN|us_nodeny_plus]] module''' - See: [[Migrating from us nodeny_plus to usm nodeny_plus]] | |||
'''Module Language:''' PHP | |||
'''Current version:''' See page: [[Modules_EN|Modules]] | |||
'''Module Status:''' [https://www.userside.eu/en/pricing Paid] | |||
For more information and a list of imported data, see the page: [[NoDenyPlus_EN|NoDenyPlus]] | |||
== Information on installing the module == | |||
'''Make sure that the php_mysqli library is present on the system where the module will run''' | |||
The usm_nodeny_plus.zip archive contains the files | |||
usm_nodeny_plus.php | |||
usm_nodeny_plus.conf.php-example | |||
1. On any server ''(no difference - billing server, userside or third machine)'' allocate a separate ''(arbitrary)'' directory for the module and place these files in it | |||
2. Allocate a separate directory for the module logs. Give write permissions to this directory. | |||
3. Rename the example configuration file usm_nodeny_plus.conf.php-example to usm_nodeny_plus.conf.php and make the required changes ''(the list of parameters is given below)'' in it | |||
4. Run the module manually several times (*) with the command | |||
php usm_nodeny_plus.php | |||
It should work without error and return the data: | |||
usm_nodeny_plus | |||
==================================== | |||
Start module at 2015-11-22 17:32:03 | |||
Finish module at 2015-11-22 17:32:14 | |||
==================================== | |||
''* - At the first run - many objects will be pre-created only. The more objects the module imports - the longer it will take. The second and subsequent runs will reconcile the changed data and only these will be updated. The second run will also take a long time, because after the first run the newly created objects do not contain any data. But the third and subsequent runs will run much faster.'' | |||
5. Visually verify the completeness of the imported data in the ERP "UserSide" | |||
6. When it is clear that the module works stably - add it to the system cron for periodic operation ''(specify the necessary paths)'' | |||
*/10 * * * * php usm_nodeny_plus.php | |||
== Parameters == | |||
The module is configured in the '''usm_nodeny_plus.conf.php''' file | |||
You can also use the default parameters from the [[usm_billing#Configuration Parameters|usm_billing]] module | |||
$usersideUrl - URL to the ERP "UserSide" | |||
$usersideApiKey - [[UserSide API Key_EN|API-key of ERP "UserSide"]] | |||
$billingId - The billing number in ERP "UserSide" ''("Settings - Billings)'' | |||
$logPath - Path for logging | |||
$isSilence - Silence Mode flag ''(hide the output of information messages from the module to the console)'' | |||
$billingDBHost - address of the billing server | |||
$billingDBUser - user name for access to the billing database | |||
$billingDBPassword - password for access to the billing database | |||
$billingDBName - billing database name | |||
$billingCodePage - billing database encoding | |||
$confPasswordAESDecryptString - code string for AES encryption of the password in billing | |||
$confIdGroupCustomersOnPause - index of additional group of users, which is allocated for "pause". | |||
$confIsSwapTrafCounter - flag - swap input/exhaust traffic values. | |||
$confIdGroupDeleteCustomers - id of users' group in billing for accounting of deleted users | |||
$confAddFieldParentId - field name for parent account ID ''(ex. mid)'' | |||
$confTariffModuleList - list of modules with tariffs ''(default: 'inet_unlim', 'basic', 'speed_up', 'inet_omegatv', 'omegatv', 'iptv')'' | |||
$confAddFieldNamePhone - name of field in table data0 with phone number | |||
$confAddFieldNameCity - name of the field in table data0 with the name of the settlement | |||
$confAddFieldNameStreet - name of field in table data0 with street | |||
$confAddFieldNameHouseBlock - name of field in table data0 with building/house block | |||
$confDictionaryCityPrefix - dictionary.type value for "City" type | |||
$confDictionaryStreetPrefix - dictionary.type value for "Street" type | |||
$confAddFieldEntrance - dictionary.type value for type "Entrance" | |||
$confAddFieldFloor - dictionary.type value for type "Floor" |
Версия от 14:38, 27 октября 2023
This function is one of the possibilities |
usm_nodeny_plus - module for organising data import from the NoDenyPlus billing system into ERP UserSide
This module is a replacement for the deprecated us_nodeny_plus module - See: Migrating from us nodeny_plus to usm nodeny_plus
Module Language: PHP
Current version: See page: Modules
Module Status: Paid
For more information and a list of imported data, see the page: NoDenyPlus
Information on installing the module
Make sure that the php_mysqli library is present on the system where the module will run
The usm_nodeny_plus.zip archive contains the files
usm_nodeny_plus.php usm_nodeny_plus.conf.php-example
1. On any server (no difference - billing server, userside or third machine) allocate a separate (arbitrary) directory for the module and place these files in it
2. Allocate a separate directory for the module logs. Give write permissions to this directory.
3. Rename the example configuration file usm_nodeny_plus.conf.php-example to usm_nodeny_plus.conf.php and make the required changes (the list of parameters is given below) in it
4. Run the module manually several times (*) with the command
php usm_nodeny_plus.php
It should work without error and return the data:
usm_nodeny_plus ==================================== Start module at 2015-11-22 17:32:03 Finish module at 2015-11-22 17:32:14 ====================================
* - At the first run - many objects will be pre-created only. The more objects the module imports - the longer it will take. The second and subsequent runs will reconcile the changed data and only these will be updated. The second run will also take a long time, because after the first run the newly created objects do not contain any data. But the third and subsequent runs will run much faster.
5. Visually verify the completeness of the imported data in the ERP "UserSide"
6. When it is clear that the module works stably - add it to the system cron for periodic operation (specify the necessary paths)
*/10 * * * * php usm_nodeny_plus.php
Parameters
The module is configured in the usm_nodeny_plus.conf.php file
You can also use the default parameters from the usm_billing module
$usersideUrl - URL to the ERP "UserSide" $usersideApiKey - API-key of ERP "UserSide" $billingId - The billing number in ERP "UserSide" ("Settings - Billings) $logPath - Path for logging $isSilence - Silence Mode flag (hide the output of information messages from the module to the console)
$billingDBHost - address of the billing server $billingDBUser - user name for access to the billing database $billingDBPassword - password for access to the billing database $billingDBName - billing database name $billingCodePage - billing database encoding
$confPasswordAESDecryptString - code string for AES encryption of the password in billing $confIdGroupCustomersOnPause - index of additional group of users, which is allocated for "pause". $confIsSwapTrafCounter - flag - swap input/exhaust traffic values. $confIdGroupDeleteCustomers - id of users' group in billing for accounting of deleted users $confAddFieldParentId - field name for parent account ID (ex. mid) $confTariffModuleList - list of modules with tariffs (default: 'inet_unlim', 'basic', 'speed_up', 'inet_omegatv', 'omegatv', 'iptv')
$confAddFieldNamePhone - name of field in table data0 with phone number $confAddFieldNameCity - name of the field in table data0 with the name of the settlement $confAddFieldNameStreet - name of field in table data0 with street $confAddFieldNameHouseBlock - name of field in table data0 with building/house block $confDictionaryCityPrefix - dictionary.type value for "City" type $confDictionaryStreetPrefix - dictionary.type value for "Street" type $confAddFieldEntrance - dictionary.type value for type "Entrance" $confAddFieldFloor - dictionary.type value for type "Floor"