Add tariff change policy description.

[stg.git] / doc / help / ch12.xml

diff --git a/doc/help/ch12.xml b/doc/help/ch12.xml
index 536dd14fc3ad7d922e10764dae4d4a501f63d96c..9a5166d7184b5a86da6f3807c232e1c0feba3ed9 100644 (file)
--- a/doc/help/ch12.xml
+++ b/doc/help/ch12.xml
@@ -45,7 +45,29 @@ create database 'localhost:/var/stg/stargazer.fdb' user 'stg' password '123456'
                <listitem><para>fee – абонплата;</para></listitem>
                <listitem><para>free – количество бесплатных мегабайт трафика, входящих в абонплату;</para></listitem>
                <listitem><para>passive_cost – стоимость «заморозки» пользователя;</para></listitem>
-               <listitem><para>traf_type – тип подсчета трафика (upload, download, upload+download, MAX(upload, download)).</para></listitem>
+               <listitem><para>traff_type — тип тарификации трафика:</para>
+                       <itemizedlist mark="square">
+                               <listitem><para>up+down — входящий и исходящий трафик тарифицируется суммарно;</para></listitem>
+                               <listitem><para>up — тарифицируется только исходящий трафик;</para></listitem>
+                               <listitem><para>down — тарифицируется только входящий трафик;</para></listitem>
+                               <listitem><para>max — тарифицируется большее количество трафика;</para></listitem>
+                       </itemizedlist>
+               </listitem>
+               <listitem><para>period — тип абонплаты:</para>
+                       <itemizedlist mark="square">
+                               <listitem><para>day — ежедневная абонплата (параметр Fee трактуется как значение списываемое ежедневно);</para></listitem>
+                               <listitem><para>month — ежемесячная абонплата (классическая, параметр Fee трактуется как значение списываемое за месяц, в том числе в режиме SpreadFee);</para></listitem>
+                       </itemizedlist>
+               </listitem>
+               <listitem><para>change_policy — политика смены тарифа:</para>
+                       <itemizedlist mark="square">
+                               <listitem><para>allow — на период действия политики смена тарифного плана разрешена;</para></listitem>
+                               <listitem><para>to_cheap — на период действия политики разрешена смена тарифного плана на более дешевый;</para></listitem>
+                               <listitem><para>to_expensive — на период действия политики разрешена смена тарифного плана на более дорогой;</para></listitem>
+                               <listitem><para>deny — на период действия политики смена тарифного плана запрещена;</para></listitem>
+                       </itemizedlist>
+               </listitem>
+               <listitem><para>change_policy_pimeout — момент завершения действия политики тарификации (0 - политика тарификации не завершается никогда);</para></listitem>
        </itemizedlist>
        <para>С таблицей связана хранимая процедура sp_add_tariff, получающая в качестве параметров название тарифа и количество направлений. Возвращает сгенерированный идентификатор (первичный ключ) тарифа. При вызове создает запись в таблице tb_tariffs и указанное количество записей в таблице tb_tariffs_params, соответствующее количеству направлений. С таблицей так же связана хранимая процедура sp_delete_tariff, получающая на вход название тарифа и удаляющая его из таблицы tb_tariffs и связанные с ним данные из таблицы tb_tariffs_params.</para>
        <para>Таблица tb_tariffs_params (параметры тарифов):</para>