Enhanced XML Importer for FusionPBX Manual

This manual will guide you on every detail about installing and using the LCR for FusionPBX native application.  If you want to have a quick setup, you may read the quick guide and later return here.

Content

1. Enhanced XML Importer for FusionPBX installation
2. Enhanced XML Importer for FusionPBX configuration

Assumptions: The reader is familiar with Linux and FusionPBX.

Enhanced XML Importer for FusionPBX Installation

Before you start Enhanced XML Importer for FusionPBX installation, you must satisfy the next requirements:

• You need to have FusionPBX 4.4 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 SSH access and to be able to write in /app directory where FusionPBX is installed.
• You need to have access to FusionPBX as superadmin.

When you satisfy these requisites, please follow the next steps:

RPM Installation

This method only applies if you are using the RPM's from the OKay's repository.

1. Type yum install fusionpbx-enhanced-cdr-importer,
2. Depending on the import method, you may want to do one of the following actions:
   1. edit the crontab and change the route that points to app/xml_cdr/v_xml_cdr_import.php to app/enhanced-cdr-importer/xml_cdr_import.php, or
   2. edit the /etc/freeswitch/autoload_configs/xml_cdr.conf.xml file and change the URL tag to point to http://127.0.0.1/app/enhanced-cdr-importer/xml_cdr_import.php, after that, you will need to reload the mod_xml_cdr module.

Source Installation

1. Go to app directory where FusionPBX is installed, for example: cd /var/www/html/fusionpbx/app. If you are using the default FusionPBX installation script, it is very likely the path is /var/www/fusionpbx/app. Unzip the tarball and rename the directory to enhanced-cdr-importer.
2. Download the tarball from https://bitbucket.org/okay-network/fusionpbx-enhanced-cdr-importer/downloads/?tab=tags that matches your LCR and Billing version.
3. Depending on the import method, you may want to do one of the following actions:
   1. edit the crontab and change the route that points to app/xml_cdr/v_xml_cdr_import.php to app/enhanced-cdr-importer/xml_cdr_import.php, or
   2. edit the /etc/freeswitch/autoload_configs/xml_cdr.conf.xml file and change the URL tag to point to http://127.0.0.1/app/enhanced-cdr-importer/xml_cdr_import.php, after that, you will need to reload the mod_xml_cdr module. 

Enhanced XML Importer for FusionPBX Configuration

The Enhanced XML Importer without extra configuration runs as the default XML importer shipped in FusionPBX.

Plugins:

• Billing Plugin: needed to use the Billing for FusionPBX application.
• Delete CDR Plugin: deletes the CDR record if the variable cdr_delete is present.

Developing Own Plugins

If you which to write your own plugins, follow these guides:

• The plugin file name and the class name must be the same,
• Extend your class from the xml_import_plugin_template class,
• Extend at least the following methods (they are abstract):
  • fields
  • xml_array
  • read_files
  • post

It is a good idea to see the billing and delete plugin to get an idea.