[asterisk-doc] r6 - /dsssl/ /en/reference/billing/ /en/reference/billing/functions/ /entities/

commits at digium.com commits at digium.com
Tue May 9 11:18:59 MST 2006


Author: beckman
Date: Tue May  9 13:18:59 2006
New Revision: 6

URL: http://svncommunity.digium.com/view/asterisk-docs?rev=6&view=rev
Log:
Adding Billing Functions
- SetCDRUserField
- AppendCDRUserField
- NoCDR
- ForkCDR
- ResetCDR
- SetAMAFlags

Added:
    en/reference/billing/
    en/reference/billing/functions/
    en/reference/billing/functions.xml
    en/reference/billing/functions/appendcdruserfield.xml
    en/reference/billing/functions/forkcdr.xml
    en/reference/billing/functions/nocdr.xml
    en/reference/billing/functions/resetcdr.xml
    en/reference/billing/functions/setamaflags.xml
    en/reference/billing/functions/setcdruserfield.xml
    en/reference/billing/reference.xml
Modified:
    dsssl/version.dsl
    entities/builtin-extensions.xml
    entities/file-entities.ent
    entities/version.ent

Modified: dsssl/version.dsl
URL: http://svncommunity.digium.com/view/asterisk-docs/dsssl/version.dsl?rev=6&r1=5&r2=6&view=diff
==============================================================================
--- dsssl/version.dsl (original)
+++ dsssl/version.dsl Tue May  9 13:18:59 2006
@@ -75,7 +75,7 @@
    ((equal-ci? (data nl) "Dial") (literal "Asterisk 0.x, Asterisk 1.x"))
    ((equal-ci? (data nl) "Goto") (literal "Asterisk 0.x, Asterisk 1.x"))
    ((equal-ci? (data nl) "Authenticate") (literal "Asterisk 0.x, Asterisk 1.x"))
-   ((equal-ci? (data nl) "eval") (literal "PHP 3, PHP 4, PHP 5"))
+   ((equal-ci? (data nl) "SetCDRUserField") (literal "Asterisk 0, Asterisk 1 <= 1.0.9"))
    ((equal-ci? (data nl) "exit") (literal "PHP 3, PHP 4, PHP 5"))
    ((equal-ci? (data nl) "isset") (literal "PHP 3, PHP 4, PHP 5"))
    ((equal-ci? (data nl) "list") (literal "PHP 3, PHP 4, PHP 5"))

Added: en/reference/billing/functions.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions.xml (added)
+++ en/reference/billing/functions.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,6 @@
+&reference.billing.functions.appendcdruserfield;
+&reference.billing.functions.forkcdr;
+&reference.billing.functions.nocdr;
+&reference.billing.functions.resetcdr;
+&reference.billing.functions.setamaflags;
+&reference.billing.functions.setcdruserfield;

Added: en/reference/billing/functions/appendcdruserfield.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions/appendcdruserfield.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions/appendcdruserfield.xml (added)
+++ en/reference/billing/functions/appendcdruserfield.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,60 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.appendcdruserfield">
+ <refnamediv>
+  <refname>AppendCDRUserField</refname>
+  <refpurpose>
+   Append to the CDR user field [deprecated]
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+  <title>Description</title>
+   <methodsynopsis>
+    <methodname>AppendCDRUserField</methodname>
+    <methodparam><type>string</type><parameter>value</parameter></methodparam>
+   </methodsynopsis>
+  <para>
+   This application is deprecated since Asterisk 1.0.9, use
+   <function>Set</function> to append the CDR Userfield.
+   <example>
+    <title>Appending the CDR User field</title>
+    <programlisting role="astconf">
+<![CDATA[
+; Append "Value" to the CDR User field
+exten => s,1,Set(CDR(userfield)=${CDR(userfield)}Value)
+]]>
+    </programlisting>
+   </example>
+  </para>
+
+  <para>
+   The Call Data Record (CDR) user field is an extra field you can use for
+   data not stored anywhere else in the record.  CDR records can be used for
+   billing or storing other arbitrary data (I.E. telephone survey responses)
+  </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Added: en/reference/billing/functions/forkcdr.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions/forkcdr.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions/forkcdr.xml (added)
+++ en/reference/billing/functions/forkcdr.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,57 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.forkcdr">
+ <refnamediv>
+  <refname>ForkCDR</refname>
+  <refpurpose>
+   Forks the Call Data Record
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+  <title>Description</title>
+   <methodsynopsis>
+    <methodname>ForkCDR</methodname>
+    <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam>
+   </methodsynopsis>
+  <para>
+   Causes the Call Data Record (CDR) to end the current CDR record and begin a
+   new CDR record starting from the time ForkCDR is called.
+  </para>
+
+  <para>
+   <parameter>options</parameter> can be one or more of the following:
+   <itemizedlist>
+    <listitem>
+     <simpara>
+      <literal>v</literal> - Pass the existing CDR variables to the new CDR
+      record being created.
+     </simpara>
+    </listitem>
+   </itemizedlist>
+  </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Added: en/reference/billing/functions/nocdr.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions/nocdr.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions/nocdr.xml (added)
+++ en/reference/billing/functions/nocdr.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,45 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.nocdr">
+ <refnamediv>
+  <refname>NoCDR</refname>
+  <refpurpose>
+   Tell Asterisk to not maintain a CDR for the current call
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+  <title>Description</title>
+   <methodsynopsis>
+    <methodname>NoCDR</methodname>
+    <methodparam><type></type><parameter></parameter></methodparam>
+   </methodsynopsis>
+  <para>
+   This application will tell Asterisk not to maintain a CDR for the current
+   call.
+  </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Added: en/reference/billing/functions/resetcdr.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions/resetcdr.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions/resetcdr.xml (added)
+++ en/reference/billing/functions/resetcdr.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,65 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.resetcdr">
+ <refnamediv>
+  <refname>ResetCDR</refname>
+  <refpurpose>
+   Resets the Call Data Record
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+  <title>Description</title>
+  <methodsynopsis>
+   <methodname>ResetCDR</methodname>
+   <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   This application causes the Call Data Record to be reset.
+  </para>
+
+  <para>
+   <parameter>options</parameter> can be one or more of the following:
+   <itemizedlist>
+    <listitem>
+     <simpara>
+      <literal>w</literal> - Store the current CDR record before resetting it.
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>a</literal> - Store any stacked records.
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>v</literal> - Save CDR variables.
+     </simpara>
+    </listitem>
+   </itemizedlist>
+  </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Added: en/reference/billing/functions/setamaflags.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions/setamaflags.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions/setamaflags.xml (added)
+++ en/reference/billing/functions/setamaflags.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,71 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.setamaflags">
+ <refnamediv>
+  <refname>SetAMAFlags</refname>
+  <refpurpose>
+   Set the AMA Flags
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+  <title>Description</title>
+   <methodsynopsis>
+    <methodname>SetAMAFlags</methodname>
+    <methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam>
+   </methodsynopsis>
+  <para>
+   This channel will set the channel's AMA Flags for billing purposes.  The
+   flags will be stored in the CDR.  Overrides any setting in channel config.
+  </para>
+
+  <para>
+   <parameter>flags</parameter> can be only one of the following:
+   <itemizedlist>
+    <listitem>
+     <simpara>
+      <literal>default</literal> - Sets the system default.
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>omit</literal> - Do not record calls.
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>billing</literal> - Mark the entry for billing.
+     </simpara>
+    </listitem>
+    <listitem>
+     <simpara>
+      <literal>documentation</literal> - Mark the entry for documentation.
+     </simpara>
+    </listitem>
+   </itemizedlist>
+  </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Added: en/reference/billing/functions/setcdruserfield.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/functions/setcdruserfield.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/functions/setcdruserfield.xml (added)
+++ en/reference/billing/functions/setcdruserfield.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,61 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision$ -->
+
+<refentry id="function.setcdruserfield">
+ <refnamediv>
+  <refname>SetCDRUserField</refname>
+  <refpurpose>
+   Set the CDR user field [deprecated]
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1>
+  <title>Description</title>
+   <methodsynopsis>
+    <methodname>SetCDRUserField</methodname>
+    <methodparam><type>string</type><parameter>value</parameter></methodparam>
+   </methodsynopsis>
+
+   <para>
+    This application is deprecated since Asterisk 1.0.9, use
+    <function>Set</function> to set the CDR User field.
+    <example>
+     <title>Setting the CDR User field</title>
+     <programlisting role="astconf">
+ <![CDATA[
+ ; Set the CDR User field to "Value"
+ exten => s,1,Set(CDR(userfield)=Value)
+ ]]>
+     </programlisting>
+    </example>
+   </para>
+
+   <para>
+    The Call Data Record (CDR) user field is an extra field you can use for
+    data not stored anywhere else in the record.  CDR records can be used for
+    billing or storing other arbitrary data (I.E. telephone survey responses)
+  </para>
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

Added: en/reference/billing/reference.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/billing/reference.xml?rev=6&view=auto
==============================================================================
--- en/reference/billing/reference.xml (added)
+++ en/reference/billing/reference.xml Tue May  9 13:18:59 2006
@@ -1,0 +1,44 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.16 $ -->
+<!-- Purpose: basic.text -->
+<!-- Membership: bundled -->
+
+<reference id="ref.billing">
+  <title>Billing</title>
+  <titleabbrev>Billing</titleabbrev>   
+
+  <partintro>
+   <section id="billing.intro">
+    &reftitle.intro;
+    <para>
+     Applications that manage billing records.
+    </para>
+   </section>
+   
+  </partintro>
+
+&reference.billing.functions;
+
+</reference>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+

Modified: entities/builtin-extensions.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/builtin-extensions.xml?rev=6&r1=5&r2=6&view=diff
==============================================================================
--- entities/builtin-extensions.xml (original)
+++ entities/builtin-extensions.xml Tue May  9 13:18:59 2006
@@ -3,6 +3,7 @@
 <part id='funcref'>
  <title>&FunctionReference;</title>
    &reference.agi.reference;
+   &reference.billing.reference;
    &reference.callmgmt.reference;
    &reference.flowcontrol.reference;
    &reference.general.reference;

Modified: entities/file-entities.ent
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/file-entities.ent?rev=6&r1=5&r2=6&view=diff
==============================================================================
--- entities/file-entities.ent (original)
+++ entities/file-entities.ent Tue May  9 13:18:59 2006
@@ -53,6 +53,15 @@
 <!ENTITY reference.general.functions.system       SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/functions/system.xml'>
 <!ENTITY reference.general.functions.trysystem    SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/functions/trysystem.xml'>
 <!ENTITY reference.general.functions              SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/functions.xml'>
+<!ENTITY reference.billing.functions              SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions.xml'>
+<!ENTITY reference.billing.functions.forkcdr      SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions/forkcdr.xml'>
+<!ENTITY reference.billing.functions.setamaflags  SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions/setamaflags.xml'>
+<!ENTITY reference.billing.functions.nocdr        SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions/nocdr.xml'>
+<!ENTITY reference.billing.functions.appendcdruserfield SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions/appendcdruserfield.xml'>
+<!ENTITY reference.billing.functions.resetcdr     SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions/resetcdr.xml'>
+<!ENTITY reference.billing.functions.setcdruserfield SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions/setcdruserfield.xml'>
+<!ENTITY reference.billing.reference              SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/reference.xml'>
+<!ENTITY reference.billing.functions              SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/billing/functions.xml'>
 <!ENTITY config.intro                             SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/config/intro.xml'>
 <!ENTITY config.extensions                        SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/config/extensions.xml'>
 <!ENTITY config.voicemail                         SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/config/voicemail.xml'>

Modified: entities/version.ent
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/version.ent?rev=6&r1=5&r2=6&view=diff
==============================================================================
--- entities/version.ent (original)
+++ entities/version.ent Tue May  9 13:18:59 2006
@@ -1,1 +1,1 @@
-<!ENTITY php.build-date "2006-05-08">
+<!ENTITY php.build-date "2006-05-09">



More information about the asterisk-doc mailing list