Usm bgbilling EN

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

usm_bgbilling - module for organising the import of data from the BGBilling billing system into ERP "UserSide"

This module is a replacement for the deprecated us_bgbilling module - See: Migration from us bgbilling to usm bgbilling

Module Language: PHP

Current version: See page: Modules

Module Status: Paid

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

Information on installing the module

Make sure that the php_mysqli library is present on the system where the module will run

The usm_bgbilling.zip archive contains the files

usm_bgbilling.php
usm_bgbilling.conf.php-example

1. On any server (no difference - billing server, userside or third machine) allocate a separate (random) 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_bgbilling.conf.php-example to usm_bgbilling.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_bgbilling.php

It should work without error and return data:

usm_bgbilling
====================================
 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 further 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 further 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_bgbilling.php

Parameters

The module is configured in the usm_bgbilling.conf.php file

You can also use the default parameters from the usm_billing module

$usersideUrl         - URL to 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 to access the billing database
$billingDBPassword   - password for access to the billing database
$billingDBName       - billing database name
$billingCodePage     - billing database encoding

$confIsIgroneTtlTable       - flag - ignore data from table "tariff_tree_link"
$confPidAddressContract     - PID value from table contract_parameter_type_2 with address field
$confIsUseCustomerNameTable - flag - use contract_parameter_type_1 table to get user name
$confIsWoPaymentParent      - flag - do not use parent payments value in tariffs
$confIsSkipCustomerWoLogin  - flag - don't import users without logins

$confModuleInetNumber   - inet module number
$confModuleDialupNumber - dialup module number
$confModuleIpnNumber    - ipn module number

$confAddFieldAgreementNumber          - id of additional field with contract number in table contract_parameter_type_1
$confImportCustomerAgreementDateClose - id of additional ERP "UserSide" field for importing contract end date
$confImportCustomerVlan               - id of additional ERP "UserSide" field for importing user's vlan
$confImportPppoeLogin                 - id of additional ERP "UserSide" field for importing user's pppoe-login
$confImportPppoePass                  - id of additional ERP "UserSide" field for importing user's pppoe-password

$confBillingState0 - status in billing "0 - connected"
$confBillingState1 - status in billing "1 - disconnected"
$confBillingState2 - billing status "2 - disconnected"
$confBillingState3 - billing status "3 - closed"
$confBillingState4 - billing status "4 - suspended"
$confBillingState5 - billing status "5 - on connection"

$contractAddString - additional string for importing information about contracts
$confAddFieldPhone - id of additional field with phone number in table contract_parameter_type_1
$confIsImportAgreementAsLogin - flag - import contract number as loginLogin