Jump to: navigation, search

GVP MCP:msml:record-filenametemplate

m (1 revision imported)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
----
+
{{PubOption
−
__NOTOC__
 
−
 
 
−
<!-- ==================== -->
 
−
<!-- DO NOT EDIT -->
 
−
=Published=
 
−
{{Optionstmp
 
−
|internalformid=1 (DO NOT EDIT THIS VALUE)
 
−
|fromxml=true
 
−
|docstatus=Published
 
−
|fromxml=true
 
−
|parameter=record.filenametemplate
 
−
|urlparameter=record-filenametemplate
 
−
|displayname=Template for generating MSML recording file name
 
 
|hidden=false
 
|hidden=false
 
|default=$id$
 
|default=$id$
−
|valid=
+
|valid=Please specify a valid template following the instructions in the description.
 
|takeseffect=Immediately
 
|takeseffect=Immediately
−
|shortdesc=This parameter specifies the default template for generating MSML recording file name. Any gvp:param present in the template is replaced with its value if specified using MSML. The parameters AWSAccessKeyId(2), callrec_authorization, httpauthorization(2) and AWSSecretAccessKey(2) are not replaced by their value even if specified using MSML due to security concerns. Example:- The template "$id$_$record$_$MCPDateTime" produces the file name "basirecid12345_source_2013-09-13_08-10-15_*.*" where id is specified as "basicrecid12345" and record is specified as "source" using MSML gvp:param. Using parameter $MCPDateTime enables insertion of MCP local time in the generated file name. Note that there is a 260 character limit(including directory names and extension) for the recording filename on Windows.
+
|shortdesc=This parameter specifies the default template for generating MSML recording (aka GIR-Recording) and IVR-Recording file names.
−
|section=msml
+
 
−
|urlsection=msml
+
For MSML recording (GIR-Recording):
−
|groupid=grpMSML
+
- Any gvp:param present in the template may be replaced by its value if specified using MSML.
−
|groupname=MSML
+
- Some possible template parameters: $id$, $dateTime$, $MCPDateTime$, $dnis$, $recordDN$, $ani$, $callUuid$, $sipsAppName$, $connId$, $record$, $dest$, $dest2$, $type$, $type2$, $channels$, $channels2$, $AWSRegion$, $AWSRegion2$, $callrec_dest$, $audiosrc$, $tonesilenceduration$, and any other gvp:param present in MSML.
−
|format=string
+
- Example: The template $id$_$record$_$MCPDateTime$ produces the file name "basicrecid12345_source_2013-09-13_08-10-15_*.*" where $id$ is specified as "basicrecid12345", $record$ is specified as "source" using MSML gvp:param and $MCPDateTime$ enables insertion of MCP local time.
−
|prodshort=GVP
 
−
|component=GVP_MCP
 
−
|compshort=MediaControlPlatform
 
−
}}
 
−
[[Category:GVP_MCP_options]]
 
  
−
<!-- DO NOT EDIT -->
+
For IVR-Recording:
−
<!-- ==================== -->
+
- Some of the parameters passed in the INVITE RURI are accepted.
 +
- Possible template parameters: $id$, $dateTime$, $MCPDateTime$, $dnis$, $recordDN$, $ani$, $callUuid$ and $sipsAppName$.
 +
- The $id$ template is equivalent to $callUuid$_$dateTime$ template. The date and time used is in UTC mode retrieved from the MCP machine.
 +
- Example: The template $callUuid$_$MCPDateTime$ produces the file name "SDFGTRE3456YHBVFT543_2018-04-26_13-33-46_*.*" where "SDFGTRE3456YHBVFT543" is the SIP header XGENESYSCALLUUID value and $MCPDateTime$ enables insertion of MCP local time.
  
−
==Extended Description==
+
Notes:
 +
- The template $dateTime$ is replaced by the UTC time, and $MCPDateTime$ is replaced by the local time from the MCP machine.
 +
- There is a 260 character limit (including directory names and extension) for the recording file name on Windows.
 +
- Parameters are case sensitive.
  
−
{{Extended
+
}}
−
|internalformid=1 (DO NOT EDIT THIS VALUE)
+
{{DraftOption
−
|docstatus=
 
−
|mandatory=
 
−
|introduced=
 
−
|modified=
 
−
|discontinued=
 
−
|feature=
 
−
|relatedoptions=
 
−
|relatedlinks=
 
−
|configobject=
 
−
|moredesc=
 
 
}}
 
}}
  
−
=Draft=
+
{{PubExtended}}
  
−
{{Optionstmp
+
{{DraftExtended
−
|internalformid=2 (DO NOT EDIT THIS VALUE)
+
}}
−
|docstatus=
 
−
|parameter=
 
−
|displayname=
 
−
|hidden=
 
−
|default=
 
−
|valid=
 
−
|takeseffect=
 
−
|shortdesc=
 
−
|section=
 
−
|groupid=
 
−
|groupname=
 
−
|format=
 
−
|prodshort=
 
−
}}  
 
  
−
==Extended Description==
+
{{OptionCreate
 +
|component=GVP_MCP
 +
|compshort=GVP_MCP
 +
|prodshort=GVP
 +
|configobject=Application
 +
|section=msml
 +
|parameter=record.filenametemplate
 +
|groupid=grpMSML
 +
|groupname=MSML
 +
|format=string
 +
|displayname=Template for generating MSML recording file name
 +
}}
  
−
{{Extended
+
[[Category:GVP_MCP_options]]
−
|internalformid=2 (DO NOT EDIT THIS VALUE)
 
−
|docstatus=
 
−
|mandatory=
 
−
|introduced=
 
−
|modified=
 
−
|discontinued=
 
−
|feature=
 
−
|relatedoptions=
 
−
|relatedlinks=
 
−
|configobject=
 
−
|moredesc=
 
−
}}
 

Latest revision as of 16:11, June 29, 2020



View in ref guide.

Edit this option          Publish this option          Clear draft content


Published Option

record.filenametemplate

Default Value: $id$
Valid Values: Please specify a valid template following the instructions in the description.
Changes Take Effect: Immediately


This parameter specifies the default template for generating MSML recording (aka GIR-Recording) and IVR-Recording file names.

For MSML recording (GIR-Recording): - Any gvp:param present in the template may be replaced by its value if specified using MSML. - Some possible template parameters: $id$, $dateTime$, $MCPDateTime$, $dnis$, $recordDN$, $ani$, $callUuid$, $sipsAppName$, $connId$, $record$, $dest$, $dest2$, $type$, $type2$, $channels$, $channels2$, $AWSRegion$, $AWSRegion2$, $callrec_dest$, $audiosrc$, $tonesilenceduration$, and any other gvp:param present in MSML. - Example: The template $id$_$record$_$MCPDateTime$ produces the file name "basicrecid12345_source_2013-09-13_08-10-15_*.*" where $id$ is specified as "basicrecid12345", $record$ is specified as "source" using MSML gvp:param and $MCPDateTime$ enables insertion of MCP local time.

For IVR-Recording: - Some of the parameters passed in the INVITE RURI are accepted. - Possible template parameters: $id$, $dateTime$, $MCPDateTime$, $dnis$, $recordDN$, $ani$, $callUuid$ and $sipsAppName$. - The $id$ template is equivalent to $callUuid$_$dateTime$ template. The date and time used is in UTC mode retrieved from the MCP machine. - Example: The template $callUuid$_$MCPDateTime$ produces the file name "SDFGTRE3456YHBVFT543_2018-04-26_13-33-46_*.*" where "SDFGTRE3456YHBVFT543" is the SIP header XGENESYSCALLUUID value and $MCPDateTime$ enables insertion of MCP local time.

Notes: - The template $dateTime$ is replaced by the UTC time, and $MCPDateTime$ is replaced by the local time from the MCP machine. - There is a 260 character limit (including directory names and extension) for the recording file name on Windows. - Parameters are case sensitive.

Draft Option

No draft option

This page was last edited on June 29, 2020, at 16:11.
Comments or questions about this documentation? Contact us for support!