This manual will guide you on every detail about how to install and use the Billing for FusionPBX native application. If you want to have a quick setup, you may read the quick guide and later return here.
Content
Billing for FusionPBX Installation
Before you start Billing for FusionPBX installation, you must satisfy the next requirements:
- You need to have FusionPBX 3.6 or better installed with MySQL, MariaDB or PostgreSQL as database data storage. If you don't know how to do this, OKay offers Linux consultant services.
- You need to have PHPShadow extension installed. If you already have the LCR for FusionPBX working, you already have this.
- You need to have LCR for FusionPBX installed.
- You need to have SSH access and to be able to write in /app directory where FusionPBX is installed.
- You need to have access to FusionPBX as superadmin.
- You need to download and get a Billing for FusionPBX license.
- Optionally, you may need to install mod_niblebill. The billing software uses this module to hangup calls when you run out of credit. If this is not important for you, you may skip it. The installation procedure depends on how you installed FreeSWITCH: source, DEB's or RPM's.
When you satisfy these requisites, please follow the next steps:
- Go to app directory where FusionPBX is installed, for example: cd /var/www/html/app. If you are using OKay's RPM type yum install fusionpbx-billing.
- Copy LCR for FusionPBX in the server (by FTP or SCP), you can place it in /tmp directory
- Execute the command tar -jxvf /tmp/billing-crypted.tar.bz2
- Go into /var/www/html/app/billing directory and execute echo -n key > any_name.key command, where key is your license number. Since version 1.0.1 license name can have any name with .key extension.
- Copy niblebill.conf.xml into autoload_configs directory (for example: /etc/freeswitch/autoload_configs/).cp niblebill.conf.xml /etc/freeswitch/autoload_configs/. Edit niblebill.conf.xml file and change the DSN values with yours. You can get the DSN value from the /etc/fusionpbx/config.lua file.
- Log into FusionPBX as superadmin and go to System->Modules menu, enable and start the Niblebill module.
- Go to Advanced->Upgrade menu, select Schema and Menu Defaults
- Review groups and menu permits. Go to Advanced->Group Manager and review that at least, superadmin group has the billing permissions.
- Logout and login again into FusionPBX
- If you are using the RPM's, install the fusionpbx-enhanced-xml-importer by typing yum install fusionpbx-enhanced-cdr-importer. Otherwise, go to your app/ directory and do a git clone https://bitbucket.org/okay-network/fusionpbx-enhanced-cdr-importer/src/master/ enhanced-cdr-importer. The name is hardcoded in many places, don't use another.
- Edit your /etc/freeswitch/autoload_configs/xml_cdr.conf.xml file and change the URL parameter to http://127.0.0.1/app/enhanced-cdr-importer/xml_cdr_import.php
- Reload the mod_xml_cdr module or restart the FreeSWITCH daemon.
- Edit a dialplan (usually the variables dialplan) and set the variable cdr_billing=1 (the value doesn't matter, the variable must exist). If you unset the variable, you can pass free calls (not billed). By default, you should bill everything unless you have a special business need.
Billing for FusionPBX Configuration
To configure LCR for FusionPBX, you need to understand the following concepts:
- Profile
- A Profile is used to define a billing. Each profile is identified by a unique label.
- Billing Cycle
- A Billing Cycle defines the billing day. Static charges will take place this day.
- Billing Type
- A billing type may be pre or postpaid.
- Amount
- The specific amount, on post-paid profiles it establishes the maximum credit a profile may have. This value is zero for pre-paid profiles. You must define billing currency, the system will use external services to do the rating. LCR profile
- LCR profile is a pricing list. By changing this label, you may have more than one pricing list.
- Refered
- Referal fields let you reward your users just because they recommend your service.
After:
- Go to Apps->Billing menu and add a profile
- Fill the next information
Select FROM and TO depending who shall send the billing to who. Data will be taken according to information in Contacts application; you can go to App -> Contacts menu to fill information.
In most cases, using billing per tenant is enough, but there are specific cases where an alternate code is required, especially if you need more than one billing profile per tenant; in this case, select the by-code option. The value entered in the Criteria Value field needs to be in place on all other FusionPBX items.
Select the billing day cycle, to make things simple it is only allowed from 1 to 28.
The Amount field is read-only, you must select the currency for billing. Once the currency is set, you won't be able to change it.
Delay days field is not used.
Balance is a read-only field.
LCR profile field will tell the profile what pricing list to use. By default it is 'default', by adding a new profile means to modify file lcr.conf.xml.
Referal fields are sued to reward your users because of recommendations.
Select FROM and TO depending who shall send the billing to who. Data will be taken according to information in Contacts application; you can go to App -> Contacts menu to fill information.Remember to fill the accountcode field with the correct value when creating items in FusionPBX. After having your first billing profile ready, you need to change the bridging statements to lcr/default/XXXXXX, usually lcr/default/$1. It depends on your dialplans. The default profile will pass the information you need to bill properly.
Maintenance Tasks
Crontab Configuration
The following files can be edited and place into a crontab:
- billing_crontab_pyramid.php
- billing_crontab_lowbalance_email.php
Billing Logic Change
Sometimes, you may need to change billing logic (only in specific cases). You can edit the file resources/functions/ratings.php
Billing for FusionPBX Update
You may follow the installation procedure for any update.