Разработка собственных отчетов для BILLmanager

Материал из ISPWiki
Перейти к: навигация, поиск

Маркетологам, руководителям да и рядовым сотрудникам всегда хочется чего-то странного. Я имею ввиду какую-то специфическую информацию обработанную особым образом. Мы постарались включить в BILLmanager наиболее типовые и широко используемые отчеты, однако этого зачастую недостаточно, поэтому в данной статье мы рассмотрим как можно создать собственный отчет.

Для этого вам понадобятся знание SQL, а так же понимание структуры базы данных BILLmanager. В случае если отчет сложный и не строится одним запросом в базу данных, вам понадобятся навыки программирования на любом знакомом вам языке.

Разработка отчета состоит из следующих пунктов

  • Подключение отчета в основное меню или в список отчетов
  • Описание формы для ввода параметров (если требуется)
  • Описание внешнего вида отчета
  • Построение SQL запроса для получения данных


Описание отчета, как и любого другого плагина делается с помощью xml файла /usr/local/mgr5/etc/xml/<mgr>_mod_<name>.xml, где <mgr> имя продукта, а <name> имя плагина. Допустим мы пишем плагин для BILLmanager и называем его myreport, тогда файл должен иметь имя

 /usr/local/mgr5/etc/xml/billmgr_mod_myreport.xml

Создадим очень простое XML- описание

<?xml version="1.0" encoding="UTF-8"?>
<mgrdata>
        <mainmenu level="29">
                <node name="stat">
                        <node name="myreport"/>
                </node>
        </mainmenu>
 
        <metadata name="myreport" type="report">
                <band name="company">
                        <query>select id, name from profile where account=1</query>
                        <col name="name" type="data"/>
                </band>
        </metadata>
 
        <lang name="ru">
                <messages name="desktop">
                        <msg name="menu_myreport">Мой первый отчет</msg>
                </messages>
                <messages name="myreport">
                        <msg name="title">Заголовок моего первого отчета</msg>
                </messages>
        </lang>
</mgrdata>

В данном примере мы добавили ссылку на отчет в основное меню, в раздел "Статистика". В самом отчете мы вывели список компаний провайдера.

Если вы все сделали правильно, и у вас, в настройках билинга есть несколько компаний, то должны увидеть примерно такой отчет

Rep1.png


Давайте немного усложним наш отчет и к каждой компании выведем список методов оплаты которые она принимает, для этого мы добавим вложенный band и описание отчета будет выглядеть следующим образом

<metadata name="myreport" type="report">
        <band name="company">
                <query>select id, name from profile where account=1</query>
                <col name="name" type="data"/>
                <band name="paymethod">
                        <query>select p.name_ru as paymethod from paymethod2company pc left join paymethod p on pc.paymethod=p.id where pc.company=[[company.id]]</query>
                        <col name="paymethod" type="data"/>
                </band>
        </band>
</metadata>

У меня получился примерно такой результат

Rep2.png

Далее давайте рассмотрим пример использования форм. Допустим нам необходимо вывести только методы оплаты оплаты минимальная сумма платежу у которых более определенного значения, для этого добавим форму и параметр в SQL-запрос.

        <metadata name="myreport" type="report" firstrun="no">
                <form>
                        <field name="minamount">
                                <input type="text" name="minamount" save="yes" required="yes" check="int"/>
                        </field>
                </form>
                <band name="company">
                        <query>select id, name from profile where account=1</query>
                        <col name="name" type="data"/>
                        <band name="paymethod">
                                <query>select p.name_ru as paymethod, minamount from paymethod2company pc left join paymethod p on pc.paymethod=p.id where pc.company=[[company.id]] and p.minamount>=[[minamount]]</query>
                                <col name="paymethod" type="data"/>
                                <col name="minamount" type="data" sort="digit"/>
                        </band>
                </band>
        </metadata>