CDR Build Module - Revision history

Dana: /* Section [parameters] */

2014-01-13T13:22:51Z

‎Section [parameters]

Dana: /* Section [parameters] */

2014-01-13T13:22:02Z

‎Section [parameters]

Dana at 10:28, 13 January 2014

2014-01-13T10:28:16Z

Dana: /* Section [parameters] */

2014-01-11T07:06:59Z

‎Section [parameters]

Dana: /* Section [parameters] */

2014-01-10T18:44:17Z

‎Section [parameters]

Dana: /* Section [parameters] */

2014-01-10T18:28:48Z

‎Section [parameters]

Dana at 18:26, 10 January 2014

2014-01-10T18:26:21Z

Dana at 18:24, 10 January 2014

2014-01-10T18:24:42Z

Dana: /* Configuration */

2014-01-10T13:25:32Z

‎Configuration

Dana: /* The result of the module */

2014-01-10T12:17:40Z

‎The result of the module

@@ Line 49: / Line 49: @@
 :* '''operation''': one of initialize, update or finalize depending on the state of the CDR being signalled out
 :* '''cdrwrite''': true or false specify if the CDR will be written or not
-:* '''cdrtrack''': default true, if false he will not track the CDR
+:* '''cdrtrack''': default true, if false the CDR will not be track
 :* '''cdrcreate''': default true, if set o false the CDR will not be build
 :* '''cdrid''': the channel ID for CDR

@@ Line 36: / Line 36: @@
 :The following parameters are handled by default but you can overwrite them:
-:*'''billid'''=true ( will hold the billing ID )
+:*'''billid'''=true ( will hold the billing ID. Billid is created from stitching the value of runid with the value cdrid )
 :*'''reason'''=true  ( a (mostly) human readable reason for this CDR )
 :*'''address'''=false ( channel endpoint address being involved in this CDR )
@@ Line 49: / Line 49: @@
 :* '''operation''': one of initialize, update or finalize depending on the state of the CDR being signalled out
 :* '''cdrwrite''': true or false specify if the CDR will be written or not
-:* '''cdrtrack''':
+:* '''cdrtrack''': default true, if false he will not track the CDR
-:* '''cdrcreate''':
+:* '''cdrcreate''': default true, if set o false the CDR will not be build
-:* '''cdrid''':
+:* '''cdrid''': the channel ID for CDR
-:* '''runid''':
+:* '''runid''': running ID of Yate
-:* '''direction''':either of incoming or outgoing, Yate instance-wise (i.e. a call coming into the Yate instance emitting this CDR will have incoming here and a call being generated from the Yate instance in question will have outgoing here)
+:* '''direction''': either of incoming or outgoing, Yate instance-wise (i.e. a call coming into the Yate instance emitting this CDR will have incoming here and a call being generated from the Yate instance in question will have outgoing here)
 :* '''status''': one of incoming, outgoing, ringing, answered or connected, reflecting the current state of the call referred to by this CDR
-:* '''duration''':end-to-end time (in seconds) of the call described in this CDR (i.e. from the moment the last digit was dialed on the calling side until the moment the line was hung up)
+:* '''duration''': end-to-end time (in seconds) of the call described in this CDR (i.e. from the moment the last digit was dialed on the calling side until the moment the line was hung up)
-:* '''billtime''':effective payable time (in seconds) of the call described in this CDR (i.e. from the moment the line was picked up on the called side until the moment the line was hung up)
+:* '''billtime''': effective payable time (in seconds) of the call described in this CDR (i.e. from the moment the line was picked up on the called side until the moment the line was hung up)
-:* '''ringtime''':ringing time (in seconds) of the call described in this CDR (i.e. from the moment the routing decision has been taken and the remote endpoint alerted of the incoming call until the moment the line was picked up on the called side)
+:* '''ringtime''': ringing time (in seconds) of the call described in this CDR (i.e. from the moment the routing decision has been taken and the remote endpoint alerted of the incoming call until the moment the line was picked up on the called side)
   '''Note:''' in order for a parameter to appear in the call.cdr messages it has to be received in at least one of the messages handled by this module.

@@ Line 4: / Line 4: @@
 Cdrbuild module generates CDR per channel not like [[CDRcombine_Module|cdrcombine]] that generates CDR per call.
-The cdrbuild module is loaded by default unless yate.conf file is used to load modules in Yate.
+The cdrbuild module is loaded by default unless yate.conf file is used to load only specific modules in Yate.
 === The configuration file===
@@ Line 32: / Line 32: @@
 ====Section [parameters]====
-In this section the possible values for the parameters that can be set, are true or false. This allows or disallows to overwrites their initial value.<br>
+In this section the possible values for the parameters that can be set, are true or false. This allows or disallows to overwrite their initial value.<br>
 There are 2 types of parameters in this section, the ones that can be overwritten and the ones that are handled internally and they can not be changed.<br> Also this is where you can add your own monitored parameters that will appear in "[[call.cdr]]".

@@ Line 38: / Line 38: @@
 :*'''billid'''=true ( will hold the billing ID )
 :*'''reason'''=true  ( a (mostly) human readable reason for this CDR )
-:*'''address'''=false ( module-specific channel endpoint address being involved in this CDR )
+:*'''address'''=false ( channel endpoint address being involved in this CDR )
-:*'''caller'''=false ( module-specific caller party ID )
+:*'''caller'''=false ( caller party ID )
-:*'''called'''=false ( module-specific called party ID )
+:*'''called'''=false ( called party ID )
-:*'''calledfull'''=false
+:*'''calledfull'''=false ( full called party ID )
-:*'''username'''=false
+:*'''username'''=false (  username of the caller party ID )
 :The following parameters are handled internally and cannot be changed:
@@ Line 48: / Line 48: @@
 :* '''chan''': module and module-specific channel name being involved in this CDR
 :* '''operation''': one of initialize, update or finalize depending on the state of the CDR being signalled out
-:* '''cdrwrite''':
+:* '''cdrwrite''': true or false specify if the CDR will be written or not
 :* '''cdrtrack''':
 :* '''cdrcreate''':

@@ Line 36: / Line 36: @@
 :The following parameters are handled by default but you can overwrite them:
-:*'''billid'''=true
+:*'''billid'''=true ( will hold the billing ID )
-:*'''reason'''=true
+:*'''reason'''=true  ( a (mostly) human readable reason for this CDR )
-:*'''address'''=false
+:*'''address'''=false ( module-specific channel endpoint address being involved in this CDR )
-:*'''caller'''=false
+:*'''caller'''=false ( module-specific caller party ID )
-:*'''called'''=false
+:*'''called'''=false ( module-specific called party ID )
 :*'''calledfull'''=false
 :*'''username'''=false
 :The following parameters are handled internally and cannot be changed:
-:* '''time, chan, operation, cdrwrite, cdrtrack, cdrcreate, cdrid, runid, direction, status, duration, billtime, ringtime'''
+:* '''time''': UNIX time and date when the CDR has been initially generated
   '''Note:''' in order for a parameter to appear in the call.cdr messages it has to be received in at least one of the messages handled by this module.

@@ Line 1: / Line 1: @@
 Cdrbuild module is the module that builds live CDRs (call detail records) and creates a list for the calls that can be interrogated using telnet command [[CDR_Build_Module#Rmanager_command|status]].<br/>
 Cdrbuild module reads messages from other channel modules ([[H323_channel_module|h323chan]], [[SIP_Configuration_File|ysipchan]], [[IAX|iaxchan]]) about calls and builds the CDR.<br/>
-Then it sends the "[[call.cdr]]" message. This message is caught by different [[Modules#CDR modules|cdr modules]] that intend to write in different mediums ([[CDR_File_Module#Configuration|cdrfile]] in file, [[Register#Section_.5Bcall.cdr.5D|register]] that writes in database).<br/>
+Then it sends the "[[call.cdr]]" message. This message is caught by different [[Modules#CDR modules|cdr modules]] that intend to write in different mediums ([[CDR_File_Module#Configuration|cdrfile]] writes in file, [[Register#Section_.5Bcall.cdr.5D|register]] that writes in database).<br/>
-Cdrbuild module generates CDR per channel not like [[cdrcombine]] that generates CDR per call.
+Cdrbuild module generates CDR per channel not like [[CDRcombine_Module|cdrcombine]] that generates CDR per call.
 The cdrbuild module is loaded by default unless yate.conf file is used to load modules in Yate.

@@ Line 9: / Line 9: @@
 ===Configuration===
-The file used in configuration is cdrbuild.conf. See below the sections and their description.
+The file used by this module for configuration is cdrbuild.conf. See below the sections and their description.
 ==== Section [general] ====

@@ Line 96: / Line 96: @@
 === The result of the module ===
-The operation on CDRs to be performed is indicated by the operation parameter that can be one of:
+The result of the module is sending the call.cdr message. One of the essential parameters of this message is "operation" parameter.<br/>
 * '''initialize''' - the first call.cdr message generated for the channel.
@@ Line 102: / Line 105: @@
 * '''finalize''' - last call.cdr message generated for the channel holding the final information on the call leg, this is the only one used by the cdrfile module.
-Another module that catches the call.cdr message for the same operations described above is [[CDRcombine Module]] and will emit call.cdr message with operation "combine" at the end of the call. Cdrcombine module unifies the information about the call and for the 2 call legs only a single entry will be written.
+One of the modules that catches the call.cdr message for the same operations described above is [[CDRcombine Module]] and will emit call.cdr message with operation "combine" at the end of the call. Cdrcombine module unifies the information about the call and for the 2 call legs only a single entry will be written.
 ===Rmanager command===