Toolpack:Enabling CDR A

From TBwiki
(Difference between revisions)
Jump to: navigation, search
 
(8 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
{{DISPLAYTITLE:Toolpack: Enabling CDR}}
 
{{DISPLAYTITLE:Toolpack: Enabling CDR}}
  
 
Text CDR functionality is enabled through the Toolpack Web Portal.
 
  
 
'''''To enable CDR:'''''
 
'''''To enable CDR:'''''
----
 
  
 
1- Select '''Gateway''' from the navigation panel.
 
1- Select '''Gateway''' from the navigation panel.
  
 
[[Image:Cdr_0.png|border]]
 
[[Image:Cdr_0.png|border]]
 +
  
 
2- Select '''Use CDR behavior''' to enable it.
 
2- Select '''Use CDR behavior''' to enable it.
*Expand the '''CDR Options''' section
+
 
*In CDR Mode, select '''Text CDR'''
+
3- Configure the CDR behavior in the '''CDR Options''' section:
*Expand the '''Text CDR parameters''' section
+
* '''Enable periodic CDR update''' will add one entry in the CDR per '''Periodic CDR update time''', in minutes.
*Configure the '''Text CDR parameters''' the way you want, using the parameters describe below
+
* Select one of the '''Text CDR''' mode from the '''CDR Mode''' :
 +
**'''Text CDR only''': Will store the CDRs in a flat file. See [[Text Call Detail Records (CDR)|Text CDR]]
 +
**'''RADIUS CDR only''': Will send the CDR to an external RADIUS Server. See [[RADIUS|Radius CDR]]
 +
**'''Text and RADIUS CDR''': Will store the CDRs in a flat file and send the CDR to an external RADIUS Server.
 +
**'''RADIUS CDR with Text CDR Fallback''': Will send the CDR to an external RADIUS Server and if the RADIUS server cannot handle the load of CDRs, they will be stored in a flat file.
 +
 
 +
* Click '''Save''' to save your changes.
  
 
[[File:Cdr_0_0.png]]
 
[[File:Cdr_0_0.png]]
  
3- Expand the '''Text CDR parameters''' section
+
 
 +
4- Expand the '''Text CDR parameters''' section
 
* Configure the '''Text CDR parameters''' as required. Refer to the description of parameters described below.
 
* Configure the '''Text CDR parameters''' as required. Refer to the description of parameters described below.
  
Line 33: Line 38:
 
* [[Parameter: Rotation delay in seconds|Rotation delay in seconds]]
 
* [[Parameter: Rotation delay in seconds|Rotation delay in seconds]]
 
* [[Parameter: Max total size of gzipped CDR logs|Max total size of gzipped CDR logs]]
 
* [[Parameter: Max total size of gzipped CDR logs|Max total size of gzipped CDR logs]]
 
*'''CDR log file path''': Path of the CDR log file, relative to the current working directory of the Gateway application (e.g.[...]/toolpack/setup/12358/[major version]/apps/gateway).
 
*'''CDR format (start)''': Format of the text CDR log written at the time the call is answered (or terminated if it was never answered). This format contains variables automatically replaced (see below).
 
*'''CDR format (update)''': Format of the text CDR log written periodically during call if the CDR option '''Enable periodic CDR update''' is used. This format contains variables automatically replaced (see below).
 
*'''CDR format (end)''': Format of the text CDR log written at the time the call is terminated. This format contains variables automatically replaced (see below).
 
*'''Rotation delay in seconds''': Delay, in seconds, at which the log file is rotated and gzipped. A delay of 3600 seconds will make log file rotate every hour, for example. '''NOTE''': This parameter cannot be larger then 86400 seconds (1 day). A value of 0 will be considered equivalent to the maximum value.
 
*'''Max total size of gzipped CDR logs''': Maximum total size (in bytes) of all gzipped log file segments on disk. If ever total size exceeds this limit, older gzipped log files will be deleted. A value of 0 will be considered as unlimited size.
 
 
 
'''Advanced Parameters'''
 
 
CDR log file path:
 
cdr_logs/cdr
 
 
CDR format (start):
 
@{Timestamp:%Y-%m-%d %H:%M:%S.@m%z},BEG,SessionId='@{SessionId}',LegId='@{LegId}',StartTime='@{StartTime}',ConnectedTime='@{ConnectedTime}',Calling='@{CallingNumber}',Called='@{CalledNumber}',NAP='@{NAP}',Protocol='@{Protocol}',Direction='@{OrginatorName}'
 
 
CDR format (update):
 
@{Timestamp:%Y-%m-%d %H:%M:%S.@m%z}:UPD,SessionId='@{SessionId}',LegId='@{LegId}'
 
 
CDR format (end):
 
@{Timestamp:%Y-%m-%d %H:%M:%S.@m%z},END,SessionId='@{SessionId}',LegId='@{LegId}',StartTime='@{StartTime}',ConnectedTime='@{ConnectedTime}',EndTime='@{EndTime}',FreedTime='@{Timestamp}',TerminationCause='@{TerminationCauseString}',TerminationSource='@{TerminationSource}',Calling='@{CallingNumber}',Called='@{CalledNumber}',NAP='@{NAP}',Direction='@{OrginatorName}'
 

Latest revision as of 09:07, 25 April 2016

Applies to version(s): v2.7

To enable CDR:

1- Select Gateway from the navigation panel.

Cdr 0.png


2- Select Use CDR behavior to enable it.

3- Configure the CDR behavior in the CDR Options section:

  • Enable periodic CDR update will add one entry in the CDR per Periodic CDR update time, in minutes.
  • Select one of the Text CDR mode from the CDR Mode :
    • Text CDR only: Will store the CDRs in a flat file. See Text CDR
    • RADIUS CDR only: Will send the CDR to an external RADIUS Server. See Radius CDR
    • Text and RADIUS CDR: Will store the CDRs in a flat file and send the CDR to an external RADIUS Server.
    • RADIUS CDR with Text CDR Fallback: Will send the CDR to an external RADIUS Server and if the RADIUS server cannot handle the load of CDRs, they will be stored in a flat file.
  • Click Save to save your changes.

Cdr 0 0.png


4- Expand the Text CDR parameters section

  • Configure the Text CDR parameters as required. Refer to the description of parameters described below.

Text CDR Parameters.jpg

List of Parameters

Personal tools