The receiving operation is used to copy/download/move files into the BillRun workspace directory.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- receive : The actual action that should be done in this operation. In this case receive for receiving files.
- type : What type of file (input processor) should be received. Use 'all' to receive files for all input processors.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <env> --receive --type <input_processor_name>
The processing operation is used to parse files that were received in the billrun workspace directory and insert their content into the DB. This also runs all calculators on xDRS found in the file.
In case of a file that can't be parsed, its CDRs will be discarded.
In case a matching customer / product cannot be found, the line will be stored in "queue" collection.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- process : The actual action that should be done in this operation in this case process for processing files.
- type : What type of files (input processor) should be processed. Use 'all' to process files from all input processors.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <env> --process --type <input_processor_name>
The calculate customer operation is used to find the customer/subscriber that each of the CDRs that were processed into the DB belongs to.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- calculate : The actual action that should be done in this operation. In this case calculate for specific calculation.
- type : should be customer in order to run the customer calculator.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <env> --calculate --type customer
The calculate rate operation is used to find the correct product that each of the CDRs in the DB should be associated with based on the CDR usage information and the cdr associated customer information.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- calculate : The actual action that should be done in this operation in this case calculate for calculating additional CDR values.
- type : should be Rate_Usage.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <env> --calculate --type Rate_Usage
The calculate pricing operation is used to find the charge for each of the CDRs in the DB based on the rate that was associated with the CDRs and the associated customer offer.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- calculate : The actual action that should be done in this operation in this case calculate for calculating additional CDR values.
- type : should be customerPricing in order to run the pricing calculator.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <env> --calculate --type customerPricing
The calculate Tax operation is used to find the correct tax (VAT is most cases) that each of the CDRs in the DB should be associated with based on the CDR usage information and the cdr associated customer information. The calculator adds also a final_charge field on the record.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- calculate : The actual action that should be done in this operation in this case calculate for calculating additional CDR values.
- type : should be tax in order to run the tax calculator.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <env> --calculate --type tax
The “rebalance” calculator is used to reset CDRs of a given account in a given billing cycle.
The desired accounts must be first declared for rebalancing via the resetlines API.
After the rebalance operation, all the subscriber / product / prices data is removed from the line and the above calculators can be run from scratch.
Note:
- In case invoice creation has already started for the relevant cycle, it's most likely that you'd want to reset the cycle first via "Billing cycle --> Run --> Choose a billing cycle --> Reset". Otherwise the rebalanced lines will be included in the next billing cycle.
- It is important to choose carefully the lines to be rebalanced.
By an example: Imagine a case where roaming calls were incorrectly assigned a local product which is included in the customer's plan (5000 minutes in a cycle). It is not sufficient to rebalance the roaming calls. All local calls of the customer have to be rebalanced as well!
- Events could be triggered again as a result of a rebalance.
- Rebalance does not reset lines of the following types: "flat", "service", "discount". To fix these lines, rerun the billing cycle.
- env : The configuration file to load to match a given running environment test (testing)/dev (development)/prod (production)/int.
- calculate : The actual action that should be done in this operation in this case calculate for calculating additional CDR values.
- type : should be rebalance in order to run the rebalance calculator.
¶ Running command
php -t <billrun_dir_path> <billrun_dir_path>/public/index.php --env <ENV> --calculate --type rebalance