Skip to content

Commit

Permalink
acc: docs for cdr_on_failed parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Apr 8, 2015
1 parent 625b094 commit 0e30a2d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 10 deletions.
33 changes: 25 additions & 8 deletions modules/acc/README
Expand Up @@ -134,6 +134,7 @@ Sven Knoblich
6.51. time_format (str)
6.52. reason_from_hf (int)
6.53. clone_msg (int)
6.54. cdr_on_failed (int)

7. Functions

Expand Down Expand Up @@ -199,10 +200,11 @@ Sven Knoblich
1.51. time_format example
1.52. reason_from_hf
1.53. clone_msg
1.54. acc_log_request usage
1.55. acc_db_request usage
1.56. acc_rad_request usage
1.57. acc_diam_request usage
1.54. cdr_on_failed
1.55. acc_log_request usage
1.56. acc_db_request usage
1.57. acc_rad_request usage
1.58. acc_diam_request usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -300,6 +302,7 @@ Chapter 1. Admin Guide
6.51. time_format (str)
6.52. reason_from_hf (int)
6.53. clone_msg (int)
6.54. cdr_on_failed (int)

7. Functions

Expand Down Expand Up @@ -721,6 +724,7 @@ $dlg_var(callee) = $avp(callee); #callee='C'
6.51. time_format (str)
6.52. reason_from_hf (int)
6.53. clone_msg (int)
6.54. cdr_on_failed (int)

6.1. early_media (integer)

Expand Down Expand Up @@ -1406,6 +1410,19 @@ modparam("acc", "reason_from_hf", 1)
modparam("acc", "clone_msg", 0)
...

6.54. cdr_on_failed (int)

If set to 1, the module stores the CDR for a failed dialog (calls not
answered). If set to 0, those records are not stored, only those for
answered calls.

Default value is 1.

Example 1.54. cdr_on_failed
...
modparam("acc", "cdr_on_failed", 0)
...

7. Functions

7.1. acc_log_request(comment)
Expand All @@ -1426,7 +1443,7 @@ modparam("acc", "clone_msg", 0)

This function can be used from ANY_ROUTE.

Example 1.54. acc_log_request usage
Example 1.55. acc_log_request usage
...
acc_log_request("Some comment");
$var(code) = 404;
Expand All @@ -1448,7 +1465,7 @@ acc_log_request("$var(code) Error: $avp(reason)");

This function can be used from ANY_ROUTE.

Example 1.55. acc_db_request usage
Example 1.56. acc_db_request usage
...
acc_db_request("Some comment", "SomeTable");
acc_db_request("Some comment", "acc_$time(year)_$time(mon)");
Expand All @@ -1466,7 +1483,7 @@ acc_db_request("$var(code) Error: $avp(reason)", "SomeTable");

This function can be used from ANY_ROUTE.

Example 1.56. acc_rad_request usage
Example 1.57. acc_rad_request usage
...
acc_rad_request("Some comment");
acc_rad_request("$var(code) Error: $avp(reason)");
Expand All @@ -1483,7 +1500,7 @@ acc_rad_request("$var(code) Error: $avp(reason)");

This function can be used from ANY_ROUTE.

Example 1.57. acc_diam_request usage
Example 1.58. acc_diam_request usage
...
acc_diam_request("Some comment");
acc_diam_request("$var(code) Error: $avp(reason)");
Expand Down
23 changes: 21 additions & 2 deletions modules/acc/doc/acc_admin.xml
Expand Up @@ -390,7 +390,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
<section>
<title>Overview</title>
<para>
As mentioned in <xref linkend="multi-call-legs"/>, a leg represents a parallel
As mentioned in <xref linkend="acc.i.multi-call-legs"/>, a leg represents a parallel
or forwarded call. In contrast to the normal accounting the cdr logging uses dialogs
instead of transaction to log data. This may reduce the amount of information
but it also make it possible to combine all important data in one cdr at
Expand Down Expand Up @@ -642,7 +642,7 @@ modparam("acc", "acc_prepare_flag", 5)
<title><varname>multi_leg_info</varname> (string)</title>
<para>
Defines the AVP set to be used in per-call-leg accounting.
See <xref linkend="multi-call-legs"/> for a
See <xref linkend="acc.i.multi-call-legs"/> for a
detailed description of the Multi Call-Legs accounting.
</para>
<para>
Expand Down Expand Up @@ -1539,6 +1539,25 @@ modparam("acc", "reason_from_hf", 1)
...
modparam("acc", "clone_msg", 0)
...
</programlisting>
</example>
</section>
<section id="acc.p.cdr_on_failed">
<title><varname>cdr_on_failed</varname> (int)</title>
<para>
If set to 1, the module stores the CDR for a failed dialog (calls not
answered). If set to 0, those records are not stored, only those for
answered calls.
</para>
<para>
Default value is 1.
</para>
<example>
<title>cdr_on_failed</title>
<programlisting format="linespecific">
...
modparam("acc", "cdr_on_failed", 0)
...
</programlisting>
</example>
</section>
Expand Down

0 comments on commit 0e30a2d

Please sign in to comment.