Toolpack:Enabling CDR A - Revision history

Lucas Trottier at 14:07, 25 April 2016

2016-04-25T14:07:02Z

← Older revision		Revision as of 10:07, 25 April 2016
Line 14:		Line 14:
	3- Configure the CDR behavior in the '''CDR Options''' section:		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.		* '''Enable periodic CDR update''' will add one entry in the CDR per '''Periodic CDR update time''', in minutes.
	* Select a '''Text CDR''' mode from the '''CDR Mode''' :		* 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]]		**'''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]]		**'''RADIUS CDR only''': Will send the CDR to an external RADIUS Server. See [[RADIUS\|Radius CDR]]

Lucas Trottier at 14:05, 25 April 2016

2016-04-25T14:05:38Z

← Older revision		Revision as of 10:05, 25 April 2016
Line 14:		Line 14:
	3- Configure the CDR behavior in the '''CDR Options''' section:		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.		* '''Enable periodic CDR update''' will add one entry in the CDR per '''Periodic CDR update time''', in minutes.
	* Select ~~the~~ '''CDR ~~Mode~~''' ~~for~~ '''~~Text~~ CDR''':		* Select a '''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]]		**'''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]]		**'''RADIUS CDR only''': Will send the CDR to an external RADIUS Server. See [[RADIUS\|Radius CDR]]

Lucas Trottier: Update CDR Mode

2016-04-25T14:00:20Z

Update CDR Mode

← Older revision		Revision as of 10:00, 25 April 2016
Line 11:		Line 11:

	2- Select '''Use CDR behavior''' to enable it.		2- Select '''Use CDR behavior''' to enable it.
	* Expand the '''CDR Options''' section
	* ~~For~~ '''CDR Mode'''~~, select~~ '''Text CDR ~~Only~~'''		3- Configure the CDR behavior in the '''CDR Options''' section:
	* Click '''Save'''.		* '''Enable periodic CDR update''' will add one entry in the CDR per '''Periodic CDR update time''', in minutes.
			* Select the '''CDR Mode''' for '''Text CDR''':
			**'''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.

Cbilodeau: move default values to parameters

2013-07-23T13:12:53Z

move default values to parameters

← Older revision		Revision as of 09:12, 23 July 2013
Line 31:		Line 31:
	* [[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]]


	~~'''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}'

Allyntree: /* List of Parameters */

2013-07-22T14:44:20Z

List of Parameters

← Older revision		Revision as of 10:44, 22 July 2013
Line 31:		Line 31:
	* [[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.

Allyntree: /* Applies to version(s): v2.7 */

2013-07-22T14:37:29Z

Applies to version(s): v2.7

← Older revision		Revision as of 10:37, 22 July 2013
Line 11:		Line 11:

	2- Select '''Use CDR behavior''' to enable it.		2- Select '''Use CDR behavior''' to enable it.
	*Expand the '''CDR Options''' section		* Expand the '''CDR Options''' section
	*For '''CDR Mode''', select '''Text CDR Only'''		* For '''CDR Mode''', select '''Text CDR Only'''
			* Click '''Save'''.

	[[File:Cdr_0_0.png]]		[[File:Cdr_0_0.png]]

Allyntree: /* Applies to version(s): v2.7 */

2013-07-22T14:36:53Z

Applies to version(s): v2.7

← Older revision		Revision as of 10:36, 22 July 2013
Line 12:		Line 12:
	2- Select '''Use CDR behavior''' to enable it.		2- Select '''Use CDR behavior''' to enable it.
	*Expand the '''CDR Options''' section		*Expand the '''CDR Options''' section
	*In CDR Mode, select '''Text CDR'''		*For '''CDR Mode''', select '''Text CDR Only'''

	[[File:Cdr_0_0.png]]		[[File:Cdr_0_0.png]]

Allyntree: /* Applies to version(s): v2.7 */

2013-07-22T14:35:51Z

Applies to version(s): v2.7

← Older revision		Revision as of 10:35, 22 July 2013
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.

Allyntree: /* Applies to version(s): v2.7 */

2013-07-22T14:35:26Z

Applies to version(s): v2.7

← Older revision		Revision as of 10:35, 22 July 2013
Line 11:		Line 11:

	[[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		*Expand the '''CDR Options''' section
	*In CDR Mode, select '''Text CDR'''		*In CDR Mode, select '''Text CDR'''
	*Expand the '''Text CDR parameters''' section
	*Configure the '''Text CDR parameters''' the way you want, using the parameters describe below

	[[File:Cdr_0_0.png]]		[[File:Cdr_0_0.png]]


	3- Expand the '''Text CDR parameters''' section		3- Expand the '''Text CDR parameters''' section

Allyntree at 14:34, 22 July 2013

2013-07-22T14:34:07Z

← Older revision		Revision as of 10:34, 22 July 2013
Line 18:		Line 18:
	*Configure the '''Text CDR parameters''' the way you want, using the parameters describe below		*Configure the '''Text CDR parameters''' the way you want, using the parameters describe below

	[[File:~~CDR_Mode_2_6~~.~~jpg~~]]		[[File:Cdr_0_0.png]]

			3- Expand the '''Text CDR parameters''' section
			* Configure the '''Text CDR parameters''' as required. Refer to the description of parameters described below.

	[[File:Text_CDR_Parameters.jpg]]		[[File:Text_CDR_Parameters.jpg]]

	==Parameters==		==List of Parameters==

			* [[Parameter: CDR log file path\|CDR log file path]]
			* [[Parameter: CDR format (start)\|CDR format (start)]]
			* [[Parameter: CDR format (update)\|CDR format (update)]]
			* [[Parameter: CDR format (end)\|CDR format (end)]]
			* [[Parameter: Rotation delay in seconds\|Rotation delay in seconds]]
			* [[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 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 (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).
Line 36:		Line 46:
	CDR log file path:		CDR log file path:
	cdr_logs/cdr		cdr_logs/cdr



	CDR format (start):		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}'		@{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):		CDR format (update):
	@{Timestamp:%Y-%m-%d %H:%M:%S.@m%z}:UPD,SessionId='@{SessionId}',LegId='@{LegId}'		@{Timestamp:%Y-%m-%d %H:%M:%S.@m%z}:UPD,SessionId='@{SessionId}',LegId='@{LegId}'


	CDR format (end):		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}'		@{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}'