Usm nodeny EN: различия между версиями

Материал из WiKi - UserSide
(Новая страница: «en | ru {{ActivEN}}»)
 
Нет описания правки
 
Строка 2: Строка 2:


{{ActivEN}}
{{ActivEN}}
'''usm_nodeny''' - module to organise the import of data from the NoDeny billing system into ERP ''UserSide''
'''This module is a replacement for the deprecated [[us_nodeny_EN|us_nodeny]] module''' - See: [[Migrating from us nodeny to usm nodeny]]
'''Module Language:''' PHP
'''Current version:''' See the 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: [[NoDeny_EN|NoDeny]]
== 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.zip archive contains the files
usm_nodeny.php
usm_nodeny.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 sample configuration file usm_nodeny.conf.php-example to usm_nodeny.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.php
It should work without error and return the data:
usm_nodeny
====================================
  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.php
== Parameters ==
The module is configured in the '''usm_nodeny.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          - 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    - encoding of the billing database
$billingDBPort      - billing database port number
$confListIgnoreImportCustomerState - list of users ''(users.cstate)'' statuses with which they should not be imported ''(default: 9,14)'''
$confIsDisableImportAlias          - flag - do not import child records ''(aliases)''
$confPasswordAESDecryptString      - code string for AES encryption of password in billing
$confIdGroupDeleteCustomers        - index of additional group of users, which is reserved for "deleted users". Users of this group are not imported
$confIdGroupCustomersOnPause      - index of additional group of users, which is allocated for "pause"
$confIsSavePasswordToComment      - flag - save user's password to the authorizer/statistician in the "additional data" field
$confImportCustomerExpr            - additional string for importing users ''(used AFTER where)''
$confIsSwapTrafCounter            - flag - replace input/output traffic values by users with each other
$confIsImportPaidCodeInComment    - flag - import "personal payment code" in comments by user
$confFieldDateConnect              - import the date of user's connection to UserSide ''(you should specify the id of the additional field)''
$confAddFieldIdCity        - code of the field "Settlement" - if present. 0 - if not used
$confAddFieldIdStreet      - code of additional field "Street" in dopfields.id
$confAddFieldIdHouseNumber - code of additional field "House" in dopfields.id
$confAddFieldIdHouseBlock  - code of additional field "Block" in dopfields.id
$confAddFieldIdEntrance    - code of additional field "Entrance" in dopfields.id
$confAddFieldIdFloor      - code of "Floor" field in dopfields.id
$confAddFieldIdApartment  - code of additional field "Apartment" in dopfields.id
$confAddFieldIdMac        - code of additional field "Mac-address" in dopfields.id
$confAddFieldIdPhone      - code of additional field "Phone" in dopfields.id
$confAddFieldIdPhone2      - code of additional field "Home phone (Phone 2)" in dopfields.id
$confAddFieldIdEMail      - code of additional field "E-mail" in dopfields.id
$confAddFieldIdRealIp      - code of additional field "Real IP address" in dopfields.id

Текущая версия от 15:55, 26 октября 2023

en | ru

This function is one of the possibilities
to update the activity date of an object

usm_nodeny - module to organise the import of data from the NoDeny billing system into ERP UserSide

This module is a replacement for the deprecated us_nodeny module - See: Migrating from us nodeny to usm nodeny

Module Language: PHP

Current version: See the page: Modules

Module Status: Paid

For more information and a list of imported data, see the page: NoDeny

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.zip archive contains the files

usm_nodeny.php
usm_nodeny.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 sample configuration file usm_nodeny.conf.php-example to usm_nodeny.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.php

It should work without error and return the data:

usm_nodeny
====================================
 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.php

Parameters

The module is configured in the usm_nodeny.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           - 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     - encoding of the billing database
$billingDBPort       - billing database port number

$confListIgnoreImportCustomerState - list of users (users.cstate) statuses with which they should not be imported (default: 9,14)'
$confIsDisableImportAlias          - flag - do not import child records (aliases)
$confPasswordAESDecryptString      - code string for AES encryption of password in billing
$confIdGroupDeleteCustomers        - index of additional group of users, which is reserved for "deleted users". Users of this group are not imported
$confIdGroupCustomersOnPause       - index of additional group of users, which is allocated for "pause"
$confIsSavePasswordToComment       - flag - save user's password to the authorizer/statistician in the "additional data" field
$confImportCustomerExpr            - additional string for importing users (used AFTER where)
$confIsSwapTrafCounter             - flag - replace input/output traffic values by users with each other
$confIsImportPaidCodeInComment     - flag - import "personal payment code" in comments by user
$confFieldDateConnect              - import the date of user's connection to UserSide (you should specify the id of the additional field)

$confAddFieldIdCity        - code of the field "Settlement" - if present. 0 - if not used
$confAddFieldIdStreet      - code of additional field "Street" in dopfields.id 
$confAddFieldIdHouseNumber - code of additional field "House" in dopfields.id
$confAddFieldIdHouseBlock  - code of additional field "Block" in dopfields.id
$confAddFieldIdEntrance    - code of additional field "Entrance" in dopfields.id
$confAddFieldIdFloor       - code of "Floor" field in dopfields.id
$confAddFieldIdApartment   - code of additional field "Apartment" in dopfields.id
$confAddFieldIdMac         - code of additional field "Mac-address" in dopfields.id
$confAddFieldIdPhone       - code of additional field "Phone" in dopfields.id
$confAddFieldIdPhone2      - code of additional field "Home phone (Phone 2)" in dopfields.id
$confAddFieldIdEMail       - code of additional field "E-mail" in dopfields.id
$confAddFieldIdRealIp      - code of additional field "Real IP address" in dopfields.id