Reference10:Voice Recorder/Setup: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
mNo edit summary
 
(48 intermediate revisions by 8 users not shown)
Line 7: Line 7:
The software was developed under Win7 but should operate also using windows Server (while the player software is not running without special setups using windows server).
The software was developed under Win7 but should operate also using windows Server (while the player software is not running without special setups using windows server).


The recorder requires reporting Version 10, Build 10043 or higher.
The recorder requires reporting Version 10, Build 1134 or higher.


The recorder requires working Reporting software. The reporting can work on a physical gateway or on a VMware environment (even on a player). See relative articles how to setup the reporting tool.
The recorder requires working Reporting software. The reporting can work on a physical gateway or on a VMware environment (even on a player). See relative articles how to setup the reporting tool.
Line 21: Line 21:




[[Image:RecSetup01.png]]
[[Image:RecSetup21.png]]


== GROUP GENERAL ==
== General ==


=== Recorder Name ===
=== Recorder Name ===
Line 33: Line 33:
Password of this setup, if blank no password is asked to access to this setup. Please note that this password is also the default password for the player and can therefore be an important security feature.
Password of this setup, if blank no password is asked to access to this setup. Please note that this password is also the default password for the player and can therefore be an important security feature.


=== Start in Taskbar ===
=== Customer Key ===
If checked the recorder will start minimized. Because the recorder has a complete user interface this software is not designed to run as a service. For automatic start-up include the .exe in the auto-start folder.
The recorder encodes the record data files (the XML) using an internal standard key. If in this field a User Key is defined the encoding is done using this key. Therefore also in all players has to be configured this key. Remember that the decoding in the player depends on the local setup of the player. If no user key is defined the standard system key is used. If a user key is found a decoding is tried using that user key, if decoding fails the system key is used, if even that fails no decoding is possible.  
 
Therefore once a user encoding key is defined it should not be changed, otherwise the “old” user encoded records cannot be decoded.  


=== Write all operations in logfile ===
So if not really required leave this field blank, if you define a user endcoding key think well about it and...


Do not confuse the logfile with the error logfile, the error log is written in any case and named iREC_Error_Log. This logfile is called iRECsys_Log.txt and contains all operational tasks like copy of file, converting ecc., not just events like startup or errors. This flag should be switched on just in special situation for example during installation of a new system or in case of error searching, because this file becomes very huge and there is no automatic limitation foreseen.
WARNING: do not forget it (there is no way to find out the key).


=== decrypt Key ===
=== Encode audio ===
The recorder crypt the record data files (the XML) using an internal standard key. If in this field a User Key is defined encryption is done using this key. Therefore also in all player has to be configured this key. The decryption in the player depends on the local setup of the player. If no user key is defined the standard system key is used. If a user key is found a decryption is tried using that user key, if decryption fails the system key is used, if even that fails no decryption is possible.


Therefore once a user key is defined it could not be changed, otherwise the “old” user encrypted records cannot be decrypt.  
Audio files are store in clear wave or mp3 format. Any media player could reproduce them, the integrity of those files is controlled from the innovaphone player. The audio file integrity data are stored in the encodet xml file.


So if not really required leave this field blank, if you define a user key think well about it and
If this option is checked also the audio file will be encoded using the same key used for encoding the xml file (see description in “Customer key”).


WARNING:  do not forget it (there is no way to find out the key again for you).
Encoding cause more CPU load for the recorder and the audio file size is doubled.
 
Once encoded an audio file can be reproduced only with the innovaphone player, if a customer encoding key is configured just if also in the player that key is used. In that case the audio file can be reproduced just with the innovaphne Player using the customer encoding key.  


=== Do not Record empty Files ===
=== Do not Record empty Files ===
Line 55: Line 58:
The recorder can eliminate those files (recommended), but if for some reason you want keep those files (practically you just keep the call information from the reporting) do not flag this option.
The recorder can eliminate those files (recommended), but if for some reason you want keep those files (practically you just keep the call information from the reporting) do not flag this option.


=== Do NOT savew CDR data ===
=== Save Setup in own directory ===
If checked no CDR data are saved. Also Agent note is not possible and security feature is off.


=== Encode audio files ===
See [[Reference10:Voice_Recorder/System_Setup#Multiple_Voice_Recorder_and_Player|here]]


Audio files are store in clear wave or mp3 format. Any media player could reproduce them, but the integrity of those files is controlled from the innovaphone player. The audio file integrity data are stored in the encrypted xml file.
=== Do NOT save CDR data ===
If checked no CDR data are saved, just the audio files. If this option is switched on the player cannot display any additional call info. Also the integrity of the record cannot be assured (unknown) and a manipulation will not be detected.  Also Agent notes are not possible and snapshots are disabled and even the original timestamp cannot be displayed on the player.  Note also that a record once stored with this option on cannot be recovered later on.


If checked this option also the audio file will be encrypted using the same key ad for the xml file (see description in “decrypt key”).
=== Write clear XML copy, file extension ===


Encoding cause more CPU load for the recorder and the audio file size is doubled.  
The connection data and stored in encoded xml file. The innovaphone Player decode those data and display them automatically. On top the player can export the connection data in a clear (not encoded) format. Anyway some customer wants a copy of the connection data on a central point in a clear file format. If this option is marked the recorder will make a copy of the encoded xml file, the name is the same but the extension must be defined. Do not enter the dot in the file extension field.


Once encoded an audio file can be reproduced only with the innovaphone player, if a decrypt key is configured just if also in the player that key entered in the player setup (the player setup is even encoded).
=== Convert to Mono ===
Audio files are stores in stereo format where the external caller is on the left channel while the internal audio is on the right channel. This allows for example to amplify one channel more than the other etc. If this flag is checked the audio file format is converted from stereo to mono and the file size is reduced about 50%.  


Remember that once converted to mono there is no way to restore the stereo image.


== GROUP PBX ==
=== One channel audio ===
 
If checked just on channel is recorded, typically the left one because there the internal caller is speaking. If requested also only the right caller can be recorded. In most countries recording just the internal caller (recording myself) is permitted without limitations.  
Communication to the PBX is necessary because of licensing. Like in other applications admin access and SOAP user is required. If no valid connection is up or no valid license found the system switch to the demo mode and will terminate operation after 20 minutes.
 
=== IP addr. ===
Indicate the IP Address of the PBX where the Recording licenses are in (the license master). Typical license are displayed in the PBX as “Recording10”.
 
=== IP addr. Stby ===
Indicate the IP address of the standby PBX. Leave blank if there is none.


=== User / Password ===
=== Softmigration/Slaves ===
Of the PBX where the license are in. Dafault example: Admin / IP800


=== SOAP USER ===
(Build 1072 or later)
The SOAP user in the PBX where the licenses are store has to be indicated. Usually it is a dummy user object in the PBX without any registration, for example a user called “SOAP” or “_TAPI_”.


=== HTTPS ===
Check if the gateway is looped in between the PSTN and the PBX.
Check if the PBX is using HTTPS.


=== Agent Group ===
Do not mark in all other situaytions.


Put all extensions where the recording feature is required in a group (not active) and define here the name of this group.
See relative Howto article for details.


The recorder will read out all extensions during start up and initialize those belonging to this group. A result is that events from these extensions will be transmitted to the recorder.
=== Store PCAP files (no pcap2wav) ===


Just extensions being part of that group will be recorded; eventual records of objects not in this group will be deleted. If a record is detected but the relative object is not in that group a message like “Record skipped Agent not in group” is displayed (but no error is triggered).
Audio files are saved in the PCAP format; the player is capable to reproduce even pcap files. This flag is mandatory if the recorder is used as a service (see relative article).


During start-up the recorder read out the number of license for recording stored in the PBX. Each time a object is in the recording group the number of free licenses is decreased. So the putting in the recording group is limited if the maximum number of license is reached.
=== MP3 indicator lamp ===


Please note that in special situations, for example if you have a trunk line object but also a External object (a gateway) to a remote PBX both objects has to be in the group, otherwise calls form the trunk to the gateway will not be recorded.
If a conversion from wave to mp3 audio format is requested some external files and utilities has to be present in the recorder directory. During start up the recorder check if all those requires files are present and if yes mp3 compression is switched on automatically and the lamp is green, if not conversion to mp3 is switched off and the lamp is gray.  


Please note that there is a different behavior using a native CF or a CF emulated by the Linux application. A native CF will show a file name immediately when recording starts while the Linux OS will show the file just when the call is terminated. Therefore if you use a Linux OS and a user is not in the group even the counter “Channels in recording” is not showing the correct value.
===Work as http Player server (no recording)===


== GROUP EMAIL ALARM (option) ==
(Build 1074 or higher)
Warning: If checked the recorder will be just a http fileserver for the player, no recording is done!


If the recorder switch on the master alarm a supervisor can be receive an email.
Setup the storage path in the “Storage” tab and the Socket in the communication tab (COM WITH PLAYER). All other parameters are meaningless.
The message object is "Voice Recorder " + Name of the recorder + " - ALARM NOTIFICATION", while the body text contains the last master alarm reason and the text "Automatic generated Alarm - Do NOT answer!".


Please note that a mail is sending just one time even if the error is recovered automatically (for example if the reporting is reachable again, then fails, then works etc.). To rearm the email the master alarm must be quit. This is intentionally to avoid tons of emails in case of toggling errors. The rule is that after an alarm email the application has to be checked.  
See realtive article.


=== Work as Pcap to Wave converter (no recording) ===


=== e-mail account ===
If flagged this application will detect in the storage subdirectories pcap file and convert them to wave or mp3 and performs the down mix can be done (stereo to mono, one cannel). This operational mode can be switched with the Player server mode if required.


Enter the destination email account for example kwa@innovaphone.com
=== Recording trunk for manual rec+ ann.===
Put in the number of the recording trunk for manual recording with announcement. Leave blank to disable feature.  


If this field is empty the feature is off.
From build 1198.  


=== e-mail server ===
See [[Reference10:Concept_Voice_Recording_2014#Recording_Modes]] for feature description.


Enter the e-mail server, for example 155.5.23.24
=== XML/WQ for manual rec + ann.===


Put in the number of the XML or WQ for manual recording with announcement. Leave blank to disable feature.


=== Password ===
From build 1198.


Not necessary for Exchange but could be.
See [[Reference10:Concept_Voice_Recording_2014#Recording_Modes]] for feature description.


== COM WITH PLAYER (option)==
=== Start in Taskbar ===
If checked the recorder will start minimized. Because the recorder has a complete user interface this software is not designed to run as a service. For automatic start-up include the .exe in the auto-start folder.


Communication with the player is an option, indicating a port number, it will be switched on from the recorder point of view and request from the player will be processed.
=== Trace ===


Indicate in the “port” field a free communication port while under “own IP address” the IP address of the PC is indicated (not settable here, it is the address of this PC, automatically detected).
Do not confuse the logfile with the error logfile, the error log is written in any case and named iREC_Error_Log. This trace/logfile is called iRECsys_Log.txt and contains all operational tasks like copy of file, converting ecc., not just events like startup or errors. This flag should be switched on just in special situation for example during installation of a new system or in case of error searching, because this file becomes very huge and there is no automatic limitation foreseen.


Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.
===Keep PCAP copy===


To switch off this feature leave the port field blank.
If checked the recorder leaves a copy of the PCAP file in the sub directory “REC” of the Storage directory (from Build 1191).  


===open trace folder ===


== GROUP REPORTING ==
This link shows you the path to the Log files.  In case of problems please send us always the error log file.


The setup parameter in this panel allows this recording software connect the innovaphone reporting and retrieve the CDR records. The Reporting can run on a gateway or VMware (player or native), there is no difference for this setup.
== PBX ==


=== IP address ===
Communication to the PBX is necessary because of licensing and SOAP traffic supervision. Like in other applications admin access and SOAP user is required.


Enter the IP address of the device where the reporting is running.  
[[Image:RecSetup89.PNG‎]]


If you run the reporting on a PC enter the IP address indicated on the VMware virtual machine.


If not visible enter “ifconfig” in the VMware panel, the address is shown under inet addr. Remember that the address is usually not 127.0.0.1 (even if the reporting is running on the same PC).
=== IP addr. ===
Indicate the IP Address of the PBX where the Recording licenses are in (the license master). Typical license are displayed in the PBX as “Recording10”.


=== IP addr. Stby ===
=== IP addr. Stby ===
Indicate the IP address of the standby PBX. Leave blank if there is none.


Indicate the IP address of the standby recording. Leave blank if there is none. Remember that both, active and standby PBX must sent the CDR tickets to both reporting applications and replication between must be switched on.
=== User / Password ===
Of the PBX where the license are in. Default example: admin / ip800


If a switch (and especially an automatic switch back) to the active reporting is required flag the option “Follow Standby/Active PBX”. If this option is not flagged and the active PBX is on again the reporting will not switch back (until the recorder is not started again or the standby reporting fails).
=== SOAP USER ===
The SOAP user in the PBX where the licenses are stored has to be indicated. Usually it is a dummy user object in the PBX without any registration, for example a user called “SOAP” or “_TAPI_”.


=== User/Password ===
=== Agent Group ===


Enter the credential to access to the reporting, default is “reporting” and “linux”.  
Put all extensions where the recording feature is required in a group (not active) and define here the name of this group.


=== HTTPS ===
The recorder will read out all extensions during start up and initialize those belonging to this group. A result is that events from these extensions will be transmitted to the recorder.


Check if the reporting is using HTTPS
Just extensions being part of that group will be recorded; eventual records of objects not in this group will be deleted. If a record is detected but the relative object is not in that group a message like “Record skipped Agent not in group” is displayed (but no error is triggered).


During start-up the recorder read out the number of license for recording stored in the PBX. Each time a object is in the recording group the number of free licenses is decreased. So the putting in the recording group is limited if the maximum number of license is reached.


=== Path Reporting ===
Please note that in special situations, for example if you have a trunk line object but also a External object (a gateway) to a remote PBX both objects has to be in the group, otherwise calls form the trunk to the gateway will not be recorded.


Enter the path to the main screen of the reporting, tipical (and default) is “/apps/innovaphone-reporting/report.php” and no modification is required.
=== TAN ===
Build 1167


=== Trunk Access ===
Enter If the the number of the TAN XML (TAN.xml) if TAN feature is active. If you do not record direct on the trunk or the user but on a special GW with prefix also that prefix could be necessary before the number of the XML( typically not). See Concept article for description of the TAN feature.


Indicate the trunk access number (tipically "0")
=== License Master ===


=== Swap incoming/outgoing ===
In scenarios with license master and recoding on slave PBX (do not confuse with the feature slave recording, in this case the recorder is just simply a recorder on a slave PBX) the relative licenses are stored in the master PBX, in normal scenarios just leave blank.


What “incoming” or “outgoing” is depends on the point of view. If clicked “in” and “out” (“i”, “o”) are simply swapped.  
==== Use Stored Lic ====
If there are more recorders on one single PBX do not check this flag on the first one and start it. Than then start all other recorder with this flag switched on. Stop the first recorder, set the flag and start it again. In this way just one license per user is required. If the number of licenses change all recorder has to be stopped and the procedure repeated. Build 1164.


=== No Reporting Sync ===
== Reporting ==
The recorder must get ticket from the innovaphone reporting tool. The Reporting can run on a gateway or VMware (player or native), there is no difference for this setup.


If checked the reporting is not synchronized with the recording. If not checked the recorder informs the reporting about a stored recording and the database of the recorder is updated. If a Player deletes a record he send a relative information to the recorder, and the recorder again inform the reporting engine if this option is not checked.  
When the recorder detect a call end (in normal operation because the SOAP will tell that) the recorder will ask the reporting if there is a related record. If yes the recorder check if the user is in the recording group, if yes the call will be processed, if not deleted. If the recording has no record to the call that could be because the recorder is to fast (the record is not jet processed by the reporting) or because this user has no reporting. Therefore the recorder waits and tries later. After 4 trials the recorder gives up and deletes the file. Such a situation slows down the recorder and therefore all users should have the reporting or just users with reporting should produce records.  


== COM WITH EXTERNAL APPLICATION (option) ==
[[Image:RecSetup03.png]]


Necessary if the recorder is interfaced to an external application, see reference help in the main window for details. Leave all blank if no external application is required.
=== IP address ===


Enter the IP address of the device where the reporting is running.


=== Send TCP/IP Message – Lounch application string ===
If you run the reporting on a PC enter the IP address indicated on the VMware virtual machine.


Select the desired interface mode, the parameter of the not selected one are skipped.
If not visible enter “ifconfig” in the VMware panel, the address is shown under inet addr. Remember that the address is usually not 127.0.0.1 (even if the reporting is running on the same PC).


=== Keep Alive ===
=== IP addr. Stby ===


Indicate in seconds the time period between sending keep alive messages from the recorder to the external application (default=10 seconds).
Indicate the IP address of the standby reporting. Leave blank if there is none. Remember that both, active and standby PBX must sent the CDR tickets to both reporting applications and replication between must be switched on.


=== IP address / Port ===
=== Follow Standby/Active PBX ===
If a switch (and especially an automatic switch back) to the active reporting is required flag this option “Follow Standby/Active PBX”. If this option is not flagged and the active PBX is on again the reporting will not switch back (until the recorder is not started again or the standby reporting fails).


IP address / Port of the external application server.
=== User/Password ===


Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.
Enter the credential to access to the reporting, default is “admin” and “linux”.  


=== Lounch path ===
=== Path Reporting ===


URL to be launched.
Enter the path to the main screen of the reporting, typical (and default) is “/apps/innovaphone-reporting/report.php”. Should work normally, do not modify this setup.


=== Try to reach reporting ===


== GROUP STORAGE AND BACKUP ==
In this field is shown the result of the input. You should be able to reach the reporting from the PC using a browser and this link.


The setup parameter in this panel defines where the voice records are stored. While the Root storage Path is mandatory the backup path is a option.
=== Swap incoming/outgoing ===


=== Set Root storage path ===
What “incoming” or “outgoing” is depends on the point of view. If clicked “in” and “out” (“i”, “o”) are simply swapped.


The path indicated in this option is the working directory where the files after retrieving, naming and converting are written. It is also the directory where the player will look and search for files.
=== No Reporting Sync ===
 
If checked the reporting is not synchronized with the voice recorder.  
If you click the “Set” button a directory dialog box appear, select the directory where you want store the voice records and confirm. You can edit the path even manually, not recommended.
If not checked (default) the voice recorder informs the reporting if a stored recording is deleted and the database of the reporting is updated. Even if a Player delete a record (and has connection to the voice recorder) the recorder send relative information to the recorder, and the recorder again informs the reporting engine.


=== Delete records after moth ===
=== Alarm if no CDR ticket found ===


The indicated number of month is the maximum storage depth. The minimum is 2 (so the actual and the last month will always be available), indicating 99 disable the feature. Deleted files cannot be recovered, the name of the deleted files are reported in the syslog.  
There must be for each recorded call a CDR ticket. If this option is checked an alarm (email) is trigger if there is no ticket. There are two situations where an alarm could trigger: if in online operation an agent (a user in the Agent group, means a user to record) end a call and there is no ticket after a time-out and after start-up where all pcap files buffered must be checked (agent or not) asking the reporting.


Note that file in the backup path will never be touched.
=== User A to force to incoming ===
(not shown in picture)


=== Set Backup path ===
In some cases calls diverted to external numbers should be forced to be signed as incoming calls even they are form a Reporting point of view outgoing once. It is possible to define a caller A, if he did the call the direction will be forces to “I”.
Up to 50 extensions can be defined.(Hotfix 23)


This path is optional; if blank the feature is off.


If you click the “Set” button a directory dialog box appear, select the directory where you want store a backup of the voice records and confirm. You can edit the path even manually, not recommended.
== PCAP ==


Note that files stored in the backup directory are not visible for the player and even the automatic delete is not active. The indicated directory is typically on a NAS or SAN system.
[[Image:RecSetup23.png]]
 
== GROUP PCAP ==


Note that the setup for a compact flash (CF) is different than the one using a webdav!
Note that the setup for a compact flash (CF) is different than the one using a webdav!
Line 233: Line 242:
If you use our CF with the innovaphone application platform the CF is considered as a webdav service.  
If you use our CF with the innovaphone application platform the CF is considered as a webdav service.  


* CF:


[[Image:RecSetup88.png]]
The recorder downloads the pcap records from the CF or webdav server. See examples Webdav and Compact Flash and observe the different required inputs.  


There is no difference between a IPVA or a Webdav server on a hardware device, in the Webdav example you will see the path to an Application Webdav service on a IP810. In the example the pcap are stored in the directoy /MyPCAPpath. Basically also in the gateway or phone the path for the recording is that one.


IP addr.  “172.16.88.98” (so no http or similar)
=== Follow Standby/Active PBX===


Typically User and Password are the one of the PBX, remember that the credentials CF must have write access.
If this flag is on in case of switch to the Standby PBX of the PBX connection also the PCAP path is swapped. If not the path is the same (scenario if for example an external Webdav server on a HA VMware is used).


Path PCAP “/DRIVE/CF0/MYrecDIR”
=== User/Admin===


The result shown in the framed box will be “172.16.88.98/DRIVE/CF0/MYrecDIR/” and the recorder will try to access to this directory.
Credentials for accessing the CF or Webdav server, see examples.


=== Path PCAP===


Path to the directory ahere the PCAP are stored. See examples.


*Webdav:
===HTTPS===


[[Image:IRecN01.png]]
Self-explaining


IP addr.  “172.16.88.199/webdav”
===Delete old PCAP Files===


Typically User and Password are the one of the application platform, admin and linux for example.
After a number of cycles without response from the reporting the pcap file will be deleted. In a correct working system this should never happen because all users in the PBX should have the reporting. Default value = 500, minimum value=1.  


Path PCAP “/log/”
===Delete Pcap without CDR===


The result shown in the framed box will be “172.16.88.199/webdav/log/” and the recorder will try to access to this directory.
If no ticket is received after the number of cylices defined the recorder delete the pcap file.  Before doing that he tries to copy the pcap file in the TMP subdirectory of the storage path. At least those files are not lost. If this option is checked no emergency copy is done.


== Storage ==


If you use a webdav server (if for example you have running the application platform) her again a typical setup for that:
The setup parameter in this panel defines where the recorder stores the records. While the Root storage Path is mandatory, the backup path is a option.


=== Set Root storage path ===


The path indicated in this option is the working directory where the files after retrieving, naming and converting are written. It is also the directory where the player will look and search for files.


If you click the “Set” button a directory dialog box appear, select the directory where you want store the voice records and confirm. You can edit the path even manually, not recommended.


=== Map Network Drive ===
If destination of the storage you are using is a Webdav folder on the same LAP where you are saving the pcap files, and you want to use a mapped drive (for example F: or N:), mapping the drive using Windows feature will cause writing/reading issues, and Recording won't convert the file in .wav in the storage path.


A virtual drive should be mapped, typical letters are for example “K:” or “H:”. Indicate the letter including the “:”. Once started you will see in the explorer the network drive, if terminated correctly the network drive will be removed and is no longer visible in the explorer.
To avoid this, use a third party software like "Net Drive" to create the network map.


=== Detect automatically ===
=== Delete (records) after moth ===


If checked a free drive letter is detected automatically and assigned.  
The indicated number of month is the maximum storage depth. The minimum is 2 (so the actual and the last month will always be available), indicating 99 disable the feature. Deleted files cannot be recovered, the name of the deleted files are reported in the syslog.  


=== IP address ===
Note that file in the backup path will never be touched.


Enter the IP address in case of using a CF on a Gateway.
=== Set Backup path ===


=== Follow Standby/Active PBX ===
This path is optional; if blank the feature is off.


If this flag is on and the active PBX fails the recorder clear the network drive and try to establish a new one on the standby PBX address (he will take the “IP addr. Stby” in the PBX group).
If you click the “Set” button a directory dialog box appear, select the directory where you want store a backup of the voice records and confirm. You can edit the path even manually, not recommended.


If not flagged no action occurs if the active PBX fails (this is for example necessary if no CF but an external Webdav server is used).
Note that files stored in the backup directory are not visible for the player and even the automatic delete is not active. The indicated directory is typically on a NAS or SAN system.


=== User/Password ===
== Communication ==


Enter the credential to access to the CF. If using a webdav server the PC where this application is running must have access to the relative directory without credential from the application.
This page shows 3 independent container:


=== HTTPS ===
[[Image:RecSetup05.png]]


Check if the CF is using HTTPS
=== COM WITH EXTERNAL APPLICATION (option) ===


Necessary if the recorder is interfaced to an external application, see reference help in the main window for details. Leave all blank if no external application is required.


NOTE: In the picture you see a typical setup for a CF drive where the reporting is running on a VMware, so not on the gateway.
Do not confuse this section with interfacing reporting or player – these are options for external servers and applications.


If you use a IPxx10 gateway with the reporting running on the GW and therefore the linux application platform the CF is processed in a slightly different way. Remember that directories are case sensitive using linux , so be carefully in writing.
=== Lounch application string ===


A typical setup would be this one:
When a record is detected a application can be triggered, see relative description.


Map MW drive:  H:
=== Keep Alive ===


Search Path: /webdav/
Indicate in seconds the time period between sending keep alive messages from the recorder to the external application (default=10 seconds).


IP addr. : The one of the application platform
=== IP address / Port ===


User + Password: the one of the application platform
IP address / Port of the external application server.


Path PCAP: iREC
Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.


In the example there will be mapped the directory “iREC” on the AP to drive H:
=== Lounch path ===


If mapping fails you will see an error message in the Log windows, but you will also see that there is no mapped drive if you open the file explorer.
URL to be launched.


=== COM WITH PLAYER ===


Communication with the player is an option, indicating a port number, it will be switched on from the recorder point of view and request from the player will be processed.


=== Path PCAP ===
Indicate in the “port” field a free communication port while under “own IP address” the IP address of the PC is indicated.


Enter the missing path data to access the directory.
The recorders try to find out automatically his “own” communication port; that sometimes fails in virtual environments. If the indicated IP address is not correct put in the right one (the on for this application).


=== Try to find PCAP files ===
Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.


This info panel shows you in real time the resulting path in function of your setup inputs. The path indicated here is the one the software uses to reach the pcap files.
To switch off this feature leave the port field blank.


== TCR (OPTION) ==
Note: If the recorders works as a fileserver for the player this address and port is the communication socket for the player (Build 1074 or higher).


If this option is checked the Recorder will work in the Thread call Recording mode (TCR), if not in the standard mode (STD). No mixed mode is possible for one Recorder.
Password (build 1136):


If TCR is on records will be saved only if the user define this call by call. That could be done automatically if calls are processed by innovaphone IP-Phones or on demand during a call if innovaphone IP-Phones are used.  
Password for player to access to the recorder if the recorder act as http player server or even if a player want retrieve the recorder status. Leave blank if no password protection is required, if this field is blank eventual password in the player are ignored.


But it is also possible to mark a call after the call end for a certain period, after that period the recorded file will be deleted. TCR files contain always the entire voice call from the beginning on , even if the mark is done during or after the call.


=== Thread Call Recording ===
=== GROUP EMAIL ALARM (option) ===


Indicate the path to the XML file called from user to mark the call. Typically the XML is located at the CF, the example shows that the XML is running in the “TCR” directory of the CF.
If the recorder switch on the master alarm a supervisor can be receive an email.
The message object is "Voice Recorder " + Name of the recorder + " - ALARM NOTIFICATION", while the body text contains the last master alarm reason and the text "Automatic generated Alarm - Do NOT answer!".


=== Path TCR ===
Please note that a mail is sending just one time even if the error is recovered automatically (for example if the reporting is reachable again, then fails, then works etc.). To rearm the email the master alarm must be quit. This is intentionally to avoid tons of emails in case of toggling errors. The rule is that after an alarm email the application has to be checked.


Indicate the path to the XML file called from user to mark the call. Typically the XML is located at the CF, the example shows that the XML is running in the “/DRIVE/CF0/IF_REC” directory of the CF (not a good idea indicate the same directory than the one of the recording files, use a different one).


=== e-mail account ===


=== TCR flag Timeout ===
Enter the destination email account for example kwa@innovaphone.com


After that timeout calls not marked are deleted. A typical value is 5 minutes.
If this field is empty the feature is off.


=== XML Number ===
=== e-mail server ===


If recording is done directly from the innovaphone IP-phone also that 3party confenece call (even if short) to the XML for marking is again a recorded. Indicate the XML number, so all calls to that number will be deleted automatically.
Enter the e-mail server, for example 155.5.23.24




== Audio compression ==
=== Password ===


The wave audio files are jet G711 compressed but stored as a stereo file in a wave container format. Storing native PCM would requires about the double disk space and is not done. One minute of raw PCM requires about 2 MB while the recorder reduces as default this size at 1MB.  
Not necessary for Exchange but could be.


Unfortunately if switched on audio encoding will double again this size. Even if the customer wants a very long period of storing data or has limited disk space additional compression would be fine. Mp3 compression can be switched on using external 3rt party software.


The recorder can pilot automatically external applications called “lame.exe” and “Sox.exe”. Lame is an open source (GPL) tool and even SoX is an open source (GPL) tool (SoX is described also in another Wiki article).
== TCR/MRK/RND ==


The recorder use no source code inside and calls the applications like a batch file (of cause providing relative command line info).  
[[Image:RecSetup06_2.png]]


Do not “install” lame or SoX, just download the packages and copy the following files in the folder where the recorder is running:
===Thread Call Recording===
 
If checked the feature TRC is on, otherwise off (default).
- Sox.exe
If this option is checked the Recorder will work in the Thread call Recording mode (TCR), if not in the standard mode (STD). No mixed mode is possible for one Recorder.
If TCR is on records will be saved only if the user define this call by call. That could be done automatically if calls are processed by innovaphone IP-Phones or on demand during a call if innovaphone IP-Phones are used.
But it is also possible to mark a call after the call end for a certain period, after that period the recorded file will be deleted. TCR files contain always the entire voice call from the beginning on , even if the mark is done during or after the call.


- Lame.exe
TCR flag Timeout: After that timeout calls not marked are deleted. A typical value is 5 minutes.


- Libgomp-1.dll
XML Number: If a user marks call he will call a XML, during the call using a 3conference party or after the call calling simply the xml. Of cause that “marking” calls to the xml should not be recorded (but the will if for example the phone has permanent recording on). Indicate the number of the xml, in this way the recorder will delete this “marking” calls.


- Pthreadgc2.dll
===Mark Records===
If this option is switched on a user can mark a record. Marked records are visible in the system playlist of the player.
This can be done during conversation (with innovaphone IP-Phone only) or after a record dialing a number. The mechanism is similar to the TCR and in fact there is used the same XML to do that. TCR is switched on no marking is possible (senseless, the user “marks” to record while this feature mark records in normal operation mode).  


- Zlib1.dll
===Delete Records===
Build 1188


During start up the recorder check if those files are in the directory and if yes mp3 coding is on while if just one file is missing encoding is off. If you open the extended view of the recorder an mp3 Led shows you mp3 coding status (on or off).
A user can skip (not store) some conversations. This is done using a similar mechanism used with the TCR. If at the end of the conversation a file is found this record will be deleted. Therefore it works only if this file is created during the conversation. This can be done calling the XML TCRec.xml  (with a feature key, the recording feature of a innvaphone IP Phone, putting the actual call on hold and call the xml or using an external application). The file has to be created in the recording directory/TMP.


With mp3 option on the required file size is reduced about 75% (1 MB will become 250kB).  
File format: TCA-XXX_XXX.txt where xxx= the agent number.


Note that encoding audio files will double again the file size. Encoding can be done with wave or mp3 files. An encoded audio mp3 file requires anyway just 50% disk space that a clear wave file does.
Example: TCA-1234_1234.txt -> the record of the actual conversation of the agent 1234 will not be recorded.


= Reporting Setup =
The field itself could be empty, but observe that with Linux at least one character should be in.


In the reporting there is no special setup required. If running on a VMware assure that the reporting starts each time with the same IP address.  
Please note also that the time of the reporting, PBX and webdav must be the same.  
The Feature works also with the (old) CF.


The recorder requires reporting Version 10, Build 10043 or higher.
If a record is skipped because of theis feature he log will show the message “User Mark Record to delete found TCF=” and the Agent number.


Important: Each extension producing a .pcap file must be included in the reporting!
===Random Recording===
If just some extensions should be recorded (and just for them reporting licenses are foreseen) a special setup in the routing is required to assure that just those extension will pass the recording GW.
If marked conversations are recorded in a random way. Not every conversation will be recorded and recording is uses for example just for a statistic quality check.
There are two parameters that can be combined, a counter of records and a counter of calls for a agent. If for example the “Record in System” counter is set to 5 only each fifth call will be recorded. If the counter “Record for Agent” is set to 2 for a single agent will be recorded each 2nd conversation. Combined for a User it will be unforeseeable if a call will be recorded or not.


==Slaves==


= PC Setup =
[[Image:RecSetup10.png]]


As always the PC World is full of traps and therefor in this section we try to collect some. We show you also if possible what the result will be. Of cause the exact wording of the messages depends on the language of your computer.


'''Where is the application and where are the setup data?'''
Slave PBX saves the PCAP record in a “far”, own compact flash/webdav while the CDR data are stores and saved in a central reporting.


The application is installed in the Folder “\Programs\innovaphone\innovaphone Recorder”. If you install the recorder on a 64 bit machine instead of “\Programs” you will find the application the “Program (x86)” folder.  
Note: There must be a Master setup, it is not possible to have just slaves, a main site is required where for example the licenses for the recording are stored.  


The setup data are stored in the folder “\user\yourUser\AppData\Roaming\innovaphone\innovaphone Recorder”.  
The Slave setup is similar to the PCAP setup (IP-address, User, Password and PCAP- Path). The field “Name” is just to remember the site and select a site form the recorder main interface.


If you don’t see the folder “AppData” you must switch on the option of the file explorer in the Tab Views the flag “show hided files and drives”. Observe that the recorder can save his data also in the directory where he is running (depends on the relative flag in his setup).
To add a new Slave-site select an empty line in the table, enter all data and press the save button.


'''First start after installation'''
To delete a Slave-site select an existing line, delete the IP-address and press the save button.


Open immediately the setup to avoid that the recorder tries to recover error because of an empty setup. The application recognizes this first startup, anyway open the setup. Remember as jet stated that before starting to work with the recorder the basics should run (PBX, Groups, Soap user, reporting, Webdav, recording path, all this should be up and running fine).
To modify a Salve site select an existing line, do the modification and press the save button.


'''Start up with administrator rights'''
===Interval (min)===


The Recorder needs to be started with administrator rights. Therefore or you are logged as administrator or you must start the application as admin (right mouse click on the application, “start as admin”). If you start the application without hose rights probably the alarm “Disk” and “Setup”, for Shure the “CF” alarm will be displayed and no webdav access is possible.
Set a time interval in minutes, shortest value should be 1 (do not enter 0). The slave PBX will be checked just after this timeout is expired.
Example "20": The recorder check if there are PCAP-Files to import, than waits for 20 minutes before checking again.


'''Webdav'''
Note: Slave sites are checked after the main site is worked out. Therefore the main site records have a priority in handling. If for example the main site has continuously records to save the slave routines are delated.


The Webdav access is particular darn and there are many reasons why an access could fail.
In the interval line a “from” – “to” time span can be defined. Salves will be checked just in this timespan.
Empty values means “always”.


So if it works fine, otherwise continue reading and proceed in this way:
Example 1: “08:00” to “18:00” means “during worktime” while “22:00” to “04:00” means “during the night”.


Try first to map a drive to the webdav using the file explorer (click on Network, connect network  drive, assing a letter and put in the field path your path to the webdav (for example \\172.o.m.g\DRIVE\CF0\). If this mapping works fine, you can now separate again this drive.
Note: Also during the timespan the Interval timeout is observed.  
If not check you Proxy, that is generally a good idea, because sometimes the proxy is responsible that the attempt to reach a network drive fails. So switch off the proxy off for this PC. Firewalls and other components in the net or local on you PC can also block the access to the webdav, also in this case the manual mapping fails (and if manual fails also the recorder will fail).  


Note that the syntax to reach the webdav is different for a CF or an Webdav server on the linux application platform.  
Example: Interval = “5”, “14:00” to “23:00”: the recorder will import data form 14:00 to 23:00, checking each 5 minutes if there are any new records.


Another strange reason for not connecting a NW drive could be the letter you assign in the recording setup. For example “H:” sounds good, you check your explorer and see that this letter is not assigned to any drive, so “free” for your understanding. To be shure that this is really a assignable “free” Drive letter for your machine you have 2 choices; user a “low” letter like “Y:” or “Z:” or use the letter that works with you manual mapping trial, or flag “Detect automatically” and observe the letter the PC try to map (you see that in the (right) syslog panel.
Note: The Recorder interface will show an additional Combo box where a slave site can be selected (showing the name fields). The operator can select a Salve site and force the download of the PCAP files. This is usefully if a specific record should be downloaded immediately.




A stupid but even not forgiving issue is the correct setup, a wrong or missing slash or backslash will fail the mapping. Observe the path in the first picture at the beginning of this article; this is the syntax for a compact flash!
== Audio compression ==
Now if you scroll down to the section “GROUP PCAP” you see a example for an access to webdav running on an innovaphone application platform.


Before despair check also the correct admin and password, remember that typically the PW in the application plattform  is “linux”.
The wave audio files are jet G711 compressed but stored as a stereo file in a wave container format. Storing native PCM would requires about the double disk space and is not done. One minute of raw PCM requires about 2 MB while the recorder reduces as default this size at 1MB.  


'''Platforms'''
Unfortunately if switched on audio encoding will double again this size. Even if the customer wants a very long period of storing data or has limited disk space additional compression would be fine. Mp3 compression can be switched on using external 3rd party software.


SERVER:
The recorder can pilot automatically external applications called “lame.exe” and “Sox.exe”. Lame is an open source (GPL) tool and even SoX is an open source (GPL) tool (SoX is described also in another Wiki article).


If you use a server (for example WIN2008) you have to face that on that server you must active the “Desktop Experience Features”.
The recorder use no source code inside and calls the applications like a batch file (of cause providing relative command line info).  


PC:
Do not “install” lame or SoX, just download the packages and copy the following files in the folder where the recorder is running:


If you use a "normal” Win7/8 PC you have not the "Experience" issue, but to fix the problem that Microsoft limit fro "not servers" the maximum file size and you can run in problems because very long conversations could not be downloaded from the webdav server. A typical maximum size id 50MB, so you have to solve this, here is how.
- Sox.exe


See http://support.microsoft.com/kb/900900/en-us for more information and how resolve this limit. Our suggestion is to enlarge this limit at least to 500MB.  
- Lame.exe


The recorder will have an error like “Error in rename PCAP files" or “Error file to large – enhance max file size in registry” or similar.
- Libgomp-1.dll


Follow the instructions given by MS and be carefully, the following sum-up just resume what usually the manual way to solve the problem is and MS writes in his KB:
- Pthreadgc2.dll


To resolve this issue, follow these steps:
- Zlib1.dll


1. Click Start, click Run, type regedit, and then click OK.
During start up the recorder check if those files are in the directory and if yes mp3 coding is on while if just one file is missing encoding is off. If you open the extended view of the recorder an mp3 Led shows you mp3 coding status (on or off).


2. Locate and then click the following registry subkey:
With mp3 option on the required file size is reduced about 75% (1 MB will become 250kB).  


HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters
Note that encoding audio files will double again the file size. Encoding can be done with wave or mp3 files. An encoded audio mp3 file requires anyway just 50% disk space that a clear wave file does.


3. In the right pane, right-click the FileSizeLimitInBytes value, and then click Modify.
Note: Latest release from sox there is no more a file called "Pthreadgc2.dll". You have to take release 14.4.1 or earlier.


= Other Setup =


If you cannot see the FileSizeLimitInBytes value, right-click the blank space in the right pane, click New, click DWORD Value, type FileSizeLimitInBytes, and then click OK.
For Reporting setup, PC setup, Gateway setup, IP-Phone Setup, Multiple Voice Recorder and Player see related Articles (System Setup)


4. In the Edit DWORD Value box, click to select the Decimal option. In the box under Value data, type a value that is larger than the size of the file that you want to download. Click OK.
= Related Articles =


* [[Reference10:Voice_Recorder/System_Setup]]
* [[Reference10:Voice_Player/Setup]]
* [[Reference10:Concept_Voice_Recorder]]


Note The default value for the file size limit is 50000000 bytes.
[[Reference10:Player_Voice_Recording]]
 
5. Quit Registry Editor. Restart the computer.
 
 
 
[[Image:Filesize.png]]
 
 
= Gateway Setup =
 
The voice has to transit a logical GW where the [[Reference9:Gateway/Interfaces/VOIP#Media_Properties | URL “Record to (URL)”]] is defined. Including or excluding extensions in the routing allow selective recording of just defined extension (or exclude some extensions). Also mapping in the PBX can be used to manipulate call routing. See relative chapters in the Wiki.
 
Example:
 
[[Image:VR006.png]]
 
Note: The Media Properties for this GW has to be set to G711A Exclusive! Therefore just this codec can be recorded. The media relay flag has to be switched on to force audio pass-through (and therefore recording) also in case if IP to IP calls.
 
Voice recording means CPU and storage load and a clever layout can minimizes the usage of those resources while especially in huge scenarios an unconcerned one can cause huge workload.
 
First of all record possibly just what is necessary. If you have for example 2000 user but you have to record just 20 of them, recording all traffic is not a brilliant idea. Because the PBX CPU streams all the conversations down to the CF/Webdav, then the recorder has to delete 99% of those files. Not really a big deal if absolutely necessary, but probably there is a smarter way. For example record directly just the 20 IP-Phones phones. 
 
 
 
The CDR0 or CDR1 must point to the reporting tool (Type = “REMOTE-AP”, IP address and Port 80).
 
Note: on the trunk object the flag “reporting” must be on (and you will need one reporting license for that).
 
= IP-Phone setup =
 
Voice recording can be done by the Gateway but also directly by the innovaphone IP-Phone.
 
Doing VR using the IP-Phone has the following advantages or disadvantages; it depends on your point of view and the scenario.
 
- CPU-Load: No CPU power from the PBX is required, a Phone has enough CPU-Power to do that and more, and therefore it becomes an extremely scalable solution. If you do not use an external WebDAV server but a CF anyway the PBX CPU has some load (playing WebDAV server for the Phone)
 
- All calls on the phone are recorded (not just those crossing a gateway), so even internal calls (basically everything the phone is doing).
 
- Al users working on the phone are recorded. This means also that each possible user on the phone must have the reporting license otherwise a call from that user will cause a major alarm.
 
- Transferred calls to other extensions are after the call transfer no longer recorded. In case of gateway recording it is different, until the call cross the gateway recording is done.
 
- If you mix both setup in a scenario you should avoid that a Phone is doing recording and cross a gateway doing recording too. If that happen recording is done in two points and you double for nothing disk space and resources (and confuse everybody).
 
- Only innovaphone IP-Phones IP2x2 series and “A”-types (like IP110A, but not IP110) can performing VR directly.
 
 
If you like or must do recording not in the GW but in the IP-Phone, here is how:
 
Switch on the recording has to be done in the phone setup file, there is no menu option.
 
Save the setup file of the phone, open an editor, edit the setup and load the setup up again.
 
In the setup you will see a row beginning with “config change PHONE SIG”, that is the strategic point to edit.
 
The command to add is </record http://xx.yy.zz.uu/path>.
 
Example:
 
Your config line is like that:
 
config change PHONE SIG /no-intrusion-tone on /prot H323 /gk-addr 172.16.88.98 /e164 37 /tones 0 /lcoder G711A,20, /coder G711A,20,
 
while you recording path is on the CF in the directory “RECORDING” and your PBX has the IP-Adress 172.16.88.98. you line must be the following:
 
 
config change PHONE SIG /no-intrusion-tone on /prot H323 /gk-addr 172.16.88.98 /e164 37 /tones 0 /lcoder G711A,20, /coder G711A,20, /record http://172.16.88.98/DRIVE/CF0/RECORDING
 
= Multiple Voice Recorder and Player =
 
This section describes how to run more than one Voice recorder and player on one single PC and one single user.
 
== Voice Recorder ==
 
If you install more than one recorder running on one single PC user (obviously in different directories) you face the problem that both share the same setup.
That is so because the recorder writes his setup and log files in the “user\AppData\roaming\innovaphone\innovaphone Recorder” directory.
Therefore in the genera Panel of the setup of the recorder there is a flag “save setup in own directory”; if flagged the setup will be saved in the directory where the recorder is running. Admin rights are required (or at least the recorder application must be launched with those credential, right mouse and “start ad administrator”).
 
Technically all recorders will load after the start-up in the user-appdata directory the setup and find out that the data should be retrieved and stores in the local directory. Therefore the “own” directory is detected and the local setup loaded.
 
 
Note that each voice recorder has to interface the PBX SOAP where the recording user are registrated and each recorder must have his own CF/Webdav directory. Each recorder must have also his own and different group.
 
Example 1: One singe PBX, two groups of user to record on 2 recorder. Load the license for the total number of use to register in the master PBX, assign each group a different recording group name. Install the recorder in different directories and do the setup, the SOAP user and the reporting is the same. But you have to store the recording pcap files on different directories. In some cases this is quite simple because you route the outgoing and incoming traffic over different GW pointing on different directories of the CF/Webdav. In some cases this is difficult or impossible, and so the only way is that the user of one group records directly from the innovaphone IP-Phone in a separate directory.
 
Example2: Master/Slaves where the Salve user are registrated in the salve and not in the master PBX. But all users use the same trunk line on the slave site. There should be recorded user in the master and user in the salve PBX. Even in this case you need 2 recorder engines, one read out the SOAP in the master and record the user in the master and point to the SOAP of the salve PBX. The user in the slave PBX has to record directly from the phone to a dedicated CF/Webdav directoy.
Note that in case of more recorder the storing path could be the same, so the player will have all records in one directory.
 


[[Howto:Last_Call_Recording]]


== Player ==
[[Howto:Universal_Track_Recording_Tool]]


If a user want run more Player on one PC that is probably because he want create different shortcuts on the desktop to start different player (with different setups).
[[Howto:Integration_reporting_and_voice_recording]]


Also the player stores his data in the user-app directory like the recorder, in the directory “user\AppData\roaming\innovaphone\innovaphone Player”. Of course doing so all players even if installed in different directories will access to the same setup, not a good idea. Therefore a player can be launched with an optional command indicating the directory where the setup should be loaded and stored. In the shortcut the directory must be inserted with a space after the command itself.
[[Howto:Soft-migration_%28looping_in_a_innovaphone_gateway%29_and_Voice_Recording]]


Example:
[[Howto:Player_over_http]]


This is the original path in the shortcut:
[[Howto:Marking_a_record_in_Voicerecording]]
 
"C:\Program Files\innovaphone\innovaphone Player\innovaphone_Player.exe"
 
If you add the path “c:\asdf\” the setup will be stored in that directory, so you have to change the property of the shortcut in
 
"C:\Program Files\innovaphone\innovaphone Player\innovaphone_Player.exe" c:\asdf\
 
(Note no quotation marks for the path and a space after the link to the setup directory)
 
 
= Player Setup =
 
See relative Reference:
 
 
* [[Reference10:Voice_Player/Setup]]


= Download =
= Download =
*[http://sox.sourceforge.net/ Download SoX executable for Win32 from sourceforge.net)]
*[http://sox.sourceforge.net/ Download SoX executable for Win32 from sourceforge.net)]
*[http://sourceforge.net/projects/lame/files/lame/3.99/ Download Lame from sourceforge.net]
*[http://sourceforge.net/projects/lame/files/lame/3.99/ Download Lame from sourceforge.net]

Latest revision as of 08:48, 4 September 2019

The setup is stored in the directory where the recorder is running; therefore more recorders can be started on one single system using different directories. Please note that the setup file is a XML file but AES crypt, so not readable.

In the headline of the setup the version is displayed, note that the version can be displayed also in the recorder main menu clicking on the innovaphone logo.

The setup described in this page concerns version 10.00 of the Recorder Software.

The software was developed under Win7 but should operate also using windows Server (while the player software is not running without special setups using windows server).

The recorder requires reporting Version 10, Build 1134 or higher.

The recorder requires working Reporting software. The reporting can work on a physical gateway or on a VMware environment (even on a player). See relative articles how to setup the reporting tool.

A standard problem in the recorder setup is the correct link to the PCAP files. Therefore be precise in the relative Group and read the chapter.

Recorder Setup

Note: To map network drive an application must have administrator rights. Therefor the PC must run with admin credentials or at least the recorder application must be launched with administrator rights.

This decription concerns that screen:


RecSetup21.png

General

Recorder Name

This Name is displayed on the headline of the main menu and also reported in the start- up message log file.

Password

Password of this setup, if blank no password is asked to access to this setup. Please note that this password is also the default password for the player and can therefore be an important security feature.

Customer Key

The recorder encodes the record data files (the XML) using an internal standard key. If in this field a User Key is defined the encoding is done using this key. Therefore also in all players has to be configured this key. Remember that the decoding in the player depends on the local setup of the player. If no user key is defined the standard system key is used. If a user key is found a decoding is tried using that user key, if decoding fails the system key is used, if even that fails no decoding is possible.

Therefore once a user encoding key is defined it should not be changed, otherwise the “old” user encoded records cannot be decoded.

So if not really required leave this field blank, if you define a user endcoding key think well about it and...

WARNING: do not forget it (there is no way to find out the key).

Encode audio

Audio files are store in clear wave or mp3 format. Any media player could reproduce them, the integrity of those files is controlled from the innovaphone player. The audio file integrity data are stored in the encodet xml file.

If this option is checked also the audio file will be encoded using the same key used for encoding the xml file (see description in “Customer key”).

Encoding cause more CPU load for the recorder and the audio file size is doubled.

Once encoded an audio file can be reproduced only with the innovaphone player, if a customer encoding key is configured just if also in the player that key is used. In that case the audio file can be reproduced just with the innovaphne Player using the customer encoding key.

Do not Record empty Files

Very short calls (typically seconds) causes very small recording files, so small that a reproduction is not possible (there is practically no audible audio data in).

The recorder can eliminate those files (recommended), but if for some reason you want keep those files (practically you just keep the call information from the reporting) do not flag this option.

Save Setup in own directory

See here

Do NOT save CDR data

If checked no CDR data are saved, just the audio files. If this option is switched on the player cannot display any additional call info. Also the integrity of the record cannot be assured (unknown) and a manipulation will not be detected. Also Agent notes are not possible and snapshots are disabled and even the original timestamp cannot be displayed on the player. Note also that a record once stored with this option on cannot be recovered later on.

Write clear XML copy, file extension

The connection data and stored in encoded xml file. The innovaphone Player decode those data and display them automatically. On top the player can export the connection data in a clear (not encoded) format. Anyway some customer wants a copy of the connection data on a central point in a clear file format. If this option is marked the recorder will make a copy of the encoded xml file, the name is the same but the extension must be defined. Do not enter the dot in the file extension field.

Convert to Mono

Audio files are stores in stereo format where the external caller is on the left channel while the internal audio is on the right channel. This allows for example to amplify one channel more than the other etc. If this flag is checked the audio file format is converted from stereo to mono and the file size is reduced about 50%.

Remember that once converted to mono there is no way to restore the stereo image.

One channel audio

If checked just on channel is recorded, typically the left one because there the internal caller is speaking. If requested also only the right caller can be recorded. In most countries recording just the internal caller (recording myself) is permitted without limitations.

Softmigration/Slaves

(Build 1072 or later)

Check if the gateway is looped in between the PSTN and the PBX.

Do not mark in all other situaytions.

See relative Howto article for details.

Store PCAP files (no pcap2wav)

Audio files are saved in the PCAP format; the player is capable to reproduce even pcap files. This flag is mandatory if the recorder is used as a service (see relative article).

MP3 indicator lamp

If a conversion from wave to mp3 audio format is requested some external files and utilities has to be present in the recorder directory. During start up the recorder check if all those requires files are present and if yes mp3 compression is switched on automatically and the lamp is green, if not conversion to mp3 is switched off and the lamp is gray.

Work as http Player server (no recording)

(Build 1074 or higher) Warning: If checked the recorder will be just a http fileserver for the player, no recording is done!

Setup the storage path in the “Storage” tab and the Socket in the communication tab (COM WITH PLAYER). All other parameters are meaningless.

See realtive article.

Work as Pcap to Wave converter (no recording)

If flagged this application will detect in the storage subdirectories pcap file and convert them to wave or mp3 and performs the down mix can be done (stereo to mono, one cannel). This operational mode can be switched with the Player server mode if required.

Recording trunk for manual rec+ ann.

Put in the number of the recording trunk for manual recording with announcement. Leave blank to disable feature.

From build 1198.

See Reference10:Concept_Voice_Recording_2014#Recording_Modes for feature description.

XML/WQ for manual rec + ann.

Put in the number of the XML or WQ for manual recording with announcement. Leave blank to disable feature.

From build 1198.

See Reference10:Concept_Voice_Recording_2014#Recording_Modes for feature description.

Start in Taskbar

If checked the recorder will start minimized. Because the recorder has a complete user interface this software is not designed to run as a service. For automatic start-up include the .exe in the auto-start folder.

Trace

Do not confuse the logfile with the error logfile, the error log is written in any case and named iREC_Error_Log. This trace/logfile is called iRECsys_Log.txt and contains all operational tasks like copy of file, converting ecc., not just events like startup or errors. This flag should be switched on just in special situation for example during installation of a new system or in case of error searching, because this file becomes very huge and there is no automatic limitation foreseen.

Keep PCAP copy

If checked the recorder leaves a copy of the PCAP file in the sub directory “REC” of the Storage directory (from Build 1191).

open trace folder

This link shows you the path to the Log files. In case of problems please send us always the error log file.

PBX

Communication to the PBX is necessary because of licensing and SOAP traffic supervision. Like in other applications admin access and SOAP user is required.

RecSetup89.PNG


IP addr.

Indicate the IP Address of the PBX where the Recording licenses are in (the license master). Typical license are displayed in the PBX as “Recording10”.

IP addr. Stby

Indicate the IP address of the standby PBX. Leave blank if there is none.

User / Password

Of the PBX where the license are in. Default example: admin / ip800

SOAP USER

The SOAP user in the PBX where the licenses are stored has to be indicated. Usually it is a dummy user object in the PBX without any registration, for example a user called “SOAP” or “_TAPI_”.

Agent Group

Put all extensions where the recording feature is required in a group (not active) and define here the name of this group.

The recorder will read out all extensions during start up and initialize those belonging to this group. A result is that events from these extensions will be transmitted to the recorder.

Just extensions being part of that group will be recorded; eventual records of objects not in this group will be deleted. If a record is detected but the relative object is not in that group a message like “Record skipped Agent not in group” is displayed (but no error is triggered).

During start-up the recorder read out the number of license for recording stored in the PBX. Each time a object is in the recording group the number of free licenses is decreased. So the putting in the recording group is limited if the maximum number of license is reached.

Please note that in special situations, for example if you have a trunk line object but also a External object (a gateway) to a remote PBX both objects has to be in the group, otherwise calls form the trunk to the gateway will not be recorded.

TAN

Build 1167

Enter If the the number of the TAN XML (TAN.xml) if TAN feature is active. If you do not record direct on the trunk or the user but on a special GW with prefix also that prefix could be necessary before the number of the XML( typically not). See Concept article for description of the TAN feature.

License Master

In scenarios with license master and recoding on slave PBX (do not confuse with the feature slave recording, in this case the recorder is just simply a recorder on a slave PBX) the relative licenses are stored in the master PBX, in normal scenarios just leave blank.

Use Stored Lic

If there are more recorders on one single PBX do not check this flag on the first one and start it. Than then start all other recorder with this flag switched on. Stop the first recorder, set the flag and start it again. In this way just one license per user is required. If the number of licenses change all recorder has to be stopped and the procedure repeated. Build 1164.

Reporting

The recorder must get ticket from the innovaphone reporting tool. The Reporting can run on a gateway or VMware (player or native), there is no difference for this setup.

When the recorder detect a call end (in normal operation because the SOAP will tell that) the recorder will ask the reporting if there is a related record. If yes the recorder check if the user is in the recording group, if yes the call will be processed, if not deleted. If the recording has no record to the call that could be because the recorder is to fast (the record is not jet processed by the reporting) or because this user has no reporting. Therefore the recorder waits and tries later. After 4 trials the recorder gives up and deletes the file. Such a situation slows down the recorder and therefore all users should have the reporting or just users with reporting should produce records.

RecSetup03.png

IP address

Enter the IP address of the device where the reporting is running.

If you run the reporting on a PC enter the IP address indicated on the VMware virtual machine.

If not visible enter “ifconfig” in the VMware panel, the address is shown under inet addr. Remember that the address is usually not 127.0.0.1 (even if the reporting is running on the same PC).

IP addr. Stby

Indicate the IP address of the standby reporting. Leave blank if there is none. Remember that both, active and standby PBX must sent the CDR tickets to both reporting applications and replication between must be switched on.

Follow Standby/Active PBX

If a switch (and especially an automatic switch back) to the active reporting is required flag this option “Follow Standby/Active PBX”. If this option is not flagged and the active PBX is on again the reporting will not switch back (until the recorder is not started again or the standby reporting fails).

User/Password

Enter the credential to access to the reporting, default is “admin” and “linux”.

Path Reporting

Enter the path to the main screen of the reporting, typical (and default) is “/apps/innovaphone-reporting/report.php”. Should work normally, do not modify this setup.

Try to reach reporting

In this field is shown the result of the input. You should be able to reach the reporting from the PC using a browser and this link.

Swap incoming/outgoing

What “incoming” or “outgoing” is depends on the point of view. If clicked “in” and “out” (“i”, “o”) are simply swapped.

No Reporting Sync

If checked the reporting is not synchronized with the voice recorder. If not checked (default) the voice recorder informs the reporting if a stored recording is deleted and the database of the reporting is updated. Even if a Player delete a record (and has connection to the voice recorder) the recorder send relative information to the recorder, and the recorder again informs the reporting engine.

Alarm if no CDR ticket found

There must be for each recorded call a CDR ticket. If this option is checked an alarm (email) is trigger if there is no ticket. There are two situations where an alarm could trigger: if in online operation an agent (a user in the Agent group, means a user to record) end a call and there is no ticket after a time-out and after start-up where all pcap files buffered must be checked (agent or not) asking the reporting.

User A to force to incoming

(not shown in picture)

In some cases calls diverted to external numbers should be forced to be signed as incoming calls even they are form a Reporting point of view outgoing once. It is possible to define a caller A, if he did the call the direction will be forces to “I”. Up to 50 extensions can be defined.(Hotfix 23)


PCAP

RecSetup23.png

Note that the setup for a compact flash (CF) is different than the one using a webdav!

If you use our CF with the innovaphone application platform the CF is considered as a webdav service.


The recorder downloads the pcap records from the CF or webdav server. See examples Webdav and Compact Flash and observe the different required inputs.

There is no difference between a IPVA or a Webdav server on a hardware device, in the Webdav example you will see the path to an Application Webdav service on a IP810. In the example the pcap are stored in the directoy /MyPCAPpath. Basically also in the gateway or phone the path for the recording is that one.

Follow Standby/Active PBX

If this flag is on in case of switch to the Standby PBX of the PBX connection also the PCAP path is swapped. If not the path is the same (scenario if for example an external Webdav server on a HA VMware is used).

User/Admin

Credentials for accessing the CF or Webdav server, see examples.

Path PCAP

Path to the directory ahere the PCAP are stored. See examples.

HTTPS

Self-explaining

Delete old PCAP Files

After a number of cycles without response from the reporting the pcap file will be deleted. In a correct working system this should never happen because all users in the PBX should have the reporting. Default value = 500, minimum value=1.

Delete Pcap without CDR

If no ticket is received after the number of cylices defined the recorder delete the pcap file. Before doing that he tries to copy the pcap file in the TMP subdirectory of the storage path. At least those files are not lost. If this option is checked no emergency copy is done.

Storage

The setup parameter in this panel defines where the recorder stores the records. While the Root storage Path is mandatory, the backup path is a option.

Set Root storage path

The path indicated in this option is the working directory where the files after retrieving, naming and converting are written. It is also the directory where the player will look and search for files.

If you click the “Set” button a directory dialog box appear, select the directory where you want store the voice records and confirm. You can edit the path even manually, not recommended.

If destination of the storage you are using is a Webdav folder on the same LAP where you are saving the pcap files, and you want to use a mapped drive (for example F: or N:), mapping the drive using Windows feature will cause writing/reading issues, and Recording won't convert the file in .wav in the storage path.

To avoid this, use a third party software like "Net Drive" to create the network map.

Delete (records) after moth

The indicated number of month is the maximum storage depth. The minimum is 2 (so the actual and the last month will always be available), indicating 99 disable the feature. Deleted files cannot be recovered, the name of the deleted files are reported in the syslog.

Note that file in the backup path will never be touched.

Set Backup path

This path is optional; if blank the feature is off.

If you click the “Set” button a directory dialog box appear, select the directory where you want store a backup of the voice records and confirm. You can edit the path even manually, not recommended.

Note that files stored in the backup directory are not visible for the player and even the automatic delete is not active. The indicated directory is typically on a NAS or SAN system.

Communication

This page shows 3 independent container:

RecSetup05.png

COM WITH EXTERNAL APPLICATION (option)

Necessary if the recorder is interfaced to an external application, see reference help in the main window for details. Leave all blank if no external application is required.

Do not confuse this section with interfacing reporting or player – these are options for external servers and applications.

Lounch application string

When a record is detected a application can be triggered, see relative description.

Keep Alive

Indicate in seconds the time period between sending keep alive messages from the recorder to the external application (default=10 seconds).

IP address / Port

IP address / Port of the external application server.

Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.

Lounch path

URL to be launched.

COM WITH PLAYER

Communication with the player is an option, indicating a port number, it will be switched on from the recorder point of view and request from the player will be processed.

Indicate in the “port” field a free communication port while under “own IP address” the IP address of the PC is indicated.

The recorders try to find out automatically his “own” communication port; that sometimes fails in virtual environments. If the indicated IP address is not correct put in the right one (the on for this application).

Be carefully in assigning the port number, no duplicate port number should be assigned and the port number must even be free from the server point of view.

To switch off this feature leave the port field blank.

Note: If the recorders works as a fileserver for the player this address and port is the communication socket for the player (Build 1074 or higher).

Password (build 1136):

Password for player to access to the recorder if the recorder act as http player server or even if a player want retrieve the recorder status. Leave blank if no password protection is required, if this field is blank eventual password in the player are ignored.


GROUP EMAIL ALARM (option)

If the recorder switch on the master alarm a supervisor can be receive an email. The message object is "Voice Recorder " + Name of the recorder + " - ALARM NOTIFICATION", while the body text contains the last master alarm reason and the text "Automatic generated Alarm - Do NOT answer!".

Please note that a mail is sending just one time even if the error is recovered automatically (for example if the reporting is reachable again, then fails, then works etc.). To rearm the email the master alarm must be quit. This is intentionally to avoid tons of emails in case of toggling errors. The rule is that after an alarm email the application has to be checked.


e-mail account

Enter the destination email account for example kwa@innovaphone.com

If this field is empty the feature is off.

e-mail server

Enter the e-mail server, for example 155.5.23.24


Password

Not necessary for Exchange but could be.


TCR/MRK/RND

RecSetup06 2.png

Thread Call Recording

If checked the feature TRC is on, otherwise off (default). If this option is checked the Recorder will work in the Thread call Recording mode (TCR), if not in the standard mode (STD). No mixed mode is possible for one Recorder. If TCR is on records will be saved only if the user define this call by call. That could be done automatically if calls are processed by innovaphone IP-Phones or on demand during a call if innovaphone IP-Phones are used. But it is also possible to mark a call after the call end for a certain period, after that period the recorded file will be deleted. TCR files contain always the entire voice call from the beginning on , even if the mark is done during or after the call.

TCR flag Timeout: After that timeout calls not marked are deleted. A typical value is 5 minutes.

XML Number: If a user marks call he will call a XML, during the call using a 3conference party or after the call calling simply the xml. Of cause that “marking” calls to the xml should not be recorded (but the will if for example the phone has permanent recording on). Indicate the number of the xml, in this way the recorder will delete this “marking” calls.

Mark Records

If this option is switched on a user can mark a record. Marked records are visible in the system playlist of the player. This can be done during conversation (with innovaphone IP-Phone only) or after a record dialing a number. The mechanism is similar to the TCR and in fact there is used the same XML to do that. TCR is switched on no marking is possible (senseless, the user “marks” to record while this feature mark records in normal operation mode).

Delete Records

Build 1188

A user can skip (not store) some conversations. This is done using a similar mechanism used with the TCR. If at the end of the conversation a file is found this record will be deleted. Therefore it works only if this file is created during the conversation. This can be done calling the XML TCRec.xml (with a feature key, the recording feature of a innvaphone IP Phone, putting the actual call on hold and call the xml or using an external application). The file has to be created in the recording directory/TMP.

File format: TCA-XXX_XXX.txt where xxx= the agent number.

Example: TCA-1234_1234.txt -> the record of the actual conversation of the agent 1234 will not be recorded.

The field itself could be empty, but observe that with Linux at least one character should be in.

Please note also that the time of the reporting, PBX and webdav must be the same. The Feature works also with the (old) CF.

If a record is skipped because of theis feature he log will show the message “User Mark Record to delete found TCF=” and the Agent number.

Random Recording

If marked conversations are recorded in a random way. Not every conversation will be recorded and recording is uses for example just for a statistic quality check. There are two parameters that can be combined, a counter of records and a counter of calls for a agent. If for example the “Record in System” counter is set to 5 only each fifth call will be recorded. If the counter “Record for Agent” is set to 2 for a single agent will be recorded each 2nd conversation. Combined for a User it will be unforeseeable if a call will be recorded or not.

Slaves

RecSetup10.png


Slave PBX saves the PCAP record in a “far”, own compact flash/webdav while the CDR data are stores and saved in a central reporting.

Note: There must be a Master setup, it is not possible to have just slaves, a main site is required where for example the licenses for the recording are stored.

The Slave setup is similar to the PCAP setup (IP-address, User, Password and PCAP- Path). The field “Name” is just to remember the site and select a site form the recorder main interface.

To add a new Slave-site select an empty line in the table, enter all data and press the save button.

To delete a Slave-site select an existing line, delete the IP-address and press the save button.

To modify a Salve site select an existing line, do the modification and press the save button.

Interval (min)

Set a time interval in minutes, shortest value should be 1 (do not enter 0). The slave PBX will be checked just after this timeout is expired. Example "20": The recorder check if there are PCAP-Files to import, than waits for 20 minutes before checking again.

Note: Slave sites are checked after the main site is worked out. Therefore the main site records have a priority in handling. If for example the main site has continuously records to save the slave routines are delated.

In the interval line a “from” – “to” time span can be defined. Salves will be checked just in this timespan. Empty values means “always”.

Example 1: “08:00” to “18:00” means “during worktime” while “22:00” to “04:00” means “during the night”.

Note: Also during the timespan the Interval timeout is observed.

Example: Interval = “5”, “14:00” to “23:00”: the recorder will import data form 14:00 to 23:00, checking each 5 minutes if there are any new records.

Note: The Recorder interface will show an additional Combo box where a slave site can be selected (showing the name fields). The operator can select a Salve site and force the download of the PCAP files. This is usefully if a specific record should be downloaded immediately.


Audio compression

The wave audio files are jet G711 compressed but stored as a stereo file in a wave container format. Storing native PCM would requires about the double disk space and is not done. One minute of raw PCM requires about 2 MB while the recorder reduces as default this size at 1MB.

Unfortunately if switched on audio encoding will double again this size. Even if the customer wants a very long period of storing data or has limited disk space additional compression would be fine. Mp3 compression can be switched on using external 3rd party software.

The recorder can pilot automatically external applications called “lame.exe” and “Sox.exe”. Lame is an open source (GPL) tool and even SoX is an open source (GPL) tool (SoX is described also in another Wiki article).

The recorder use no source code inside and calls the applications like a batch file (of cause providing relative command line info).

Do not “install” lame or SoX, just download the packages and copy the following files in the folder where the recorder is running:

- Sox.exe

- Lame.exe

- Libgomp-1.dll

- Pthreadgc2.dll

- Zlib1.dll

During start up the recorder check if those files are in the directory and if yes mp3 coding is on while if just one file is missing encoding is off. If you open the extended view of the recorder an mp3 Led shows you mp3 coding status (on or off).

With mp3 option on the required file size is reduced about 75% (1 MB will become 250kB).

Note that encoding audio files will double again the file size. Encoding can be done with wave or mp3 files. An encoded audio mp3 file requires anyway just 50% disk space that a clear wave file does.

Note: Latest release from sox there is no more a file called "Pthreadgc2.dll". You have to take release 14.4.1 or earlier.

Other Setup

For Reporting setup, PC setup, Gateway setup, IP-Phone Setup, Multiple Voice Recorder and Player see related Articles (System Setup)

Related Articles

Reference10:Player_Voice_Recording

Howto:Last_Call_Recording

Howto:Universal_Track_Recording_Tool

Howto:Integration_reporting_and_voice_recording

Howto:Soft-migration_(looping_in_a_innovaphone_gateway)_and_Voice_Recording

Howto:Player_over_http

Howto:Marking_a_record_in_Voicerecording

Download

Retrieved from "https://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/Setup&oldid=53419"