innovaphone wiki - User contributions [en]

Howto:Behnke SIP intercom - Behnke - 3rd Party Product

2025-12-09T14:41:40Z

Gnd:

Remark: This information is outdated. For the latest information, please visit the following link: [http://www.behnke-online.de www.behnke-online.de]

[[Image:Behnke_logo.png||200px|right]]
==Product Name==
[http://www.behnke-online.de Telecom Behnke SIP intercom]

==Certification Status==

{{Template:Compat_Status_referral_product_new}}

Testing of this product was performed in December 2018.
==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]
==Description==
===Description (German)===
Behnke SIP-Sprechstellen der Serie 20 sind hochwertige modulare VoIP-Sprechstellen aus Metall mit akustischer Echounterdrückung zum Vollduplex-Freisprechen. Die Bedienelemente der Sprechstellen werden im Baukastenprinzip aus diversen Funktionsmodulen zusammengestellt. Dadurch wird ein Höchstmaß an Flexibilität in Planung und Anwendung erreicht – vom hochwertigen Kameramodul, bis hin zum Einsatz von Zutrittskontrollsystemen wie Kartenleser und Fingerprint. Die Sprachverbindung erfolgt per Voice over IP (VoIP) nach dem SIP-Standard über ein angeschlossenes Ethernet LAN. Hierfür wird entweder eine SIP-fähige Telefonanlage, ein SIP-Provider oder die direkte Wahl einer IP-Adresse verwendet. Konfiguration und Software-Updates erfolgen per Web-Frontend. Der verschlüsselte Zugriff auf die Konfigurationsoberfläche genügt höchsten Sicherheitsstandards. Mittels SIP-Secure und secure RTP werden auch Telefonate vor unberechtigtem Zugriff geschützt.

===Description (English)===
The Behnke Series 20 SIP intercom is a high-quality, modular VoIP intercom with a metal front panel and acoustic echo cancellation for full-duplex, handsfree talking. The control elements can be combined from a number of different modules. This will give you the maximum of flexibility for both planning and usage – from high-quality camera modules to access control systems like RFID or fingerprint readers.VoIP-calls are established via the standardized SIP protocol over the Ethernet LAN connection. You can use it with your SIP-PBX, your account at your SIP provider, or in peer-to-peer mode with your SIP phone. Use the web interface to configure and update the intercom. The encrypted access to the interface meets the highest security standards. The intercom also provides SIP-Secure and secure RTP features to protect your calls from unauthorized access.

==Features==
===Features (German)===
* Modularer Aufbau
* Bis zu 8 Direktruftasten mit frei konfigurierbaren Rufnummern anschließbar (mit Erweiterungen bis zu 100 Tasten)
* Status-/Fernsteuermeldungen zur Integration in Fremdsoftware
* 9 Sprachansagen mit je bis zu 40 Sekunden Länge speicherbar
* Zeitsteuerung
* Alarmeingang
* Integrierter, VLAN-fähiger Switch
* Autoprovisionierung
* Versand von E-Mails bei Nicht-Erreichbarkeit (mit Kamera-Bild bei SIP-Sprechstellen mit Kameramodul)
* Konfiguration in Datei speicherbar
* Zwei konfigurierbare potenzialfreie Relais
* Optionales Sicherheitsrelais zur abgesetzten Montage
* Modul Tastwahlblock, Funktionen:
- Direkte Rufnummernanwahl
- Codeschloss
- Kurzwahl mit bis zu 100 Zielen
* Modul Display, Funktionen:
- Vier Zeilen mit je 20 Zeichen
- Infotexte je nach Gerätezustand, konfigurierbar
- 199 Telefonbucheinträge, mehr auf Anfrage

===Features (English)===
* Modular design
* Connect up to 8 call buttons for configurable phone numbers (with addons up to 100 buttons)
* Status and remote control messages for integration in 3rd party applications
* Record and play 9 announcements (40 seconds each)
* Schedules for timer functions
* Alarm input
* Integrated VLAN switch
* Auto-provisioning
* Send an email if the callee is not available (with photo)
* Save your configuration in a config file
* 2 configurable potential free contacts
* Optional with security relay for remote installation
* Optional key pad, functions:
- dialing
- code lock
- speed dialing for 100 call targets
* Optional display, functions:
- 4 lines, 20 characters each
- Display configurable messages
- Phone book with up to 199 entries

==Version==
Version of tested products for both 3rd-party-product and innovaphone:

* Behnke: SIP 2.0, Firmware BT: 4, Build: 169 (up to and including the 2023 model year).
* innovaphone: Virtual Appliance, Build 125487

==Configuration==
===Configuration (German)===

* Legen Sie zunächst einen User für die Sprechstelle in der innovaphone PBX an. Die im Screenshot markierten Werte werden später für die Registrierung der Sprechstelle benötigt.
[[Image:Howto_Behnke_on_innovaphone_PBX_01.png]]

* Öffnen Sie dann die Weboberfläche der Sprechstelle, melden Sie sich an, und wählen Sie auf der Startseite links den gelb markierten Punkt "'''Einfach-Konfiguration'''".

* In den Feldern unter "'''SIP Einstellungen'''" werden die Werte des innovaphone Users entsprechend dem Screenshot unten eingetragen.
[[Image:Howto_Behnke_on_innovaphone_PBX_02_de.png]]

* Unter "'''Direktwahltasten'''" kann den Tasten der Sprechstelle eine Rufnummer zugeordnet werden, welche dann bei Tastendruck angewählt wird. Klicken Sie anschließend unten rechts auf "'''Übernehmen'''".

===Configuration (English)===

* Please add a user for the SIP intercom in your innovaphone PBX. The marked values in the screenshot below are required for registering the intercom with your PBX.
[[Image:Howto_Behnke_on_innovaphone_PBX_01.png]]

* Access the web interface of your intercom. On the left-hand side of the Home screen click the yellow button "'''Easy-Config'''".

* Fill in the values of the innovaphone user under "'''VoIP Account'''" according to the screenshot below.
[[Image:Howto_Behnke_on_innovaphone_PBX_02_en.png]]

* Under "'''Direct-dial keys'''" you can assign a phone number to the button of the intercom. Then click "'''Apply'''" at the bottom of the screen.

==Known Issue==

innovaphone PBX Firmware 14r2SR7. 
There is an issue with DTMF transfer and ICE negotiation. Connection is established but you can not transfer the DTMF signal.
If you have this issue, activate on the Behnke site the option "no ICE".
For the PBX object you have to activate the options "Media Relay" and "No SRTP".

==Contact Details==

Telecom Behnke GmbH

Gewerbepark "An der Autobahn"

Robert-Jungk-Straße 3

66459 Kirkel

Deutschland / Germany

[http://www.behnke-online.de www.behnke-online.de]

[mailto:info@behnke-online.de info@behnke-online.de]

[http://www.behnke-online.de/service/technik-support Support]



[[Category:Compat|{{PAGENAME}}]]

Howto:Behnke SIP intercom - Behnke - 3rd Party Product

2025-12-08T12:14:42Z

Gnd:

[[Image:Behnke_logo.png||200px|right]]
==Product Name==
[http://www.behnke-online.de Telecom Behnke SIP intercom]

==Certification Status==

{{Template:Compat_Status_referral_product_new}}

Testing of this product was performed in December 2018.
==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]
==Description==
===Description (German)===
Behnke SIP-Sprechstellen der Serie 20 sind hochwertige modulare VoIP-Sprechstellen aus Metall mit akustischer Echounterdrückung zum Vollduplex-Freisprechen. Die Bedienelemente der Sprechstellen werden im Baukastenprinzip aus diversen Funktionsmodulen zusammengestellt. Dadurch wird ein Höchstmaß an Flexibilität in Planung und Anwendung erreicht – vom hochwertigen Kameramodul, bis hin zum Einsatz von Zutrittskontrollsystemen wie Kartenleser und Fingerprint. Die Sprachverbindung erfolgt per Voice over IP (VoIP) nach dem SIP-Standard über ein angeschlossenes Ethernet LAN. Hierfür wird entweder eine SIP-fähige Telefonanlage, ein SIP-Provider oder die direkte Wahl einer IP-Adresse verwendet. Konfiguration und Software-Updates erfolgen per Web-Frontend. Der verschlüsselte Zugriff auf die Konfigurationsoberfläche genügt höchsten Sicherheitsstandards. Mittels SIP-Secure und secure RTP werden auch Telefonate vor unberechtigtem Zugriff geschützt.

===Description (English)===
The Behnke Series 20 SIP intercom is a high-quality, modular VoIP intercom with a metal front panel and acoustic echo cancellation for full-duplex, handsfree talking. The control elements can be combined from a number of different modules. This will give you the maximum of flexibility for both planning and usage – from high-quality camera modules to access control systems like RFID or fingerprint readers.VoIP-calls are established via the standardized SIP protocol over the Ethernet LAN connection. You can use it with your SIP-PBX, your account at your SIP provider, or in peer-to-peer mode with your SIP phone. Use the web interface to configure and update the intercom. The encrypted access to the interface meets the highest security standards. The intercom also provides SIP-Secure and secure RTP features to protect your calls from unauthorized access.

==Features==
===Features (German)===
* Modularer Aufbau
* Bis zu 8 Direktruftasten mit frei konfigurierbaren Rufnummern anschließbar (mit Erweiterungen bis zu 100 Tasten)
* Status-/Fernsteuermeldungen zur Integration in Fremdsoftware
* 9 Sprachansagen mit je bis zu 40 Sekunden Länge speicherbar
* Zeitsteuerung
* Alarmeingang
* Integrierter, VLAN-fähiger Switch
* Autoprovisionierung
* Versand von E-Mails bei Nicht-Erreichbarkeit (mit Kamera-Bild bei SIP-Sprechstellen mit Kameramodul)
* Konfiguration in Datei speicherbar
* Zwei konfigurierbare potenzialfreie Relais
* Optionales Sicherheitsrelais zur abgesetzten Montage
* Modul Tastwahlblock, Funktionen:
- Direkte Rufnummernanwahl
- Codeschloss
- Kurzwahl mit bis zu 100 Zielen
* Modul Display, Funktionen:
- Vier Zeilen mit je 20 Zeichen
- Infotexte je nach Gerätezustand, konfigurierbar
- 199 Telefonbucheinträge, mehr auf Anfrage

===Features (English)===
* Modular design
* Connect up to 8 call buttons for configurable phone numbers (with addons up to 100 buttons)
* Status and remote control messages for integration in 3rd party applications
* Record and play 9 announcements (40 seconds each)
* Schedules for timer functions
* Alarm input
* Integrated VLAN switch
* Auto-provisioning
* Send an email if the callee is not available (with photo)
* Save your configuration in a config file
* 2 configurable potential free contacts
* Optional with security relay for remote installation
* Optional key pad, functions:
- dialing
- code lock
- speed dialing for 100 call targets
* Optional display, functions:
- 4 lines, 20 characters each
- Display configurable messages
- Phone book with up to 199 entries

==Version==
Version of tested products for both 3rd-party-product and innovaphone:

* Behnke: SIP 2.0, Firmware BT: 4, Build: 169 (up to and including the 2023 model year).
* innovaphone: Virtual Appliance, Build 125487
For Behnke stations manufactured from 2024 onwards, please refer to the following articles:
[https://behnke.support/?page=wiki&language=german&path=innovaphone-Cloud-Anlage]
[https://behnke.support/?page=wiki&language=englisch&path=innovaphone-Cloud-system]

==Configuration==
===Configuration (German)===

* Legen Sie zunächst einen User für die Sprechstelle in der innovaphone PBX an. Die im Screenshot markierten Werte werden später für die Registrierung der Sprechstelle benötigt.
[[Image:Howto_Behnke_on_innovaphone_PBX_01.png]]

* Öffnen Sie dann die Weboberfläche der Sprechstelle, melden Sie sich an, und wählen Sie auf der Startseite links den gelb markierten Punkt "'''Einfach-Konfiguration'''".

* In den Feldern unter "'''SIP Einstellungen'''" werden die Werte des innovaphone Users entsprechend dem Screenshot unten eingetragen.
[[Image:Howto_Behnke_on_innovaphone_PBX_02_de.png]]

* Unter "'''Direktwahltasten'''" kann den Tasten der Sprechstelle eine Rufnummer zugeordnet werden, welche dann bei Tastendruck angewählt wird. Klicken Sie anschließend unten rechts auf "'''Übernehmen'''".

===Configuration (English)===

* Please add a user for the SIP intercom in your innovaphone PBX. The marked values in the screenshot below are required for registering the intercom with your PBX.
[[Image:Howto_Behnke_on_innovaphone_PBX_01.png]]

* Access the web interface of your intercom. On the left-hand side of the Home screen click the yellow button "'''Easy-Config'''".

* Fill in the values of the innovaphone user under "'''VoIP Account'''" according to the screenshot below.
[[Image:Howto_Behnke_on_innovaphone_PBX_02_en.png]]

* Under "'''Direct-dial keys'''" you can assign a phone number to the button of the intercom. Then click "'''Apply'''" at the bottom of the screen.

==Known Issue==

innovaphone PBX Firmware 14r2SR7. 
There is an issue with DTMF transfer and ICE negotiation. Connection is established but you can not transfer the DTMF signal.
If you have this issue, activate on the Behnke site the option "no ICE".
For the PBX object you have to activate the options "Media Relay" and "No SRTP".

==Contact Details==

Telecom Behnke GmbH

Gewerbepark "An der Autobahn"

Robert-Jungk-Straße 3

66459 Kirkel

Deutschland / Germany

[http://www.behnke-online.de www.behnke-online.de]

[mailto:info@behnke-online.de info@behnke-online.de]

[http://www.behnke-online.de/service/technik-support Support]



[[Category:Compat|{{PAGENAME}}]]

MyApps Cloud - Comparison table

2023-11-28T12:07:06Z

Gnd:

[[Category:myApps_Cloud|Comparison|{{PAGENAME}}]]

{{HOWTOMOD13r3 Translation Info}}
__toc__

=Applies To=
This information applies to the innovaphone myApps Cloud versions:
*PREMIUM
*STANDARD

=Briefly the facts=

*The main advantages of '''PREMIUM''' over STANDARD environment are:
**the '''fully automated GEOredundancy''' between two '''High-Available Data-Centers'''
*** STANDARD has HA in one Data-Center with manual GEOredundancy
**the '''5-day power blackout protection''' is fully available.
*** STANDARD has one-day power protection
**the '''24x7 cloud infrastructure hotline''' as a default option.
*** STANDARD has this optional
 

{| class="wikitable" border="1" cellspacing="0" cellpadding="10" style="text-align:left; font-size:13px; font-family:Arial, Helvetica, sans-serif !important;;"
|- style="font-weight:bold; background-color:#c0c0c0;"
! style="text-align:center;" | Description
! style="text-align:center;" | Cloud-PREMIUM
! style="text-align:center;" | Cloud-STANDARD
|-
| style="vertical-align:top" | Cloud
| style="vertical-align:top" |
'''Contract partner:''' Partner or end customer 
* GEO redundancy at different locations
* HA server and HA '''DataCenter''' redundancy
** Both data centers active, ''=> active-active operating mode'' 
** Third data center for backup data
* '''Daily''' backup - instances & infrastructur
* Restart time for data center failure: in the range of '''seconds'''
* Blackout / Autonomy time: '''120h'''
* Storage availability: RAID + '''GEO-DataCenter-Mirror''' + Backup
* Minimum consumption: not defined iSC / month
* Infrastructure-Hotline-License ''' ''inclusive'' 24x7 hotline'''

 
[[Image:Cloud_Compare_PREM-DC.png|600px]]
| style="vertical-align:top" |
'''Contract partner:''' Partner or end customer 
* GEO redundancy at different locations
* HA server redundancy
** One active data center
** A Standby data center ''=> active-passive operating mode''
** Third data center for backup data
* '''Weekly''' backup of instances - infrastructure daily
* Restart time for data center failure: in the range of '''hours'''
* Blackout / Autonomy time: '''24h'''
* Storage availability: RAID + Backup
* Minimum consumption: 500 iSC / month
* Infrastructure-Hotline-License ''' ''for optional'' 24x7 hotline'''

 
[[Image:Cloud_Compare_STD-DC.png|600px]]
|-
| style="vertical-align:top;" rowspan="2"| Phone- Hotline 24x7
| style="border-bottom:hidden;" | Inclusive
| style="border-bottom:hidden;" | Optional
|-
| style="border-top:hidden;" colspan="2" |
'''Provision of services by:''' innovaphone 
* Emergency infrastructure hotline service
**Exclusively for certified partners
**For cloud instances in operation and completely licensed by Infrastructure-Hotline-License
* Qualified ticket opening by email before calling
**Authorization through confidential identification markers
|-
|}

=HA concept of both myApps Cloud variants in detail=
 
{| class="wikitable" border="1" cellspacing="1" cellpadding="10" style="text-align:left; font-size:13px; font-family:Arial, Helvetica, sans-serif !important;;"
|- style="font-weight:bold; background-color:#c0c0c0;"
!
! style="text-align: center;" | PREMIUM
! style="text-align: center;" | STANDARD
|-
| colspan="3" style="background-color:#f2f2f2;" |
*Both innovaphone myApps Cloud variants are currently based on a GEOredundant disaster recovery concept within Germany.
*Due to the different levels of technical complexity, different service availability requirements are covered in the event of a disaster.
|-
| - 1 -
'''Restart time for data center failure / Downtimes'''
|
*'''"Fully automated"''' failure detection and restart time for the Cloud-Services
*Failure symptoms in the range of '''''seconds / a few minutes'''''
|
*'''"Manual"''' failure detection and restore of the Cloud-Services
*Failure symptoms in the range of '''''some hours'''''
|-
| - 2 -
'''DataCenter Lokations'''
|
*"'''active - active'''"
**Two active DCs in Germany or EU (currently in Germany)
***Location for Backup-Data is the innovaphone headquater in Sindelfingen (Germany)
|
*"'''active''' - cold standby"
**One active DC in Germany or EU (currently in Germany)
***One other passive DC has server resources ready in the event of a disaster
***Location for Backup-Data is the innovaphone headquater in Sindelfingen (Germany)
|-
| - 3 -
'''Desaster-Recovery-Concept'''
|
'''''„stretched-VMware-HA-Cluster“''''' actual based on a Metrocluster Storage
*This is made possible by redundant "two-way" Darkfiber connected data centers in two cities.
**The operating LAN and an iSCSI SAN run over this, which keeps the VMware datastores mirrored at both data centers.
*If the darkfirber connection between the two data centers is interrupted (no more storage mirror), but the ESX servers in each data center are still in operation, a third additional connection via a separate "heartbeat network" was made available to avoid a "split brain" of the VMware database (lack of quorum accessibility of ALL ESX servers).
**This is then used to decide in which data center location the mirroring of the iSCSI SAN was interrupted (e.g. due to a component defect).
**Datastore operation is thus continued " unique" on the undamaged mirror datastore in a data center (automatic HA boot of the VMs from the damaged data center).
**Once the mirror connection is re-established, vSphere DRS redistributes the VMs across both data center locations.
*The route-redundant Internet breakout is routed via HSRP technology and, if necessary, relocated from one city to the other within a few seconds.
*In addition, we move nightly backups/replicas to the company headquarters in Sindelfingen.
[[Image:Cloud_Compare_PREM-DC_detail.png|600px]]
|
'''''„simple VMware-HA-Cluster“''''' with ''Backup-Instances'' in the innovaphone headquater
*The simple disaster recovery concept requires a backup/restore or replication process in addition to VMware vSphere and vCenter.
**vSphere Replication" and "Site Recovery Manager" are VMware terms.
**For our STANDARD cloud, we use the backup variant, which offers us a more diverse range of possible use cases.
***both via the cloud instances
***as well as for all services from our company headquarters in Sindelfingen.
*In the event of a disaster, operations are only restarted on the resources provided in the standby data center after recovery/restore from the company headquarters in Sindelfingen.
**This requires a new Internet breakout under a new IP address
|-
| - 4 -
'''Blackout / Autonomy time'''
|
*Infrastructural protection of the two remote data centers by the provider
**Redundancies for Internet connection, air conditioning systems, UPS and emergency power generators as well as resulting autonomy time in the event of a regional power failure
***'''5 days'''
*!! In the event of a power failure in only one DataCenter, operation automatically switches to disaster mode at the latest after the autonomy time has expired, and thus to the remaining DataCenter location !!
|
*Infrastructural protection of the data center by the provider
**Redundancies for Internet connection, air conditioning systems, UPS and emergency power generators as well as resulting autonomy time in the event of a regional power failure
***'''1 day'''
*!! In the event of a power failure in the active DataCender that lasts longer than 24 hours, the disaster case Restore to standby location must be triggered, which means several hours of operational interruption !!
|-
| colspan="3" style="background-color:#f2f2f2;" | '''Both cloud variants use secondary services from the company headquarter in Sindelfingen'''
*Central services out of Sindelfingen are:
**Customer care by sales & support teams (central call acceptance & Mantis)
**my.innovapone portal (license management)
**App store (firmware and myApps updates)
**Push & provisioning server (smartphone synchronization & rollout of IP devices)
**Data center for the backup data of the STANDARD and PREMIUM cloud

*The Internet presence of our company headquarters required for this is protected against a regional power blackout via UPS.
**~6h battery power

|}

Reference13r3:Concept App Platform

2023-05-08T13:53:11Z

Gnd: /* Delete data inside an instance */

= General =
* V13 uses [https://buildroot.org/ buildroot]
* this is an own (innovaphone) collection of packages
* For further information see: [https://buildroot.org/docs.html Buildroot Documentations]

== Requirements ==

* V13 or up
* Gateway (arm): IPx10 (with CF card) or IPx11 (with mSATA SSD)
* Gateway (arm64): IPx13 (with m2 SSD)
* Virtual (x86_64)
** HyperV with [https://docs.microsoft.com/de-de/windows-server/virtualization/hyper-v/deploy/upgrade-virtual-machine-version-in-hyper-v-on-windows-or-windows-server#supported-virtual-machine-configuration-versions VM-configuration Version] 6.2 (minimum: Windows 10 or Windows Server 2016)
** VMWare

== Default credentials ==

'''During INSTALL, the default passwords are replaced with the global Admin PW!'''
* SSH-Login with '''admin''' and '''ipapps'''
* root login with '''root''' and '''iplinux''' (the root login is not directly possible, you have to login as admin first and use the command ''su root'')
* manager App (web login) '''pwd'''

= App Platform - arm/arm64 (Gateway)=

* The installation image has a size of ~50MB. During installation, the following partitions are created<ref name="partition-size">Maximum partition sizes are given. The real sizes are returned by the linux 'df -h'-command. These real values will be lower, but can grow in the future with new releases.</ref>:
** /dev/sda1 fat32: 200MB (contains ramdisk, rootfs and kernel)
** /dev/sda2 ext4: depends on disk size (contains databases, log files and apps)
** /dev/sda3 ext4: 500MB (contains the rootfs)
** /dev/sda4 swap: 512MB

When comparing potential performance of the IPxx11 platform compared to the IPxx10 platform, there are some major differences:
* SSDs found in the xx11 are faster and more reliable than the CF found in the xx10
* the available RAM for the App Platform (as specified in column ''RAM for LAP (GB) out of RAM'' in chapter ''Technical data and recommended number of users supported'' of [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported|How to implement large PBXs]]) is factor 6 larger on the xx11 (1,536 GB) than on the xx10 (0,256 GB))
* the xx11 has gigabit Ethernet while the xx10 has 100Mbps Ethernet. The xx10 is therefore not well suited for Apps with larger network traffic, such as Recordings
* the CPU of the xx11 (although it runs on the same frequency) is roughly 20% faster than the xx10

While it is hard to predict the performance of the App Platform in a specific scenario, we see that in a real life environment an App Platform running on an xx11 platform can well support 150 users. The xx10 platform is estimated to support 120 users. Because CPU performance is the limiting factor, larger setups can be built based on the virtual machine platform (see [[#App_services_and_multi-threading|App services and multi-threading]] below).

<references/>

= App Platform - x86-64 (Virtual Machine 64bit) =

* The default disk size is 16GB. It should be increased '''before''' the first start if needed!
* Multiple CPUs are supported, default is one CPU
* default RAM: 512MB
* static IP address, DNS, Gateway can be configured with the command '''setip''' on the console. Run '''setip --help''' to get a list of parameters. (Example: setip --addr=x.x.x.x --mask=x.x.x.x --gateway=x.x.x.x --dns1=x.x.x.x)
* If you have permission problems change to su user (Password is iplinux or your new admin password)
* To figure out your ip address you can use the command: ''ip address'' on the console.
* '''loadkeys de''' can be used to change to german keyboard layout (etc.)
* partitions<ref name="partition-size">Maximum partition sizes are given. The real sizes are returned by the linux 'df -h'-command. These real values will be lower, but can grow in the future with new releases.</ref>:
** /dev/sda1 ext2: 350MB (contains ramdisk, rootfs and kernel)
** /dev/sda2 ext4: depends on disk size (contains databases, log files and apps)
** /dev/sda3 ext4: 500MB (contains the rootfs)
** /dev/sda4 swap: 512MB
* VMWare Tools: Open VM Tools are installed

<references/>

= Installation =
==ARM Gateway==

If you setup a Gateway with the install procedure, the App Platform is installed automatically (Https Download has to be allowed and shouldn't be blocked by any firewall.) 
You can also install it manually:
* Open App Platform -> General and '''Enable Linux Support'''. Restart the gateway.
* You need to enable Proxy-ARP on [[{{NAMESPACE}}:IP4/ETH/IP|ETH0]] or [[{{NAMESPACE}}:IP4/ETH/IP|ETH1]], so your Gateway and the Linux Appliance will share the same physical interface.
* Open App Platform -> IP and configure the IP settings of the App Platform. Restart the Gateway.
* Open App Platform -> Installation and select the given version or enter an own path to the ''app-platform-armel.img'' image file.
* The installation runs without any further required step.

==ARM64 Gateway==

If you setup a Gateway with the install procedure, the App Platform is installed automatically (Https Download has to be allowed and shouldn't be blocked by any firewall.) 
You can also install it manually:
* Open App Platform -> General and '''Enable Linux Support'''. Restart the gateway.
* You need to enable Proxy-ARP on [[{{NAMESPACE}}:IP4/ETH/IP|ETH0]] or [[{{NAMESPACE}}:IP4/ETH/IP|ETH1]], so your Gateway and the Linux Appliance will share the same physical interface.
* Open App Platform -> IP and configure the IP settings of the App Platform. Restart the Gateway.
* Open App Platform -> Installation and select the given version or enter an own path to the ''app-platform-arm64.img'' image file.
* The installation runs without any further required step.

==Virtual machine==

* Import the image into your server environment.
* Edit the disk size, if needed.
* Start the machine and wait until it reboots and starts again.
* Note: If you need to access an IP addresses available through a VPN connection from from inside the virtual machine, it could be that you need to set the network of your VM to NAT (and also add the URL for an IP to /etc/hosts)

[https://wiki.innovaphone.com/index.php?title={{NAMESPACE}}:Concept_Innovaphone_Virtual_Appliance#Configuration More Configuration Hints regarding VM Ware]

== Backup of the Apps ==

Each App Service can have multiple instances and each instance has its own database. The manager app itself also has its own database. 
There are no other files which need to be backuped. 
The standard way to backup the databases is through the Devices App [[{{NAMESPACE}}:Concept_App_Service_Devices#Backups]]. 
 
An alternate way is to use a command file which is similar to the command files from the firmware.

===Commands===
* '''times''' 0,12 # backup only at 0 or 12 o'clock
* '''backup-instances''' http://user:pw@ip/path/#I-#D.dump PUT
** PUT and POST are supported, all instances including the manager itself are saved
* '''backup-instance''' http://user:pw@ip/path/#I-#D.dump apidemo example.com PUT
** backup a single instance with instance name and instance domain
* '''backup-manager''' http://user:pw@ip/path/#I-#D.dump

===Hash parameters===
* #L App Platform label (neu), e.g. 10024
* #A App label (neu), e.g. 130004
* #I instance name (neu), e.g. reporting1
* #D instance domain (neu), e.g. innovaphone.com
* #m MAC address of the LAP, e.g. 00ab11eeff
* #d Current date and time (plain UTC without daylight saving and timezone adjustments) 20051010-170130
* #bn rolling backup index
* ## escapes a hash mark

= App Platform Infrastructure and Concept =
== Webserver ==
The app platform includes a webserver that is highly optimized for handling many Websocket connections at a low memory footprint.
All apps use that webserver by registering for specific HTTP subpath. So they can all use the same HTTP/HTTPS ports - typically the standard ports.

=== Import Custom SSL Certificate ===
You have to upload a PEM Certificate with the following chain structure and without password encoding.

-----BEGIN CERTIFICATE-----
(certificate: your_domain_name.crt)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Intermediate certificate: DigiCertCA.crt)
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
(Root certificate: TrustedRoot.crt)
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
(certificate Key: your_domain_name.key)
-----END RSA PRIVATE KEY-----

=== Known issues ===
*The app platform webserver can use only the default http/https ports 80/443.
*By design, there is no possibility to restore the default webserver certificate on the App Platform, if another certificate was once uploaded. 
**If nevertheless needed, you must login with Putty (see [[#How_to_retrieve_files_from_the_AP | Retrieve files]]) and execute these commands as root:
**''psql -d manager -c "DELETE FROM config WHERE name='webserverCertificate'"''
**''/etc/init.d/S92manager restart''
*The app platform webserver interprets URLs case-sensitive. In other words, <nowiki>http://<addr>/file.txt</nowiki> is not the same as <nowiki>http://<addr>/FILE.TXT</nowiki>

== Database ==
The app platform creates a database for each app instance with a given password. In the installer there will be used randomly generated passwords. You can set a new database password for every instance in the Application Platform.

The apps should store all data in that database. That makes sure that a consistent backup and restore of app instances can be done by the app platform manager.
In hosted scenarios, having separate databases for each instance also makes sure that the data of different customers are clearly separated and can easily be moved from one physical platform to another.

The default configuration decline database request from extern. If you need external access you can change the PGSQL configuration (as root) in the file ''/mnt/sda2/pgsql/pg_hba.conf''.
After editing pg_hba.conf, the database-service has to be restarted with the command <code>/etc/init.d/S50postgresql restart</code>
(Please think about it before you do it, because a better way is to create your own local app with local database access.)

You can find the official documentation for the pg_hba.conf here: https://www.postgresql.org/docs/14/auth-pg-hba-conf.html

Please note that you do this on your own responsibility, that it makes sense to create a backup of the original pg_hba.conf
and that you may break your database server if you do not know exactly what you do!

Sometimes the Apps are not proper working after this. You can wait a while until everything is working again or you go the hard way:
* stop the manager
** <code>/etc/init.d/S92manager stop</code>
* restart the database-service (maybe not really necessary, but makes a good feeling)
**<code>/etc/init.d/S50postgresql restart</code>
* start the manager
** <code>/etc/init.d/S92manager start</code>

== App Platform Manager ==
The App Platform Manager is the central component of the App Platform. It does the following:
* Installing app services by downloading the binaries from an app store.
* Running and monitoring app services. If an app service crashes it is restarted, automatically.
* Management of app instances and providing them with the environment they need:
** A database
** A webserver path
** A password for authentication
* Backup and restore of app instances.
* Collecting debug information like tracing and crash dumps.
* System monitoring (CPU usage, memory usage, etc).

== App Services ==
App services are runned by the App Platform Manager. They implement an interface that is used by the manager to start, stop and configure app instances. Each service runs in a separate child process of the manager.

== App Instances ==
The actual functionality of an app service is provided by app instances. They run in the same process as the app service but have a distinct webserver path and their own database. There can be 0..n instances of an app service. Instances can optionally host (web) apps that can be opened in the myApps client.

Each instance of an App service has two passwords. The instance password itself and a database password. If you want to change it you must update the password on both sides. 
The instance password must match to the password in the corresponding PBX App objects, while one instance can have different App objects. 
The database password must be just known to the manager and not outside of the App Platform.

The ''Database name'' and ''Database user'' are both limited to a length of 63 characters. By default, the App Manager would create ''<domain>''_''<instance-name>'' as value for both. This is why it is recommended to use instance names so that length(name) + length(domain) is less than 63 characters. However, if this is not possible, you can manually shorten the suggested values (both must still be unique on your App Platform).

=== Cleanup database ===
You can cleanup the instance database inside the instance settings. This starts the vacuumdb process for the instance database which frees disk space of deleted rows.
Note that this process locks the database and that sufficient disk space is needed to complete it!

=== External database host ===
You can optionally configure an external database host, if the database shall be hosted on an external host. 
Note that the App Platform Manager still creates a local database, which is then not used as long as the external host is configured.

What are external databases useful for?:
* User data is too large (files are stored as BLOB in the database)
* Other (non-innovaphone) database servers are to be used due to other regulations
* There is already an external database cluster with its own backup/restore processes which should be used
* More performance is required (please note that a local UNIX socket provides much faster results than a remote database server). Depending on the app and the task of the app, it can still be useful to use a separate server if it is faster.

==== Supported database types ====
In principle, ''PostgreSQL'' and ''MySQL'' are supported. However, please note that the respective app must be designed for the target database server type. If an app has been developed for PostgreSQL, it cannot be operated on a MySQL server.

'''Please note:''' All innovaphone apps are developed exclusively as PostgreSQL apps.

MySQL therefore only makes sense if own apps are developed and MySQL or certain MySQL features are to be used. For such apps, it is very important to deactivate the automatic Application Platform APP-Backup.
The database backup process of the App Platform uses PostgreSQL backup commands, which is why the backup would fail, so the app must be excluded from the backup, and you must take care of the backup yourself.

==== Database creation ====
If you use an external database, you have to create the database itself.
The App Platform Manager itself creates a PostgreSQL database like this (you may respect this on your database host to be compatible with the database implementation inside the Apps):
* CREATE DATABASE "dbname" ENCODING 'UTF8';
* CREATE USER "dbuser";
* ALTER USER "dbuser" WITH PASSWORD 'dbpassword';
* GRANT ALL PRIVILEGES ON DATABASE "dbname" TO "dbuser";
* ALTER DATABASE "dbname" OWNER TO "dbuser";
* REVOKE CONNECT ON DATABASE "dbname" FROM public;

==== Database connection ====
There are different possibilities to specify the host. You can use a DNS-Name, IPv4 or IPv6. A port can be optionally added with a colon.

Our PostgreSQL implementation sets sslmode=prefer, so SSL is used by default if enabled on the server.

==== Backup/Restore ====
External databases are still backuped as normal, but you can't restore such a database with the App Platform Manager on the external host! You must restore such a dump manually on your database host.

==== Database redundancy ====
In principle, it is possible to create redundancies for failure scenarios through this function.

However, there are different scenarios that need to be evaluated on a case-by-case basis:

* One database, multiple App Platforms (primary online / secondary '''offline''') where multiple apps access the same database.
** This mode of operation is legal as long as you can really ensure that only one App Platform is active at a time.

* One database, multiple App Platforms (primary online / secondary '''online''') with multiple apps accessing the same database.
** This operating mode cannot be used for innovaphone apps, as the app itself would have to be developed for such a mode, which it is not.

However, we advise great caution here! The use of the same databases from different nodes may only be used if you can ensure that the databases or runtime environments of apps cannot get into a ''split-brain'' mode.

== Relationship between app instances and app objects in the PBX ==
Typically an app instance is connected to one or more app objects in a customer PBX. This is done by configuring the same parameters on both sides:
* URL
* Password
The password is used by the PBX for authenticating itself, users and services against the app instance.

Some apps need a websocket connection with the PBX. When "websocket" is activated at the app object, the PBX establishes a websocket connection to the app instance and provides the APIs that are configured at the app object.

=== Supported scenarios ===
It is important to understand that the concept does not do any assumptions on how PBXes and APs are correlated. So you can have
* One App Platform for one customer
* One App Platform for many customers
* Many App Platforms for one customer
* Many App Platforms for many customers

Attention: The V13 installer can only configure the scenario "''One App Platform for one customer''". If you want to have a different scenario, you have to configure it manually.

For hosting or cloud scenarios you need special scenarios. Please refer our [[Howto:V13_Hosting| V13 Hosting]] instructions.

=== Restrictions ===
Currently we don't have redundancy for app instances or App Platforms.

== Update of the App Platform itself ==
The App Platform is build on top of buildroot and will receive updates and fixes from time to time. 
You can update the used build inside the Manager App by using the '''Update''' button at the top. 

It is strongly advised to make a full backup (VM) or at least backup all apps (Gateway) before you run such an update!

== App services and multi-threading ==
Each App Service runs in a single process with no multi-threading, independent of the instances of the App Service. However, each instance maintains its own database connection and the database responds to this connect with the creation of a new process. Each app service therefore uses 1+''n'' threads (where ''n'' is the number of instances). All communication between app service instances and their clients must pass the single-threaded web server. On platforms with multi-threading support (i.e. VMware or Hyper-V), up to 1 + ''m'' + ''m'' * ''n'' (with ''m'' being the number of Apps and ''n'' the number of instances per App) threads can be utilized.

= App Platform replication =

== Requirements ==

* 13r3 on both standby servers and the primary server
* at least an App Platform image starting with version 110002 (otherwise postgresql is too old)
* standby and primary servers must have the same system architecture
** arm gateways (IPx11) just with arm gateways (IPx11)
** arm64 gateways (IPx13) just with arm64 gateways (IPx13)
** x86_64 virtual machines just with x86_64 virtual machines
* the disk size on standby servers must be at least equal as the disk size on the primary server

== General ==
The configuration is done within the App Platform Manager next to the settings button under "Replication".

=== Off ===
No replication is done at all.

=== Primary ===
The App Platform acts as primary server for one or multiple standby servers. 
Max 8 standby servers can be configured. 
 
Every standby server must get a unique name on the primary server which is then also configured on the standby server itself. This is due to the fact, that the primary server preserves data for every standby server while it's not reachable. 
A standby server name must be a valid domain name, although this name is currently not used as DNS name (but might be used in the future). 
 
The password is randomly pregenerated and must be used as handed by the App Platform Manager.

==== PostgreSQL port ====
The default PostgreSQL port is 5432 and can't be changed on the primary. It must be reachable through your firewall or at least forwarded on a different port towards this App Platform on port 5432.

=== Standby ===
Configure the password from the primary and one of the not yet used standby server names. 
The host and port must be reachable through the network. You can specify a non default port which then must be forwarded somewhere else to port 5432 on your primary.

*Note: Do '''not''' configure the same standby name on different standby servers, as this will break the replication on at least one standby! 
*Note: On a standby, all '''locally installed apps are removed''' during installation

== Failure detection ==

The replication state on both primary and standby servers are continuously monitored. 
In case of a broken connection, an alarm is triggered at once and just cleared if the failure goes away. 
 
If such an alarm lasts for 5 minutes an email is send. The recipient address must be configured in the App Platform Manager settings under "Alarms and Events" and you must also provide a valid SMTP configuration.

== Failover ==

There is no automatic failover procedure. If you detect the failure state, you must get active yourself.

=== Standby down ===

Fix the standby server and see if the replication comes up again. If not, setup a new standby server which will replicate the whole database cluster from scratch.

=== Primary down ===

If the primary is down and cannot be brought into life again, you must take the following steps, depending on your configuration:

==== One standby server ====

* Disable the replication in the replication configuration. You will then have a standalone App Platform afterwards.

==== Multiple standby servers ====

* Change the replication type on one of the standby servers from standby to primary. Please note that the other standby entries must still exist here (they are automatically offered)!
* Change the host entry on the other standby servers to the new standby server. The standby server will sync the whole database cluster again, which will take time.

==== Configuration changes ====

You must also tell the PBXes and other tools to use the new primary server.

* You may simply change the IP address behind the DNS of your primary server to point to the new primary server.
* Without DNS, you must currently modify the configuration by replacing the IP address of the old primary with the new address.
** This must be done in every master PBX configuration.
** This must be done in every App configuration which may use this IP address, e.g. Devices which rolls out an alarm server configuration

== Technical backgrounds ==

=== Streaming replication ===

We use the asynchronous [https://www.postgresql.org/docs/9.3/warm-standby.html#STREAMING-REPLICATION streaming replication of PostgreSQL]. A transaction thus just waits for a commit on the primary server. Standby servers will receive the transaction asynchronously afterwards to avoid a reduced writing performance. 
A primary server keeps the neccessary WAL files for every standby server until the standby fetched the neccessary information. 
This fact can lead to higher disk space usage on the primary if one or multiple standby servers are offline for a while.

Take care to fix broken replications as soon as possible to avoid a full disk on the primary server!

=== What is replicated ===
The whole database cluster of an app platform is replicated. This includes every database of every instance and the database of the App Platform Manager itself. 

=== App Services on standbys ===
The database of the App Platform Manager itself also contains the App service binaries to be able to restore applications in a failover case. 
You do not have to install App services on the standby if you install them on the primary. 
App Platform Manager and Webserver can be updated as usual through the App Store or the Devices App if the standby is connected to Devices.

=== App Platform Manager configuration of the standby server ===
The App Platform Manager configuration of the standby server cannot be stored inside the database, as the database is readonly. So it is stored inside a configuration JSON file under ''/home/root/standby.conf''. 
This configuration is backed up as usual by a Devices backup job and can be also manually restored on a standby (not on a primary though!).

=== No automatic failover ===

There is currently no automatic failover mechanism. PostgreSQL doesn't offer multi master replication, so writing is just possible on the primary itself. Standby servers have a readonly database. 
Let's consider the following use case if we would implement an automatic failover with the current technical possibilities: 
* The primary server is connected to a master PBX.
* A slave PBX is also connected to the primary server in another location.
* A standby server is in this location and replicates from the primary.
* The internet connection between primary and standby fails.
* The standby promotes itself to primary, so that the master PBX now writes to the old primary and the slave PBX now writes to the "new" primary.
* The internet connection comes up again and both primary and standby servers now have databases which are out of sync and which cannot be merged.

=== Security ===

* port 5432 must be reachable on the App Platform
* For every standby a PostgreSQL user is created with the REPLICATION role on the primary. Just this user has access to the database server from non localhost connections.
* You cannot establish a standard connection with such a user and modify/read from tables.
* The replication connection is established over TLS by default.

= Known Issues =

== Reboot after an image update hangs (ARM gateway) ==

If it happens, that the App Platform doesn't recover after the reboot, please open the Admin UI of the corresponding gateway and take a look at App Platform -> General. 
If '''Kernel command line''' is set to '''/dev/ram0''', the App Platform booted the ramdisk. 
 
Try to fetch the upgrade log file:
https://[APP-PLATFROM-IP/DNS]/manager/ramdisk.log
 
If this doesn't work, try to login with putty in this case (default credentials admin/ipapps and root/iplinux) and issue this command: 
''cat /apps/install_step1.log'' 
 
If this file contains '''finished''' at the end, you can reconfigure the settings under App Platform -> General: 
* press '''Stop'''
* Initrd file: empty
* Kernel command line: '''root=/dev/sda3'''
* Ramdisk size: empty
* press '''Start'''

The App Platform should boot and run the already updated image.

<pre style="color: red; font-size:150%;">---WARNING---
If the file doesn't contain "finished" at the end, you may still need to wait, as an upgrade may take some time!
Do not reconfigure without being sure that the upgrade has finished, otherwise your system may won't run!</pre>

== Reboot after an image update doesn't start as update is already running ==

If it happens, that the App Platform doesn't want to start an update because one is already running, please open the Admin UI of the corresponding gateway and take a look at App Platform -> General. 
* '''Shutdown''' the App Platform and '''Stop''' it. 
* Set '''Kernel command line''' to '''/dev/ram0'''. 
* Set '''Initrd file''' to '''ramdisk.ext2.xz'''. 
* Set '''Ramdisk size''' to '''100000'''. 
* '''Start''' the App Platform now. 

The App Platform now either applies the image update or it reboots into the old image. Try the image update afterwards again.

== Webserver doesn't respond after an image update ==

If you can't reach the web UI after an image update, please try to connect with SSH as admin user and delete old coredumps, which may prevent the App Platform Manager from starting correctly:
* su root (become root)
* rm -f /mnt/sda2/log/core_dumps/*/*
* /etc/init.d/S92manager restart

Check if you can now reach the App Platform again.

= Tracing =
Each App Service has its own log file, which can be accessed through the Manager App. You can configure a log file size for each App Service. 
Each App Intance has its own trace flags. The following trace flags can be set: 

* Alarm client: used by the manager to send alarms to an alarm server
* App: logs from the App Service itself
* App WebSocket: logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
* AppSharing: just native clients
* AppProxy: just native clients, logs requests which are proxied between the local webserver and the remote server
* Audio: just native clients
* Browser: just native clients
* Command: the command interface is used to execute shell commands, e.g. used by the manager App
* Config: logs config changes of an App
* Database: database logs
* DB files: database file logs
* DNS: DNS request logging
* DTLS: just native clients, DTLS request logging
* Ethernet: interface to get ethernet adapater infos, just manager App
* File: logs for file system access (synchronous), e.g. manager App
* Files: logs for file system access (asynchronous)
* HTTP client: http client logs
* HTTP file: logs for static HTTP files
* ICE: just native clients
* LDS: local domain sockets
* Media: just native clients
* Media channel: just native clients
* Process: IProcess interface logs which is used for spawning, killing processes etc.
* SMTP: SMTP client logs
* TCP: TCP logs
* Time: ITime interface logs
* TLS: TLS logs
* TURN: just native clients
* UDP: UDP logs
* Video: just native clients
* WebSocket client: logs outgoing websocket connections
* Webserver traffic: logs incoming HTTP traffic, which is forwarded from the webserver to the App
* WebDAV service: logs WebDAV requests to the App
* Webserver: enables webserver specific logs

== RPCAP ==

If you open the Manager App, click on the Manager in the left list and then on the Diagnostics button, you can enable RPCAP. 
You can add the interface in wireshark with the string:
rpcap://<APP-Platform-IP>/eth0

'''Please don't forget to disable RPCAP after your testing!'''

= How-Tos =

== How to retrieve files from the App Platform ==
To retrieve files from the App Platform which can not be retrieved via the App Platform manager UI, you can connect to the App Platform using the SCP protocol on port 22. 
 
First copy files to /home/admin as root with Putty or another SSH client:
* use the ''DNS'' name or IP address of your App Platform (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''su root'' to be root (''iplinux'' as default password)
 
You can now copy files to ''/home/admin'' (e.g. from /var/log/apps/manager/...). 
 
You can create a tar archive with all logs like this:
* cd /home/admin
* tar -cf - /var/log/* | xz -z - > log.tar.xz
** you may want to exclude coredumps (due to their size):
** tar -cf - --exclude=/var/log/core_dumps/* /var/log/* | xz -z - > log.tar.xz
* chown admin:admin /home/admin/log.tar.xz
 
Then copy the files to your local system, e.g. with WinSCP 
* use ''SCP'' as protocol (NB: WebDAV is not supported on most of the directories on the App Platform )
* use the ''DNS'' name or IP address of your App Platform (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''/home/admin'' as start directory
* copy the needed files

== App Platform disk space warning ==

If the configured threshold is reached, all Apps are stopped inside the App Platform . You must then free disk space somehow.

=== Find large instances ===
Click through your apps in the tree on the left side and take a look at the database size of each instance.

=== Delete data inside an instance ===
It depends on the type of app if you can delete data or not. E.g. you can start the Files app and delete files inside this app. 
This won't reclaim disk space though due to the way how PostgreSQL databases work, so you need to follow this guide to reclaim the disk space:

* start the corresponding App
* delete data inside the App
* optimize disk usage of the database by cliking on the button "Clean up database" under Edit instance. If this does not help, continue with the following steps.
* stop the corresponding App again
* download a backup of the instance (backup button at the top), this backup contains the whole instance data, also the password of the instance
* delete this specific instance
* restore the downloaded backup (restore button at the top)

Depending on the hardware and the size of the instance, this process may take hours to complete!

=== Resize the disk ===
The resizing of a disk is just possible for virtual machines, see [[#Resizing the disk of a Virtual machine|Resizing the disk of a Virtual machine]].

=== Delete the whole instance ===
If there is no other possibility, you can delete the whole instance. Afterwards you recreate the instance with the same values and a new random password. Don't forget to set this password in the corresponding PBX App objects though!

=== Restart the Apps or the App Platform ===
If you have enough disk space again, you must either restart the whole App Platform or you manually start all Apps again.

== App Platform/Apps app not online anymore due to full disk ==
If the apps app is not online anymore and you can't access any apps anymore, try to login with an SSH client to see if your disk is full.
Login as admin and afterwards as root (su root). 
 
* issue '''df -h''' and see the disk usage of /dev/sda2, if this is 100%, your disk is too full
* stop the manager
** /etc/init.d/S92manager stop
* empty the 500 MB file, which is exactly for this case here (manager must be 13r1 SR9 or higher to have this file)
** echo "" > /mnt/sda2/empty_if_no_space
* delete log files to recover some space
** rm /var/log/apps/*/*
** rm /var/log/core_dumps/*/*
* restart the postgresql server (see the output if this worked or not)
** /etc/init.d/S50postgresql restart
* restart the manager
** /etc/init.d/S92manager restart
* wait until everything is online again
* open the Apps app and try to find the instance which uses the most disk space and try to delete files/content from it
** you may want to stop all app services first to prevent more writes to the database
** if not possible, you can delete this instance, but you'll loose all data from this instance then!
* after that you can try [[{{NAMESPACE}}:Concept_App_Platform#Shrink_the_physically_size_of_PostgreSQL_database_files]] to free up space
** If this does not work you can create a backup from the database, delete the database and import the database again.
* free up at least 500 MB so that the manager can create the file again
* delete /mnt/sda2/empty_if_no_space if you are done and restart the manager:
** rm /mnt/sda2/empty_if_no_space
** /etc/init.d/S92manager restart
** the manager restart automatically recreates the empty_if_no_space file if this file doesn't exist

Make sure, that you do '''not''' have backups configured to a local files instance while this files instance is not excluded from backups.
An instance can be excluded from backups in the instance settings in the App Platform Manager.

If all of this doesn't help, you can resize the file system on a VM:
* proceed with [[{{NAMESPACE}}:Concept_App_Platform#Resizing_the_disk_of_a_Virtual_machine]]

== Resizing the disk of a Virtual machine ==

Do '''NOT''' resize if you're running an App Platform version higher than '''110000''' and lower than '''110027''' or your data will be lost!
Please update your App Platform to version 110027 or higher before you start resizing your disk.

* stop the VM
* expand the disk using your VM utilities
* start the VM and boot from the first boot entry '''rescue/setup'''
* login with '''root''' and '''iplinux'''
* execute this command: '''/home/root/install_step1.sh log.txt resize'''
* the VM reboots automatically after a successful resize

== Shrink the physically size of PostgreSQL database files ==
Tuples that are deleted in your database are not physically removed from the database-file. So the claimed space on the harddisk is still in use after the delete operation.
If you need to free up some disk space you can force to reorganize the physically database-file on your harddisk.

You can also start this process through the instance settings as long as the App Platform Manager is still running.

'''Important: You are operating on the Database, you have to make a Backup of your Database before you do this!'''

Login via SSH to the APPlatform with the ''admin'' User
su root
/etc/init.d/S92manager stop # not always needed, but in case of database errors recommended, of course no app is online then
sudo -u postgres reindexdb -a
sudo -u postgres vacuumdb -a -f
/etc/init.d/S92manager restart # just execute if the manager has been stopped above

sudo -u postgres reindexdb -d dbname # for a single database with dbname
sudo -u postgres vacuumdb -d dbname -f # for a single database with dbname

Note: This may take some time and CDRs (or other data written to a DB) won't be received during this time.

After the process you can check the free dispace via <code>df -h</code>. You can check the claimed space from the database file with the command <code>du -sh /mnt/sda2/pgsql/</code>.

== Change IP Addresses / DNS Names / System Name ==

If you want to change the System Name or the DNS Name of the PBX and/or App Platform Platform you must change records manually '''in the described order'''!
You have to know the Admin password to directly Login to the App Platform .

=== App Platform ===
; Settings - General
* ''Devices app URL''
* ''App platform DNS name''

; Settings - Alarms and Events
* ''URL''

; All Instances
* ''Domain''
* ''Webserver path''

=== PBX ===
Download the configuration and ''search/replace'' in the config file. Upload the config file and reboot.

Manual:
* ''URL'' in all PBX Object (Apps, Voicemail ...)
* [[{{NAMESPACE}}:Gateway/CDR|CDRx]]
* [[{{NAMESPACE}}:PBX/Config/General|IP address for App Platform]]
* [[{{NAMESPACE}}:PBX/Config/myApps|Reset Password Page]]
* [[{{NAMESPACE}}:PBX/Config/Authentication|Verification link]]

Depending on your change you have to activate/deactivate the Setting [[{{NAMESPACE}}:PBX/Config/General|Operation without DNS]]

=== Additional Devices / Steps ===
* ''Devices Registration URL''
** There is no automatism to change the URL on all devices in your setup.
** If you have the option to use DHCP, you can temporarily overwrite the [[{{NAMESPACE}}:Services/Update|Update URL]] and execute a [[{{NAMESPACE}}:Concept_Update_Server|custom update script]] to change the ''Device Registration URL''
* ''Alarm server''
* Reverse Proxy configuration
* Change ''Domain Name'' in Devices if you have also changed the system name

== How to recover from a broken File System ==
Sometimes you may find messages in the ''messages'' log file (in ''var/log'') like

initial error at 1500329378: ext4_journal_start_sb:328
last error at 1500329378: ext4_journal_start_sb:328

Or you get events like "Broken file system" from your App Platform .

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the App Platform and any applications and restore your backups.

=== Gateway ===

* Open the WebGUI of the gateway running your LAP and proceed to ''App Platform/General''
** terminate Linux (''Status/Stop'')
** modify the Kernel command line from root=/dev/sda3 to root=/dev/ram0
** modify the Initrd file to ramdisk.ext2.xz
** modify the ramdisk size to 100000
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line (user: root, pw: iplinux)
** on the command prompt, use <code>e2fsck -p -f /dev/sda2</code>
** on the command prompt, use <code>e2fsck -p -f /dev/sda3</code>
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''App Platform/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/ram0'' to <code>root=/dev/sda3</code>
** clear the Initrd file field
** clear the ramdisk size field
** start Linux again
:: This will run Linux on the original partition.

=== VM ===

Restart the VM and select the first entry in the boot menu from grub.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line. (user: root, pw: iplinux)
** on the command prompt, use <code>e2fsck -p -f /dev/sda2</code>
** on the command prompt, use <code>e2fsck -p -f /dev/sda3</code>
:: this should fix any issue on the file system
* Reboot your VM
[[Category:Concept]]

== How to create a memory dump of a running process ==

Sometimes it's usefull to have a memory dump of a running process to investigate certain issues.

* login with SSH and become root
* find out the PID of the relevant process, e.g. with ''ps aux | grep /apps/manager/manager | grep -v grep''
* gdb --pid PID -ex gcore --batch
* this creates a core file core.PID
* download this core file with WinSCP or similar tools

Howto:MyApps Cloud - Connecting 3rd-party SIP devices (general considerations)

2023-02-07T15:25:55Z

Gnd:

__toc__

=Applies To=
This information applies to
* myApps Cloud v13
* General considerations on 3rd-party SIP devices

==Disclaimer==
This article is presenting a summary of our experience, connecting 3rd-party devices to the myApps Cloud Platform. As innovaphone is not able to track all changes in functionality or firmware of 3rd-party SIP devices, this document is meant to be an orientation to our certified partners. In any case, we recommended to our partners to verify the functionality of a 3rd-party product. As such innovaphone is not liable for any malfunction of, or caused through a 3rd-party product, even if the respective product is listed in this article.

==Requirements to 3-rd party SIP devices, when connecting to the myApps Cloud ==

# By default, the myApps Cloud service relies on the '''ICE protocol''' (according [https://tools.ietf.org/html/rfc8445 RFC 8445]) to establish peer-to-peer media communication between connected 3rd-party SIP devices. Thus, the connecting SIP device has to support STUN, TURN and the ICE mechanism.
#* In case ICE and TURN are not supported by the SIP device, the absolute minimum requirement is '''STUN support''' (in such case, the respective PBX User Object has to enable Media-Relay). In this scenario the media stream is always routed through the PBX (instead of peer-to-peer routing, when using the default ICE mechanism as described above). 
# The innovaphone PBX uses the standardized '''SIP Digest Access Authentication''' (according [https://tools.ietf.org/html/rfc3261 RFC 3261] "The Digest Authentication Scheme") to verify the credentials of any connected 3rd-party SIP device.
#* If the selected 3rd-party device does not support this protocol, the Digest Authentication Reply Check can be disabled on the customer PBX, for all incoming SIP connections, with the following commands:
#** At the advanced PBX user interface > Maintenance > Diagnostics > Command
#** <code>!config add TSIP /disable-digest-replay-check </code>
#** <code>!config add SIPS /disable-digest-replay-check </code>
#** <code>!config write</code>
#** <code>!config activate</code> 
# Further the following features should be supported by the device
#* DTMF (according [https://tools.ietf.org/html/rfc2833 RFC 2833] "RTP payload for DTMF")
#* Hold/Retrieve (according [https://tools.ietf.org/html/rfc3264 RFC 3264] "Offer/Answer Model for SDP")
#* Transfer (according [https://tools.ietf.org/html/rfc3515 RFC 3515] "REFER Method", [https://tools.ietf.org/html/rfc3891 RFC 3891] "Replaces Header) 
# To ensure secure data connections, the myApps Cloud relies by default '''TLS''' encryption (e.g. SIPS or SIP/TLS). Thus, we recommend to select a 3rd-party SIP device supporting TLS. For this reason, the myApps Cloud platform already includes the root certificates of the following 3-rd party manufacturers:
#* Yealink (this list will be extended, step-by-step)

 
Some more hints for evaluating 3rd party devices can be found in the ''Things to consider'' section of [[Howto:Guidelines_for_Testing_3rd_Party_SIP_Terminal_Devices#Things_to_consider | Howto:Guidelines for Testing 3rd Party SIP Terminal Devices]].

==Howto articles, for selected 3-rd party SIP devices==

For the following 3-rd party devices, a specific description is available, describing details of the respective configuration:
* [https://wiki.innovaphone.com/index.php?title=Howto:Yealink_IP_phones_-_Yealink_-_3rd_Party_Product Howto:Yealink_IP_phones_-_Yealink_-_3rd_Party_Product]

==Workaround: 3-rd party SIP devices without STUN support ==
If a 3rd-party SIP device (e.g. doorphone) does not meet the above defined minimum requirements, an additional local gateway (edge component) on the customers premises is needed, to connect the device to the myApps Cloud platform.

[[Image:3rd-party-SIP-device.png]]

[[Category:myApps_Cloud|{{PAGENAME}}]]

Howto:MyApps Cloud - Configuration of the Operator

2020-03-06T16:43:57Z

Gnd: /* More Information */

=Applies To=
This information applies to
* innovaphone Operator V9
* myApps Cloud

The article's intent is to serve as the Operator 9 information center. The addressed audience is administrators, partners, resellers.

=Requirements=
*at least Windows 7 (and higher) - Windows Vista & Windows XP '''may''' work
*Windows Terminal Server
*1.5 GHz CPU (32-bit, or 64-bit), Dual-Core is recommended
*2 GB of RAM
*DirectX 9 capable graphics adapter

=More Information=
The innovaphone Operator 9 succeeds the innovaphone Operator 8. 
All information are the same as already described under [[http://wiki.innovaphone.com/index.php?title=Reference9:Concept_Operator_Version_9]]. 
For the configuration, the following 2 particularities should be considered: 

* In the configuration of the operator under General/IP Address, you need to enter the DNS of the PBX instead of the IP of the PBX.
* Create a PBX user object with "Groups/Call Forwards only" rights and set a password under PBX/Objects/User. This user (with his password set before) is required for the HTTP authentication (Red area on the screenshot)
[[Image:Operator 1 1 1.jpg]]

File:Operator 1 1 1.jpg

2020-03-06T16:35:14Z

Gnd:

Howto:MyApps Cloud - Configuration of the Operator

2020-03-06T16:34:44Z

Gnd: /* More Information */

=Applies To=
This information applies to
* innovaphone Operator V9
* myApps Cloud

The article's intent is to serve as the Operator 9 information center. The addressed audience is administrators, partners, resellers.

=Requirements=
*at least Windows 7 (and higher) - Windows Vista & Windows XP '''may''' work
*Windows Terminal Server
*1.5 GHz CPU (32-bit, or 64-bit), Dual-Core is recommended
*2 GB of RAM
*DirectX 9 capable graphics adapter

=More Information=
The innovaphone Operator 9 succeeds the innovaphone Operator 8. 
All information are the same as already described under [[http://wiki.innovaphone.com/index.php?title=Reference9:Concept_Operator_Version_9]]. 
For the configuration, the following 2 particularities should be considered: 

* In the configuration of the operator under General/IP Address, you need to enter the DNS of the PBX instead of the IP of the PBX.
* Create a PBX user object with "Groups/Call Forwards only" rights and set a password under PBX/Objects/User. This user is required for the HTTP authentication (Red area on the screenshot)
[[Image:Operator 1 1 1.jpg]]

Howto:MyApps Cloud - Configuration of the Operator

2020-03-02T17:30:18Z

Gnd:

=Applies To=
This information applies to
* innovaphone Operator V9
* myApps Cloud

The article's intent is to serve as the Operator 9 information center. The addressed audience is administrators, partners, resellers.

=Requirements=
*at least Windows 7 (and higher) - Windows Vista & Windows XP '''may''' work
*Windows Terminal Server
*1.5 GHz CPU (32-bit, or 64-bit), Dual-Core is recommended
*2 GB of RAM
*DirectX 9 capable graphics adapter

=More Information=
The innovaphone Operator 9 succeeds the innovaphone Operator 8. 
All information are the same as already described under [[http://wiki.innovaphone.com/index.php?title=Reference9:Concept_Operator_Version_9]]. 
For the configuration, the following 2 particularities should be considered: 

* In the configuration of the operator under General/IP Address, you need to enter the DNS of the PBX instead of the IP of the PBX.
* Create a new user with administrator rights under Configuration/General/Admin. This user is required for the HTTP authentication (Red area on the screenshot)
[[Image:Operator 1 1.jpg]]

File:Operator 1 1.jpg

2020-03-02T17:26:28Z

Gnd:

Howto:MyApps Cloud - Configuration of the Operator

2020-03-02T17:24:46Z

Gnd: New page: =Applies To= This information applies to * innovaphone Operator V9 * myApps Cloud The article's intent is to serve as the Operator 9 information center. The addressed audience is adminis...

=Applies To=
This information applies to
* innovaphone Operator V9
* myApps Cloud

The article's intent is to serve as the Operator 9 information center. The addressed audience is administrators, partners, resellers.

=Requirements=
*at least Windows 7 (and higher) - Windows Vista & Windows XP '''may''' work
*Windows Terminal Server
*1.5 GHz CPU (32-bit, or 64-bit), Dual-Core is recommended
*2 GB of RAM
*DirectX 9 capable graphics adapter

=More Information=
The innovaphone Operator 9 succeeds the innovaphone Operator 8. 
All information are the same as already described under [[http://wiki.innovaphone.com/index.php?title=Reference9:Concept_Operator_Version_9]]. 
For the configuration, the following 2 particularities should be considered: 

* In the configuration of the operator under General/IP Address, you need to enter the DNS of the PBX instead of the IP of the PBX.
* Create a new user with administrator rights under Configuration/General/Admin. This user is required for the HTTP authentication (Red area on the screenshot)

Howto:MyApps Cloud - Configuration of a Standby from the master PBX

2020-02-05T16:18:05Z

Gnd: /* The following configuration is important to have a Standby PBX (from the Master PBX in the Cloud) configured */

==Applies To==
This information applies to

* v13
* The local Standby PBX is connecting to the Master PBX in the Cloud.

== How to configure a Standby from the master PBX on the Cloud ==

=== The following configuration is important to have a Standby PBX (from the Master PBX in the Cloud) configured ===
*PBX Mode
Standby

*System Name
This stands for the Domaine Name of the Customer. Example: customerdomain.com

*PBX Name
This muss be the same name configured in the master. In this case "master" is the correct one.

*Registration to the Master
Should be with encryption (H.323/TLS)

*Master
IP Address of the Master PBX: Use the Public one

* Replicate from Master using TLS

[[Image:Master-Standby.jpg]]

[[Image:Standby_Registration.jpg]]

Howto:MyApps Cloud - Configuration of a Standby from the master PBX

2020-02-05T16:13:43Z

Gnd: /* Applies To */

==Applies To==
This information applies to

* v13
* The local Standby PBX is connecting to the Master PBX in the Cloud.

== How to configure a Standby from the master PBX on the Cloud ==

=== The following configuration is important to have a Standby PBX (from the Master PBX in the Cloud) configured ===
*PBX Mode
Standby

*System Name
This stands for the Domaine Name of the Customer. Example: customerdomain.com

*PBX Name
This muss be the same name configured in the master. In this case "master" is the correct one.

*Registration to the Master
Should be with encryption (H.323/TLS)

*Master
IP Address of the Master PBX: Use the Public one, the 151.80.245.242

* Replicate from Master using TLS

[[Image:Master-Standby.jpg]]

[[Image:Standby_Registration.jpg]]

Howto:MyApps Cloud - Configuration of a Standby from the master PBX

2020-02-05T14:12:26Z

Gnd: /* The following configuration is important to have a Standby PBX (from the Master PBX in the Cloud) configured */

==Applies To==
This information applies to

* v13

== How to configure a Standby from the master PBX on the Cloud ==

=== The following configuration is important to have a Standby PBX (from the Master PBX in the Cloud) configured ===
*PBX Mode
Standby

*System Name
This stands for the Domaine Name of the Customer. Example: customerdomain.com

*PBX Name
This muss be the same name configured in the master. In this case "master" is the correct one.

*Registration to the Master
Should be with encryption (H.323/TLS)

*Master
IP Address of the Master PBX: Use the Public one, the 151.80.245.242

* Replicate from Master using TLS

[[Image:Master-Standby.jpg]]

[[Image:Standby_Registration.jpg]]

File:Standby Registration.jpg

2020-02-05T14:10:19Z

Gnd:

File:Master-Standby.jpg

2020-02-05T14:09:54Z

Gnd:

File:Standby Config.jpg

2020-01-22T13:59:59Z

Gnd:

File:Master Config.jpg

2020-01-22T13:58:52Z

Gnd:

Howto:MyApps Cloud - Configuration of a Standby from the master PBX

2020-01-22T13:57:31Z

Gnd: New page: ==Applies To== This information applies to * v13 == How to configure a Standby from the master PBX on the Cloud == === The following configuration is important to have a Standby PBX (...

File:3 EMAIL ACCOUNT.jpg

2020-01-21T14:54:43Z

Gnd:

File:2 EDIT EMAIL ACCOUNT.jpg

2020-01-21T14:54:04Z

Gnd:

File:1 PBXMG EMAIL.jpg

2020-01-21T14:53:00Z

Gnd:

File:PBX is set up.png

2020-01-13T17:21:07Z

Gnd:

File:PBX Options.png

2020-01-13T17:12:54Z

Gnd:

File:1 Network settings-Install - Kopie.png

2020-01-13T14:26:14Z

Gnd:

File:7 After sucessfull login into myApps.png

2020-01-13T11:17:40Z

Gnd: After_sucessfull_login_into_myApps

After_sucessfull_login_into_myApps

File:6 Trust certificates-Install.png

2020-01-13T11:17:23Z

Gnd: Trust_certificates-Install

Trust_certificates-Install

File:5 Email Account configuration -Install.png

2020-01-13T11:16:58Z

Gnd: Email_Account_configuration_-Install

Email_Account_configuration_-Install

File:4 Emergency Administration passwords -Install.png

2020-01-13T11:16:33Z

Gnd: Emergency_Administration_passwords

Emergency_Administration_passwords

File:3 App Platform-Install.png

2020-01-13T11:16:10Z

Gnd: App_Platform-Install

App_Platform-Install

File:2 Login to Devices-Install.png

2020-01-13T11:15:49Z

Gnd: Login_to_Devices-Install

Login_to_Devices-Install

File:1 Network settings-Install.png

2020-01-13T11:15:05Z

Gnd: Network_settings-Install

Network_settings-Install

Reference13r1:Concept App Platform

2019-07-22T09:07:09Z

Gnd:

Reference10:Concept Reporting

2019-05-14T08:37:37Z

Gnd: /* Ldap */

==Requirements==

It is needed to have the [[Reference10:Concept_Linux_Application_Platform|application platform]] installed and running.

===Calculation of required disk space===

An average CDR requires 2080 bytes of disk space inside the database. 
So '''one GB''' disk space is needed for ~'''516222 CDRs'''. 
One call may have one or multiple CDRs depending on the call flow, the used PBX objects and their configuration.


It is strongly recommended that you try to precalculate your required disk space and configure a suiting value under [[#Configure_scheduled_CDR_cleanup]]. 
If you will run out of space, and then try to delete old CDR's no diskspace will free up immediately because Postgres already occupy the space and will reuse it for new data. Use scheduled Cleanup to prevent this behaviour. 
Don't forget to configure the alarm server under [[Reference10:Concept_Linux_Application_Platform#Alarm_Server]] to receive an alarm if the disk is nearly full (10% disk space remaining).


==Installation==

Download the latest version of innovaphone reporting.

Log into the application platform, go to the Applications tag, click on [[ Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|Upload/Update]] and upload the downloaded file.
The installation will start automatically and the page will refresh every two seconds showing the installation process.
If there is no error during the installation you will see at the end "Installation was succesfull". Otherwise,
you will get "installation failed" and the reason why it went wrong.

===Hotfix===
If you have already installed the latest version of Reporting, simply download the Reporting...HotfixIncremental for your platform (VM or IPxx10) or if you have missed some hotfixes, download the Reporting...HotfixCumulative archive, which contains all hotfixes since hotfix1.
 
 
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].

==Configuration==
===Device===

====License====
It is required to have a Reporting license installed on your device. Check under [[ Reference10:General/License ]] if you already have one.

Set the Reporting flag for each PBX object, which should be reported on the objects properties page.

====CDR Gateway====
Any innovaphone device which sends [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDRs]] to the reporting application must have at least one CDR interface configured under [[ Reference10:Gateway/CDR ]]:

* Type: LOCAL-AP or REMOTE-AP/REMOTE-AP-S

If HTTP/HTTPS is selected then some other parameters must be set:

* Address: ip address of the application platform
* Port: 80 for REMOTE-AP
* Port: 443 for REMOTE-AP-S
* Method: POST/GET
* Path: ap/cdr.fcgi

The application platform is by default password protected, so you'll have to perform one of these steps: 

* configure an authenticated URL for '''ap/cdr.fcgi''' under [[ Reference10:Services/HTTP/Client ]] (recommended)
** If you configure an authenticated URL (with the linux webserver credentials), don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like https://111.111.111.111:443/ap or http://111.111.111.111:80/ap
* configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]]

Configure a second CDR interface, if you use [[#Replication|Replication]].

====Enable PBX CDRs====
Enable the "Generate CDRs" flag under [[ Reference10:PBX/Config/General ]].

===innovaphone Application Platform===

If the reporting URL/user/password is not configured in your device as authenticated URL, configure '''ap/cdr.fcgi''' as public web path on the innovaphone application platform [[ Reference10:Concept_Linux_Application_Platform#Change_web_server_properties_and_public_access_to_the_web.2Fwebdav|Public Web Paths ]].

===Database===

Reporting creates the innovaphone-reporting database to store CDRs sent from any innovaphone devices (appendix 7.6 explains the database structure).
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

Reporting creates the database user '''innovaphone-reporting''' with default password '''reporting'''.
This password may be changed at the innovaphone Reporting page under Config/Database.

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from under Config/Database at the innovaphone reporting page.

For the PgAdmin III it is imporant to use innovaphone-reporting as Service-DB (Wartungs-DB). Default login credentials - User: innovaphone-reporting - Password: reporting

====Delete CDRs====

You can delete CDRs for certain/all users in a certain timespan. If you enter '''%''' as object, all users are selected.

Note that PostgreSQL doesn't free the space on the disk! If you need free disk space, issue this command on the shell:
''sudo -u postgres vacuumdb -f innovaphone-reporting''
This may take some time and CDRs won't be received during this time.

====Configure scheduled CDR cleanup====

If you activate scheduled cleanup, CDRs older than the configured amount of months will be automatically deleted. 
The scheduled task is started once a day at 2 AM.

===PBX===

If you use multiple PBX devices which are not Master/Slave, you have to select, which identifier is unique for a user under Config/PBX:
* System Name (default)
* PBX Name

The selected value determines, which values are shown in the PBX dropdown box for report creation or report mail configuration.

===Replication===

You can configure a second innovaphone application platform with an installed innovaphone Reporting for replication purposes. 

* Mode:
** '''Off''': no replication
** '''Master''': the local server is the master server
** '''Standby''': the local server is the standby server, filters will be replicated from the master and can't be changed here
* Master/Standby Server: the IP address of the master or standby server
* Database password: the PostgreSQL database password of the other server (default is '''reporting''').
* Synchronisation interval: the interval in minutes (range 1-60) in which a sync is done

Now configure a second [[#CDR_Gateway|CDR Gateway]] for the standby server.

The current status can be seen here too. If the status is '''Failed''' take a look at the log file '''innovaphone Reporting Replication''' under [[ Reference10:Concept_Linux_Application_Platform#Logs|Diagnostics/Logs]] or look at the last trace output at the bottom of the page.
 
 
How replication works is described [[#Replication_2|here]].

===Ldap===

Several LDAP servers and dialing locations can be configured here. 

PBX field must correspond to a name of a PBX since PBX's names are available in CDRs. The received CDR is parsed to get the PBX name and this name will be used to find the corresponding LDAP server and dialing location needed to resolve names.

Each configured LDAP server and dialing location can be activated/deactivated with the '''active''' flag.

[[Image:ldap_update.png]]

If the country where you configure LDAP does not have Trunk/National prefix you should leave "National Prefix" and "Area Code" empty.

====remark====
* Unlike "number attributes" field in the configuration of "External LDAP Server" on the PBX under "Directories" here additional characters to the attributes like ":P", ":D" or "@", for instance "homePhone:P, mobile:M, telephoneNumber:D" are '''NOT''' allowed. Correct would be "homePhone, mobile, telephoneNumber" as you can see in the screenshot above.

''LDAP Internal Search flag'' allows reporting to perform name resolution also for internal numbers.

''Search Base H323'' checkbox means that h323 field of the CDR user will be used inside the LDAP Filter to resolve the telephone number.

===Report Mails===

Automatic report generation can be configured here:

* '''time''': daytime at which the report is sent
* '''user reports''':
** Creates for each matching user a separate report
** Users are matched by '''Object (Long Name)'''
** A user report only contains calls for this user
** The email address of the user is built by its '''H323 name''' and the '''System Name''' of its PBX (h323@systemname) or determined by the E-Mail field of the user
* '''interval''':
** daily: Mail will be send daily with the automatic period "last day"
** weekly: Mail will be send weekly with the automatic period "last week"
** monthly: Mail will be send daily with the automatic period "last month"
* '''day''': the day, at which the report is sent
* '''mail adresses''': recipients of the report (comma separated)
* '''Sender E-Mail address''': sender email address, which may be present as [[ Reference10:Concept_Linux_Application_Platform#Relay_Hosts | relay host ]]
* '''compress''': compress the attachment or not
* '''sort by'''
* '''sort order'''
* '''language'''
* '''send time''': the time of a day, when the report is sent

The explanation for the other settings can be found [[ #Report_Creation | here. ]] 

[[Image:mails.png]]

===Users===

You can configure multiple users, who shall have access to reports without having access to the whole reporting configuration. 
The user can login with his user name and password on: 

http(s)://Linux-IP/apps/innovaphone-reporting/user/login.php

The admin can assign one or more base filters to the user. A base filter is explained [[ #Base_filter | here]]. 
If the user creates new reports, new own filters or report mails, he '''has''' to use one of his assigned base filters.

If you are using multiple PBX systems, the user has only access to these systems, which are configured in the base filters of the user.
If the user has no base filter with a limitation to a certain "System Name"/"PBX Name" (depends on your [[ #PBX | PBX configuration ]]),
he will have access to all systems!

[[Image:users.jpg]]

====User Login====

A logged in user can create reports, own filters and report mails based on his assigned base filters.

[[Image:Userlogin.jpg]]

===Images===

You may upload images to be used as logo or footer in pdf reports. 

Logos must be 32x32 and footer can have a maximum width of 450 pixels and a maximum height of 50 pixels. 

These images can have jpeg or png format. 

===Relay CDRs===

Relay CDRs can be stored in log files by the Reporting application. Configure a CDR gateway as already described and relay CDRs will be written to the webdav file '''/cdr/cdr.txt'''.
The file is rotated on 1 MB size. The first rotated file is uncompressed, further files will be gz compressed. Max ten files are kept. Older files will be deleted: 
* cdr.txt
* cdr.txt.1
* cdr.txt.2.gz
* cdr.txt.3.gz
* cdr.txt.4.gz
* cdr.txt.5.gz
* cdr.txt.6.gz
* cdr.txt.7.gz
* cdr.txt.8.gz
* cdr.txt.9.gz

You can modify the rotation strategy by modifying <code>/etc/logrotate.d/innovaphone-logs</code> on the application platform. However, keep up mind that such modifications will be overridden during an update to the application platform. So you would need to re-do it after each update.

===innovaphone-reporting web access===

You can configure a separate authentication for the innovaphone-reporting web site [[Reference10:Concept_Linux_Application_Platform#Change_application_access_credentials|here]]. 
One can just login on the reporting site with this access.

===Integration Voice recorder===

The innovaphone voice recording can be integrated and a remote control of the player is possible, see relative article.

==Filters==
===General===

Filters are set up to create reports based on certain conditions. A filter can have multiple conditions and multiple filters can be combined on report creation (combine is performed with an '''OR'''). 
A filter has a unique '''name''' with an optional '''description'''.

===Conditions===

[[Image:filter.png]]

There are five or seven condition sections depending on what is selected under '''States'''. Conditions inside same section are '''OR''' associated while different sections are '''AND''' associated.
 

(Object == Terra '''OR''' Object == Uranus) '''AND''' (PBX == sifi) '''AND''' (Number == 0049%)

====Base filter====

If you select another filter as base filter, the conditions of the base filter are implicitly '''AND''' conjuncted, when the current filter is used. 
So if the base filter defines two PBX values, e.g. "Berlin" and "Hamburg" and the current filter defines one PBX value, e.g. "Berlin", only objects of the PBX "Berlin" will be filtered: 

(pbx="Berlin") AND (pbx="Berlin" OR pbx="Hamburg")

If a user defines an own filter for his reports, he has to use a base filter, which he is allowed to use. So each filter, which he uses, will have at least one base filter condition, which the admin has defined.

You have to take care with the conditions of the current filter and the base filter,
as it is now easy to create a filter with mutually exclusive conditions, e.g. if
the filter has pbx="Berlin" and the base filter pbx="Hamburg" => no matching records.

====Anonym====

If you check this flag, a report created with this filter or with a filter, where this filter is a basefilter, will by anonymized.

====Local====

Define one ore more conditions for the local party, defined by:

* Object: the cn/PBX object name
* Number: the number
* Groups: a group of the PBX object

====Remote====

Define one or more conditions for the remote party, defined by:

* Number: the number
* Remote display name: the display name

====PBX====

Define one ore more conditions for the PBX, defined by:

* PBX: the PBX name
* Node: the node name

====States====

* No Response
* Connected
* Busy
* No Channel

====Directions====

* Incoming
* Outgoing
* Transfer: calls, which have been transferred to the current local party
* Call Forward: calls, which have been forwarded to the current local party

====Call Duration====

Time the call was connected.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or No Response is unselected, then the filter will search for Connected calls with connected time greater or smaller than '''Call Duration'''.

====Alert Duration====

Time the call was ringing independent of the status of the call afterwards.

This condition will be '''AND''' with the others if all '''States''' are selected. 
If Busy, No Channel or Connected is unselected, then the filter will search only for Not Connected Calls that were ringing more or less time than '''Alert Duration'''.

====Report times====

Define the time where calls should be counted. 
You can optionally define the weekday(s) of calls.

====Images====

* Logo: This must be 32x32 pixel image in jpeg or png format. 
* Footer: Maximum width of 450 pels and maximum height of 50 pels. Also jpeg or png format. 

====Using Patterns====

You can use these [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]] for every condition.

==Report Creation==
===General===

It is possible to generate call lists for single users or more complex reports by means of filters.

===Web Interface===

Reporting application provides a web interface to generate reports.

[[Image:Report_hide.png]]

* '''PBX''': select the PBX for the report. The values of the drop down box depend on your [[#PBX | PBX configuration]]
* '''Object (Long Name)''': corresponds to the PBX Long Name assigned to a specific user (% is a special postgresql character, which matches any string)
* '''Filter''': one or multiple filters can be defined ('''OR''' joined)
* '''Group by''': the result can be grouped by Date or Object
* '''Hide last X digits''': you may replace the last digits of an external number with a '*'.
** LDAP must be configured in order to use this capability but if you want no LDAP funtionality, just unset the Active Box in LDAP.
** Actually, the pbx/phys value of a call is matched against the LDAP pbx value and if the number starts with the external line prefix.
* '''Anonym''': do not show internal names/numbers
** If anonym is set, hide last digits is set to 3, if not set
* '''Filter Info''': the report will contain information about the configured settings and filter information
* '''Displayed Duration''':
** Call Duration (Total): the total call duration, e.g. with the duration of a subsequent transfer
** Call Duration (User): just the time, the user was connected
** Billing Duration: the duration, a user must be billed for
** None of these durations contain the alert duration, which is separatly listed

[[Image:reporting_report.png | A normal report. The summary shows incoming / outgoing summaries]]

[[Image:grouped_report.png | A grouped report. Each group has an own summary]]

====Print====

Click the print icon to open a printable version of the report.

====Save====
You can save the report as '''pdf''' or as '''xml''' by using the corresponding icon. 
You can also download a report in '''csv''' format without call history. The report uses '''comma''' as delimeter character, '''"''' as text qualifier and '''PBX Object/Remote Party''' columns should be defined as Text (avoid telephone numbers to be considered as numbers by Excel). '''UTF-8''' must be used as character set. 

====Sorting====

Each sortable column has a clickable column head. This sorting will be also used when opening the printable version or saving the report as PDF.

====Icons====
The icons are explained in the [[#Call list icons|appendix]].

===Remote Interface===

See [[#Remote_Interface_2|Remote Interface Appendix]]

==Backup and Restore==

You can both manually and automatically backup the database and configuration files for Reporting under [[Reference10:Concept_Linux_Application_Platform#Backup|Administration/Backup]] in the application platform.

Configuration details for the update server can be found [[Reference10:Concept_Linux_Application_Platform#Backup|here]].

===Configuration Files===

'''saveinnovaphone-reportingcfgs''' is the command used to automatically save configuration files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

===Data===

'''saveinnovaphone-reportingdb''' is the command to automatically backup the whole innovaphone Reporting database with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

If you restore the reporting database, you should keep in mind, that this might take several hours for a system
on a CF card, depending on the size of the restored database. The backup process itself is quite fast with a few minutes.

===Logs===

'''saveinnovaphone-reportinglogs''' to save log files with the [[Reference10:Concept_Linux_Application_Platform#Command_File|Command File]].

==Appendix==
===PostgreSQL Patterns===
For filter conditions or for the pbx object value you can use the following patterns inside a string:

* '''%''': matches any string of zero or more characters
* '''_''': matches any single character

Example:
'''Sat%''' will match all pbx objects, which start with the string '''Sat'''.

We do always perform case insensitiv searches!

===innovaphone Reporting XML===
<code type="xml">
<?xml version="1.0" encoding="utf-8"?>
<application>
<name>innovaphone Reporting</name>
<desc>Reporting software</desc>
<directory>innovaphone-reporting</directory>
<href>report.php</href>
<linux-username>innovaphone-reporting</linux-username>
<packages>
<package>php5-gd</package>
<package>php5-ldap</package>
</packages>
<database name="innovaphone-reporting" username="innovaphone-reporting"/>
<cronjobs>
<cronjob script="/etc/cron.d/reporting_replication"/>
<cronjob script="/etc/cron.d/reporting_cleanup"/>
<cronjob script="/etc/cron.d/reporting_mails"/>
</cronjobs>
<log-files>
<log title="Postgresql-8.4" no-clear="true">/var/log/postgresql/postgresql-8.4-main.log</log>
<log title="Reporting cleanup">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_cleanup.log</log>
<log title="innovaphone Reporting">/var/www/innovaphone/apps/innovaphone-reporting/log/innovaphone-reporting.log</log>
<log title="innovaphone Reporting Replication">/var/www/innovaphone/apps/innovaphone-reporting/log/reporting_replication.log</log>
</log-files>
<config-files>
<conf>/etc/postgresql/8.4/main/pg_hba.conf</conf>
<conf>/etc/postgresql/8.4/main/postgresql.conf</conf>
<conf>/home/innovaphone-reporting/reporting.conf</conf>
<conf>/home/root/ssl_cert/server.key</conf>
<conf>/home/root/ssl_cert/server.crt</conf>
<conf>/etc/cron.d/reporting_replication</conf>
<conf>/etc/cron.d/reporting_cleanup</conf>
<conf>/etc/cron.d/reporting_mails</conf>
<conf>/var/www/innovaphone/apps/innovaphone-reporting/report_images</conf>
</config-files>
<backup>
<command title="Save innovaphone Reporting configuration files" cmd="saveinnovaphone-reportingcfgs" script=""/>
<command title="Save innovaphone Reporting database" cmd="saveinnovaphone-reportingdb" script=""/>
<command title="Save innovaphone Reporting log files" cmd="saveinnovaphone-reportinglogs" script=""/>
</backup>
<restore>
<command title="Restore innovaphone Reporting configuration files" cmd="restoreinnovaphone-reportingcfgs" script="">
<action>/etc/init.d/postgresql restart</action>
<action>/etc/init.d/cron restart</action>
</command>
<command title="Restore innovaphone Reporting database" cmd="restoreinnovaphone-reportingdb" script=""/>
</restore>
<uninstall script="/usr/bin/sudo /usr/local/bin/uninstall_script.sh -f 'innovaphone-reporting.xml' -linux_user yes -linux_group yes -database yes -database_user yes -log_script '/var/www/innovaphone/log/appl_uninstall.log'">
<to-delete>
<to-del path="/usr/local/bin/reporting_cleanup.sh"/>
<to-del path="/usr/local/bin/reporting_replication.out"/>
<to-del path="/usr/local/bin/reporting_replication.sh"/>
<to-del path="/home/innovaphone-reporting/tmp"/>
</to-delete>
</uninstall>
<lighttpd-auth>1</lighttpd-auth>
<public-web-paths>
<path>mypbx</path>
<path>user</path>
</public-web-paths>
</code>

===Installed Debian Packages===

The following packages (and their dependencies) are installed with innovaphone Reporting:

* php5-gd
* php5-ldap

===Configuration Files===

pg_hba.conf is the client authentication configuration file and controls which hosts are allowed to connect, how clients
are authenticated, which PostgreSQL user names they can use and which databases they can access.

postgresql.conf is the PostgreSQL configuration file

===Data Files===

If you backup the innovaphone reporting database, you'll get a gz archiv, which contains the whole innovaphone-reporting database.

===Report XML and CSV===
The field description below applies for the '''XML''' and '''CSV''' columns!

<code type="xml">
<report>
<record>
....
<time time="1301303966" utc="1301303966">2011-03-28 11:19:26</time>
<obj>Saturn</obj>
<id>870998fee909d311b2ec009033105dc9</id>
<call>int</call>
<alert-duration seconds="0">0:00</alert-duration>
<flow>
<ev caller="ep1" ep1_number="101" ep1_name="saturn" ep1_dn="Saturn"
ep2_number="102" ep2_name="uranus" ep2_dn="Uranus" status="co" entry="true"/>
</flow>
<call-duration seconds="2">0:02</call-duration>
<billing-duration seconds="2">0:02</billing-duration>
<conn-duration seconds="2">0:02</conn-duration>
<groups>
<group>test</group>
<group>test2</group>
</groups>
<node>root</node>
<pbx>.</pbx>
<cause></cause>
<dir>o</dir>
<status>co</status>
<type/>
<remote number="102" name="uranus" dn="Uranus"/>
<callback number="456" name="abc" dn="123" time="1301305962">2011-03-28 11:52:42</callback>
</record>
....
</report>
</code>

* time: the node contains a formatted time string of the local time
** attribute '''time''' is a unix timestamp (referring to the local time stamp of the CDR)
** attribute '''utc''' is a unix timestamp (referring to the utc time stamp of the CDR)
* obj: the PBX object name (also called cn)
* id: the conference id of the call
* call: '''int''' (internal) or '''ext''' (external) call
* flow '''(XML only)''': the call flow
** ev
***ep1 (ep1_number, ep1_name, ep1_dn): the left side of the call
***ep2 (ep2_number, ep2_name, ep2_dn): the right side of the call
***caller: '''ep1''', '''ep2''' or empty, if unknown
***status: '''co''' (connected), '''al''' (alert), '''er''' (error) or '''bu''' (busy) state of the current event
***entry: '''true''' for the entry event of the local object
***type: '''cf''' (call forward), '''ct''' (call transfer)
* Original Called '''(CSV only)''': In case of Call flow; The original called device
* Diverting '''(CSV only)''': In case of Call flow; The diverting device
* Transferring '''(CSV only)''': In case of Call flow; The transferring device
* groups '''(XML only)''': the groups of the PBX object
* node: the node of the PBX object
* pbx: the pbx of the PBX object
* cause: the decimal disconnect reason of the call (see [[Reference:ISDN_Cause_Codes]])
* remote:
** outgoing calls -> dialed endpoint
** incoming calls -> first ep2 above entry event or entry event if this is the first one
** incoming calls with incoming transfer after entry event -> transfer target
* status:
** outgoing calls -> best found status in call flow
** incoming calls -> status of entry event
* type: the type of the entry event or, if not set, the type of the next event, if given
** empty: direct call
** '''ct''': call transfer
** '''cf''': call forward
** '''cct''': call transfer with consultation
** '''pu''': call pickup
* dir: o (outgoing) if the first event is the entry event and the caller is ep1
* dir: i (incoming) if not o
* alert-duration: alert time
*Billing Duration: the duration, a user must be billed for
** outgoing call -> duration from the first event until the last event in the flow
** incoming call -> duration from the first transfer/forward event until the last event in the flow
* call-duration/Call Duration (Total): duration of the whole call, e.g. with the duration of a subsequent transfer
* conn-duration/Call Duration (User): just the time, the user was connected. Duration from the entry event until the event, where the local endpoint isn't connected any more
* callback: '''name''', '''number''', '''dn''' and '''time''' if this call has been callbacked using mypbx (time referrs to the UTC time of the callback)
* Further Registration: If more than one devices is registered to the same object, each device creates a CDR. This field identifies the additional CDRs for the same call
* Object Info '''(CSV only)''': combination of object names and number
* Date '''(CSV only)''': extracted date only from the time_string
* Time_2 '''(CSV only)''': extracted time only from the time_string

===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference10:Concept_Call_Detail_Record_CDR_PBX|CDR]])

This section is composed by four tables: cdrs, events, groups and cdr_properties.
The first three tables contain the corresponding fields to store the information contained in the cdr, event and group tags. 
Each CDR represents the call in the view of one PBX object. So there might be multiple CDRs for one call if multiple PBX objects are used within the call.

* '''cdr fields:''' id, guid, sys, pbx, node, device, cn, e164, h323, dir, utc, local.
* '''event fields:''' id, msg, type, e164, h323, conf, cause, time, cdr_id, order_index.
* '''group fields:''' id, name, active, type, cdr_id.

'''id''' field is assigned by postgresql for each entry and has nothing to do with the information present in the cdr. It is different for each entry inside the table.

The events table has two additional fields, called cdr_id, to associate these events to the corresponding cdr entry and order_index to keep their position inside the cdr.
Groups table has also the cdr_id field to associate the group entries to the corresponding cdr and events entries.

The '''cdr_properties''' table contains relevant information associated with the call such as call_length, alert_length or call_flow. It also presents a cdr_id field.

====filters====

This section is composed by three tables: filter_columns, filter_conditions and filters.

* '''filter_columns''' is not used for the time being. This is supposed to contain the columns the user wants to see in his report, but right now, just default columns (Time/Object/Duration/Left/Direction/State/Right) are shown.
* '''filter''' contains the filter name and description plus two conditions call_state (No Response, Connected, Busy and No Channel) and direction (Incoming, Outgoing, Transfer and Call Forward).
* '''filter_conditions''' contains the defined conditions for a filter

All three tables are related through an id.

====cdr_users====

This table contains a timestamp '''missed_calls_time''' for the last report access by a user '''cn''' + ('''pbx''' OR '''sys''') with mypbx. It is used to retrieve information about missed calls since the last use of mypbx. 
The timestamp '''clear_report_time''' indicates the last clearance time. 
email, sys (system name) and pbx (PBX name) are also stored for each user.

====replication====

Contains information of the last replication run, which is used to sync master/standby installations.

===Replication===

The replication between the master and standby servers is divided into two steps:

====CDRs====
Both master and standby server keep an information about the last replicated CDR. From this CDR on, they retrieve all CDR guids (32 bytes) from all new CDRs from the other server. If a guid already exists in the local database, the CDR is skipped, otherwise it is replicated. 
So there is a minimal data exchange for already existing CDRs and each new CDR is only processed once.

====Filters/LDAP/Report Mails/Users====
The master server does nothing here, but the '''standby''' deletes all filters, LDAP servers, report mails and users and replicates all from the master. 
So these items from the master server can be used, but not changed, on the standby server.

===Remote Interface===

You can retrieve the PDF/XML/CSV report with a remote interface. 
Make a POST or GET HTTP request to '''http(s)://Linux-IP/apps/innovaphone-reporting/report.php''' with the following parameters:

* remote: mandatory for a remote request!
** '''1'''
* from : the from date/time as UNIX timestamp '''OR''' date/time string as described [ http://www.php.net/manual/de/datetime.formats.php | here ].
* to: the to date/time (format see '''from''')
* [format]: the return format, allowed values:
** '''xml''': default
** '''pdf'''
** '''csv'''
* [sortby] : the report sorting, allowed values:
** '''time''': default
** '''obj''': sort by pbx object name
** '''call-duration'''
** '''alert-duration'''
** '''dir''': sort by call direction
* [sortorder]: the report sort order, allowed values:
** '''ascending''': default
** '''descending'''
* [groupby]: report grouping
** default empty/not set: no grouping
** '''local_stamp''': group by time
** '''cn''': group by pbx object name
* [hidedigits]: hide the last X digits of external numbers
* pbx: search for this PBX (mandatory!)
* pbxobject: search for this PBX object (you can leave this, if you use filterX)
* filterX: use a filter with its name. You can use multiple filters with filter1=test, filter2=test2...
* [filterinfo]: show the filter information in a created report ("true" or "false")
* [lang]: the language, e.g. "en" or "de"
* [displayedduration]:
** '''call_duration''': default Call Duration (Total)
** '''conn_duration''': Call Duration (User)
** '''billing_duration''': Billing Duration
* [anonym]: anonymize internal names/numbers ("true" or "false")
* [bulk]: creates user reports (see [[ #Report_Mails | Report Mails ]])
* [sender]: sender email adress of the report
* [confid]: query calls of a certain conference ID
** you can omit the following fields, if using confid: '''from''', '''to''', '''pbx''', '''pbxobject''', '''filterX'''

Parameters in [] are optional.

'''pbxobject''' supports [[ #PostgreSQL_Patterns | PostgreSQL Patterns ]].

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&pbxobject=Saturn
Gets all records between 2011-03-29 and 2011-03-30 for the pbx object Saturn.

Example:
https://172.16.14.123/apps/innovaphone-reporting/report.php?remote=1&from=2011-03-29&to=2011-03-30&format=xml&filter1=test&filter2=test2
Gets all records between 2011-03-29 and 2011-03-30 for the filters test and test2.

===Tools===

====NetDrive====

[http://www.heise.de/software/download/netdrive/55134 NetDrive] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====PGAdmin====

[http://www.pgadmin.org/ PGAdmin] is an administration tool for PostgreSQL databases.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

===Call list icons===
The direction of the icon arrow depends on the call flow.

* [[Image:reporting_conn.jpg]]: a connected call
* [[Image:reporting_busy.jpg]]: busy destination
* [[Image:reporting_no_res.jpg]]: no response from destination
* [[Image:reporting_error.jpg]]: an error occurred, like "no channel available" during the call setup
* [[Image:reporting_ct.jpg]]: call transfer
* [[Image:reporting_cct.jpg]]: call transfer with consultation
* [[Image:reporting_cf.jpg]]: call forward
* [[Image:Reporting_pickup.jpg]]: call pickup (or SOAP redirect)
* [[Image:reporting_dir.jpg]]: call direction

A small arrow on a call state icon indicates a callback done with mxPBY, e.g.:
* [[Image:reporting_busy_callback.jpg]]

==Known Problems==
===Replication===
====Callback information====
The callback information get lost in the following scenario:
* The callback CDR is already replicated on both master and standby
* Master or standby is down
* A user calls back the CDR from point 1

====Missed calls====
The information for missed calls is not replicated. So the first time, a standby server is used with mypbx, the missed calls information will be wrong. The second time will be correct again.

===CDRs===
If the innovaphone Reporting is not running, for whatever reaseon, the device, which sends CDRs, currently stores up to 300kB CDRs data. So if one CDR has up to 2kB, 150 CDRs can be stored until the innovaphone Reporting should be up again, to avoid data loss.

===Missing values for PBX drop down box===
If your database currently contains no CDRs of one of your PBX systems, you won't be able to select this system as PBX for report creation or report mail configuration!

===Restoring Database with more than 2GB===

When restoring database using the web browser there is a 2GB upload limit, so if our database have a bigger size the upload will fail.

As alternative solution (if there is enough space):

1. Copy the gz database dump (dump.gz) to the webdav folder (/var/www/innovaphone/webdav/)
2. Uncompress this dump:
$ /bin/gzip -cd /var/www/innovaphone/webdav/dump.gz --uncompress > /tmp/db.dump
3. Switch Directory:
$ cd /tmp
4. Start the restore:
$ /usr/local/bin/config.sh postgres db-restore /tmp/output_pg_schema.dump /tmp/db.dump innovaphone-reporting
5. be patient, this might take a while
6. if database works fine, delete backups and files from restore procedure
$ rm /tmp/db.dump /var/www/innovaphone/webdav/dump.gz /tmp/output_pg_schema.dump

If you get errors like this, [[Howto:Extend V10 LinuxAP HDD Size (VM)|expand your HDD Size]] and restart the restore process
$ psql:/tmp/psqladd.yvSpB:12: ERROR: could not extend file "base/17668/17943": No space left on device

===PDF generation for many CDRs may fail===
You may experience a '''Server error 500''' if you generate PDFs with many CDRs. The PDF library which is used to generate the PDFs fails.
Please generate multiple PDFs with a smaller timespan in such a case.

==Troubleshooting==

===Howto save and restore Linux AP data/database if the webgui is not available===
See [[Reference10:Concept_Linux_Application_Platform#Howto_save_and_restore_Linux_AP_data.2Fdatabase_if_the_webgui_is_not_available|Troubleshooting Linux AP]]

== Related Articles ==
*[[Howto:Integration_reporting_and_voice_recording]]
*[[Howto:Extend V10 LinuxAP HDD Size (VM)]]

[[Category:Concept|Reporting]]

Reference10:Concept Voice Recording 2014

2017-11-30T14:50:04Z

Gnd: /* Known Problems */

== Introduction ==

The innovaphone Voice Recorder application allows recording while the innovaphone Player application a comfortable search and playback of phone calls.

All kinds of calls can be recorded:

*Incoming calls

*Outgoing calls

*Calls from innovaphone IP Phones

*Calls form 3rd party IP-Phones

*Calls from IP-DECT phone sets

*Calls from analogue phone sets

*Calls from with mobile phones (mobility, forking)

*Calls done on a legacy PBX (soft migrations scenarios)

The records are stored in a first step on the Conpact flash or webdav server and processed then form the recorder tool.

Voice recording can be done on a logical or fiscal gateway (BRI, GW, SIP etc.), and therefore all kind of audio traffic can be recorded. Technically spoken a gateway is doing media relay and writes the audio data to the webdav or CF.

The second way to record is recording directly from the innovaphone IP-Phone. In this case the phone itself writes the audio data to the CF or webdav server.

See the “Scenarios” for further details.

The solution requires an innovaphone PBX, the reporting tool and two applications;

*a recording tool described in this document called “Recorder”

*a search and playback tool called “Player”.

The usage of the Player is not part of this description, a separate localized help and user manual is available.

While the recorder (this description) has to be installed by professionals and the maintenance is done by system administrations people (and therefore English wording and this description is good enough) the player is operated by End user and may be not digital native, skilled or knowledge base workers.

Note also that the setup of the player is a typical admin job and not described in the player manual.

IMPORTANT: All users that should be recorded need the REPORTING! We recommend reporting for all user, see chapter “Requirements” for further details.

== Requirements ==
As webdav server just the innovaphone webdav server (on a GW, IPVA or innovaphone LinuxAP) is supported.

The recorder use HTTP and HTTPS access and not a webdav protocol to access.

The Recorder must be physically and logically “nearby” the main PBX. “nearby” means in the same location (not remote), in the same network and also on a physical machine.

Our solutions are tested on single physical machines and we are not able to support the huge amount of virtualisation software (and there edition and version).

We recommend to user normal Windows software, so not a “server” edition.

Disable "Power Saving Mode" on the windows machine that runs the recorder application, so the SOAP connection it's not interrupt.

Voice recorder and Player could run on the same PC as well one single PC can also be used for the reporting, recording, playing and webdav server (and PBX if you like). So anything on one server is theoretically possible, but not recommended.
Please note that a working Webdav is mandatory, otherwise records will be lost! If recording is critical please define a second logical GW with recording and record on an independent webdav too as backup (you have to clear that drive manually to avoid disk full). Do never use the Flash memory ad webdav.

===PBX===
You require a PBX version 11 or higher.

===Reporting===

The recording feature requires the innovaphone Reporting. Please update your platform to the latest Hotfix. Minimum Build 10043 is required.

Each user for whom calls are physically recorded (by creating a pcap fiel for the call using the ''Record to (URL)'' feature) must have reporting enabled and hence requires a reporting license. Although the recorder will discard all physically recorded calls if the user involved has no recording license, it still needs the CDR information for the call (without this information, the recorder can not determine the user the recorded file belongs to). If the recorder needs to process files for which no CDR is available, it will malfunction.

So generally, we recommend that all users in the PBX should have the reporting on as this is is the simplest solution. However, if this is not feasible, then all users for whom recording pcap files are created must have reporting. Please note that if you configure the pcap creation on the trunk gateway all users that possibly could do calls through this trunk (which practically means: all users) must have recording. To limit the number of recording licenses you need to configure pcap creation on the endpoints (i.e. phones) rather.

=== Recorder ===

This document describes Build 1134.

The recorder and Player application was tested on Windows 10, win 7 or higher should also be fine, framework 4.5 is required (no windows XP).

Disk space: One minute of conversation requires about 1 MB of memory if stored in Wave or Pcap Format.
The wave voice data is not pure PCM but a G.711 format in a wave container. PCM requires about 2 times much more disk space and is not used for storing. The audio files can also be encrypted. Encryption would double the required disk space.

The recorded conversation is a stereo file where the external caller is on the left channel whiles the internal one in the right channel.

It is possible down mix the conversation to mono; this would save about 50%.

It is also possible compress the audio data to mp3.

The following table shows the required disk space for one minute of conversation:

[[Image:RecSetup07.png]]

Example: 500GB Hard disk, mp3 compression without encryption -> 1.389 days = 3,8 years of conversation

No particular memory or CPU speed is requested, standard editions are quite good enough. Invest better in a good quality because in professional environments those machines have to work for many years.

Voice recording requires a Version 11 innovaphone PBX and a actual Build of the Reporting tool. No compatibility with older versions is possible. PBX and/or Reporting can run on a gateway as well as on VMware.

The recording of the pcap file is done by the PBX firmware and requires a Compact flash or a WebDAV server. The recorder software will detect those records and copy them on the real storage path. Therefore the storage requirement for the CF/mSATA/WebDAV not real high (but remember always 1 Minute =1 MB, so if you must record 30 conversations for 30 minutes = 900MB).

The two extreme setups are:

*innovaphone PBX on the GW, reporting on the GW, pcap recording on the CF, recording application on a PC

*innovaphone PBX on the PC, reporting on the PC, pcap recording on the PC, recording application on a PC

Each combination between is possible.

Remember that the CF is a relative slow drive, you will note this if you copy a file from the CF to the local HD of your PC. Exact this file copy is one of the task of the recorder, even a critical one (so not a good idea do anything else in between). The result is that the copy of a huge file (a long conversation) or many files will virtually froze the recorder software. In reality the recorder is just hanging around and waits that the file copy is finally done.

=== Codecs ===
Recording can only be done using G.711, G.729 or G.722 (Build 1134) codec.

Note: if you update an older recorder version to build 1134 delete first the file pcap2wav.exe in the directory where the recorder run and/or in the log path of the recorder.Note: if you update an older recorder version to build 1134 delete first the file pcap2wav.exe in the directory where the recorder run and/or in the log path of the recorder.

=== Player ===

The player application requires a PC with Windows OS Win 7 or higher, the Mediaplayer is necessary. All that on a standard office PC is installed and you have to do nothing in particularly.
Require Framework 4.5.
In theory also a Windows server 2008 could host the player, but in the server versions the media player typically is not installed and there are also different DLL missing. So if you have time or you are well Microsoft server trained face also that if necessary (normally not).

In theory it should work on any CPU, the Player was tested under Win7 32BIT, Win7 64Bit and Win8 64Bit and Win10.

===License===

The license model is based on user, so for each user to record a license is required.

The current implementation allows a recording of objects of type user or executive. Recordings on other objects will be discarded.

So in short: Per recorded user or executive object you need to have
* one recording license
* one reporting license

In start-up the recorder will read out the number of recording license in the PBX. After that the recorder will read out all users and check if a user is in the recording group (defined in the recorder setup). If a user with that group is found one license is counted down. If there are no more license but user in group detected they will be skipped. The recorder shows how many license where detected in the PBX and how many user are in the recording group. If there are more users than licenses a warning is show.

Remember that just users in the recorder user table are recorded; all other records are automatic deleted! This can be usefully if for example for internal reasons not just the user to record passes through the recording gateway but also others; not being in the group the records will be destroyed. But of course this will cause senseless PBX CPU workload because a recording anyway is done, just the recorder will delete after the files.

=== Legal Aspects ===

Please take extremely care about the legal issue: in most country voice recording of telephone calls is forbidden and persecuted by law as a crime. In some country it is legal in certain circumstances, for example you have to inform the caller that the call will be recorded. That can be done automatically (using for example a waiting queue) or “manually”, telling the far person that this call will be recorded. Of cause also this announcement should be recorded. In some country recording is legal without any announcement for certain services, for example in case of emergency calls or calls to the police. In most country authority like the secret service do not really care about all that stuff and do what they want, but this is probably not your case.

So inform yourself and the customer about the local legal situation. Using the recording tools is on your own risk and innovaphone will not take any responsibility, even not for eventual malfunctions. See also our general trading terms, valid even for this solution. If you have any doubt about legal questions in using voice recording; don´t do it, don’ use it!

== Feature list ==

=== General ===

• Using an innovaphone IP-Phone set immediately after call end the recording can be listened using the phone. One feature key stroke and the conversation is reproduced and repeated endless (auto replay). This call can also be transferred or put in a 3 party conference (immediate sharing)

• Online Help and tooltips for application and setup

• Setup password protected, setup files are encrypted

• Recorder in Demo Mode (20 minutes) , Player for free

• Many recorder in one system and unlimited number of players

=== Recorder ===

• Recording of any type of calls direction

• Recording of calls from any device: IP-Phones (innovaphone and 3rt Party), analogue phones, GSM (mobility), IP-DECT

• Recording of calls from/to legacy PBX (smooth migration)

• Recording can be done in a logical gateway or direct from a innovaphone phone set

• Recording of encrypted calls

• Standard and thread call recording. If thread call recording is on after a settable time period (for example 5 minutes) a call will be automatically deleted. If the user calls inside the time period a code the last call will be saved. This marking to keep the recorded call can be done from any type of phone. If the phone is a innovaphone IP Phone the marking can be done also during conversation

• Storage of all relevant data including the time to answer for each call

• Detail protocol of each call, documentation of the entire call flow, not just the recording period but even previous and following one. Detail report on all call situations, transfer, call forwarding, pick-up, group call, conference etc. Also calls in waiting queues or announcements are reported with second accuracy

• Encrypted protocol data

• Display number of channels in recording with start timestamp

• Error and Event log files

• Email alert in case of master alarm

• Automatic backup (copy to mass storage archive)

• Automatic delete of records older than 2-99 month (not on archives)

• Recordings are saved as wave files, can be reproduced with any player

• Wave data integrity supervision

• File name contains primary data (Timestamp, Caller and called, direction, time to answer, UID)

• Counter of recorded conversations

• Data Link to player, remote control of the recorder from player

• Interface to external applications, via TCP or URL, recorder provides data for later retrieving. Player can be controlled sending commands to the recorder (3rd party)

• Mark record during a conversation on the IP-Phone (build 1077)

• Https from Build 10087 on

• Slave sites from Build 10089 on

• G722 Codec from Build 1134 on

• PCAP recording from Build 1134 on

• Work as a service from Build 1134 on

• Work as http player server and/or PCAP to Wave/MP3 converter from Build 1134 on

• Work as a service from Build 1135 on

=== Player ===

• Integrity of the recorded wave files are recognized and displayed

• Agent note, a Player displays automatically agent notes and can add text notes to each call

• Integration with iQM server, display of missed calls, possibility to recall immediately

• Naming of Players

• Month and Day filter

• Filter for internal and external number with wildcards

• Filter for incoming and outgoing calls

• View of oldest or newest call on top

• SOS mode can be switched on/off with just one click. If on all unnecessary key are hide, the newest calls are displayed on top of the call list and filters are switched off

• Selection of calls, one single call, more single selected calls, from to, all

• Online search and display, can be switched off

• Copy, move and delete of calls

• Move and delete operations are logged in centralized manipulation log

• Permissions

• Multiple selected calls can are transferred automatically in a playlist and can be reproduced

• Display record size

• Display number of records in playlist and actual play

• Jump forward and backward in playlist

• Jump to next/previous title in search result list if playlist contains just one record

• Marc record in playlist, select actual record and clear all others

• Play one title after the other in playlist

• Play a beep if record change in playlist (loop playlist)

• Repeat play (loop record), up to 4 positions, stored automatically

• Repeat play of all stored memory positions

• Display internal and external number with name resolution

• Display timestamp, time to answer an call ID

• Display System and Player status

• Display if local remote control interface is on

• Display of play was forced be recorder remote control

• Keys for Stop, Play, Fast Forwarding, Rewind, Pause and Eject

• Display duration record

• Display elapsed time or count down, switchable

• Original time elapsing display

• Progress bar adjustable, direct jump to selected position, drag and drop

• Start and Stop position can be marked an played in loop (selection loop)

• Volume control with audio meter and peek indication

• Delta level Indication (L-R and R-L meter)

• Overflow level audio meter

• Enhanced sensitivity for audio meter

• Attenuation left and right channel adjustable

• Audio setup can be stored and recalled

• Audio level at maximum

• Levels are stored and set on restart

• Level meter with peek indicator for left and right channel

• Mute

• Large additional display with call details

• Automatic decryption if files are copied

• Player can be limited to display just calls of one extension

• Communication with recorder, display of link status, last master alarm and channels in recording

• Reset recorder from player

• Search an play on backup directories

• Operate as Media player, reproduction of audio format wav, mp3, wmp and video format avi, wmv, mp4 and mpg

• 1rst and 3rd party remote control

• Document security, manipulation is detected and displayed

• Browse last played records (build 1071)

• Browse marked records on this player (build 1071)

• Browse marked records in a system wide available directory (build 1071)

• Mark records on player and for system wide access (build 1071)

• Copy records marked in a player to the system wide available directory (build 1071)

• Write a central log for all player listening’s (build 1071)

• Work over http connections (build 1074)

• Limit view to a list of extensions (build 1077)

• Play PCAP files (build 1134)

• Double password for unlocking (build 1134)

== Scenarios ==

If the recorded files are in a wave format and can be played with a normal Mediaplayer, the delivered Player allows additional features.

The recorded records are stored in an indicated path and a copy of the records can be done automatically.

Errors and events are stored in a log file and alarms tracked; a mail can be send if an alarm occurs.

It is possible to limit the duration of the storing period; older files will be deleted automatically. This is to avoid disk full errors, keep in mind that this kind of systems usually works unattended all the time.

The number of player and recorder is unlimited.

=== Recording on a central point ===

Recording is possible on each logical Gateway and therefore on external lines (ISDN, SIP or H323 Trunks). In theory “external” is just a convention, even internal calls passing through those gateways could be recorded, but this is more a theoretical issue. An innovaphone gateway can also be used as a “recording” bar and introduced between a legacy PBX and the PSTN. Remember anyway that the innovaphone PBX must be activated and the Reporting tool is required.

Being recording defined on a logical Gateway opens different options, for example activate recoding just for a dedicated route. For example just for incoming calls or just for some outgoing calls. Typical examples for such a setup are business and private calls, where just business calls should be recorded. For example if a call is done using “0” as prefix recording is done, using “9” not.

Or normally (“0”) no voice recording is done, but if a user access to a trunk with a particular prefix (“9”), recording is on. This for example is widely used in selling contracts by phone (like mobile phone carrier do); they call the customer and if the customer agrees in the commercial proposal to extend or to “sign” the contract they will call back the customer again using another prefix and record now the conversation.

Recording rules can also be executed automatically because configured in the gateway setup. For example you can exclude certain user from recording or vice versa, doing recording just for some users. For example all calls to the financial operators are recorded, all other calls not. Or all users are recorder but the management not.

All that is a question of setup in then innovaphone gateway (and PBX) and not described in detail in this document, being standard features and described in many other articles (and being part of the advanced technical training).

Please note that recording starts when a connection is established and terminates when the connection is terminated. That means that eventual waiting situations in waiting queues, music on hold sequences calls etc. are recorded too.

Keep in mind that each extension that should be recorded must be active in the reporting, means require a recording license. Even if you operate a soft migration you must go up in the PBX to a dummy user with reporting on and back again down to the relay.

Notes: Recording can be done just in G711A/G729/G722 on a logical gateway as endpoint. If you want record internal calls in this way calls must always transit a logical gateway (with the media relay flag on).

=== Recording with the IP-Phone ===

Recording can be done also directly from the innovaphone IP-Phone.
If switched on all calls from and to this phone are recorded, there are no recording rules. Calls could be stored in different files, because a new call means also a new file. If for example a phone put on hold a conversations and establish a second call this second call will be stored a an separate file.

Doing voice recording using the IP-Phone or using a Gateway has advantages and disadvantages; it depends on your point of view and the scenario.

Here some issues to remember:

Recording on a gateway is like the old “ISDN Recording”: anything passing that interface is recorded. That has the advantage that any type of endpoint (IP, 3rt party, Dect, analog etc.) will be recorded. The disadvantage is that internal calls are not recorded. Also the CPU load of the PBX will rise while recording with an IP-Phone has nearly no influence.

Recording directly from the Phone has the limitation that just innovaphone IP-Phone are able to doing that. Only innovaphone IP-Phones IP2x2, IP11x, IP241 and IP240A with bigger DRAM (http://wiki.innovaphone.com/index.php?title=Howto:Upgrade_IPxxxA_to_support_more_DRAM_Memory) can performing Voice Recording directly.
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).

In the V11r1 IP recording on the phone can just switched on or off in the setup, not from the user. In V11r2 recording can switched on and off by the user (similar to the 3party version).

'''Note''': The recording described here does not require a phone 3 party conference; therefore a 3party conference is possible on the phone while Voice Recording 2014 is running.

== Recording Modes ==
=== Standard Recording ===

Operating in the “Standard Recording” (STD) mode recorded calls are converted and saved after the call has finished.

Note: A recorder canoperate just in one mode (for example "Standard"). Mixed scenario are possible but require two or more recorders, the setup in this case has to be done very carefully.

=== Thread Call Recording ===

Operating in the “Thread Call Recording” (TCR) mode only marked calls are converted and saved, all other calls are deleted automatically.

A call can be marked manually from the user or automatically from his innovaphone IP-Phone. A call can be marked during the call or after call, but within a defined time period (for example until 5 minutes after the call-end). Not marked calls are deleted while marked calls will contain the entire call, so from the beginning on (even if marking is done during or after the call).

Marking calls during the conversation can be done only using innovaphone IP-Phones while all type of phones can mark a call after the conversation. To mark a call after a conversation the user must call a XML object.

In a typical setup the user will hear a confirmation if he is marking a call, something like “the last conversation was recorded and will be saved” or similar.

If marking is done using an innovaphone IP-Phone during the call (pressing the redial key) audio or no audio can be played. For example an automatic advice like “this conversation will be recorded” or similar can be played.
==== Setup TCR ====

This paragraph discusses the different setups and aspects for Thread Call Recording. If you are not interested in those details skip it.

TCR require a XML (TCRec.xml included in the software package of the Last call recording feature, see Related Articles, see Related Articles, go to the article and follow the download [http://download.innovaphone.com/ice/wiki-src#lcr http://download.innovaphone.com/ice/wiki-src#lcr] ), you have to create a sub-directory TCR in your PCAP recording directory and copy the xml in, create a VM-Object in the PBX and insert those parameters in the recorder setup (TCR panel). Example: Your PCAp directory is http://172.16.88.98/DRIVE/CF0/REC, therefore the directory create is is http://172.16.88.98/DRIVE/CF0/REC/TCR. The XML can be called directly or using the recording functions on the innovaphone phones. If called directly the xml will play the audio file Track1.g711a, if called through the recording function of the IP-Phone the file Track2.g711a. If the files are not present the user will hear nothing. A solution for the confirmation could also be to play just a “beep” if calling directly the xml. You could copy the beep.g711a file (for example from the VM) and rename it. A better option is record them using the universal track recording tool, see related articles at the end iof this page.

Some additional information if you use the recoding function of the innovaphone IP-Phone:
Keep in mind that this function will not really recording the voice but just calling the XML (the recoding is done by the Gateway or the phone, but directly and not using this function). As explained the XML will play the file Track2.g711a if present, but to hear the announcement you have to use on your phone at least version 10.0887 or higher and switch on the flag “Two Way Media” in the Recording section of the phone setup. The rest is the usual one, if you setup “Mode=transparent” each call will flagged as “to record”, if Mode=manual you have to press the redial key to flag. No problem if the user presses more than one time the record key, just the actual call will be recorded.

The xml itself will terminate after playing the Tack 1 or 2, delayed for 2 seconds. If the user press the redial key in this way he will see in the display of his IP-Phone appear “Recording” for 2 seconds and has a feedback (even if no tone is played) that the conversation is flagged to record.

=== Random recording ===
The recorder can work in this mode also as an alternative to the Standard- or Threat call recording. Random recording will record just a sample of calls on normal Agents (User), typically for quality check purposes.

The system allows record just each x call where x can be set in the setup. The system can even record just each y call for an agent. Only “to recording” calls are counted, not calls in general.

Example: “Record in System just each 3. Call”’: the system will store one record and then skip the following 2 one.

Example: “Record for a Gent just each 2. Call”: for each agent one call will be recorded and one not.

Both setups can be set isolated, but combined (3rd in system and 2nd for a agent) the system will first skip 2 calls and then for the specific agent skip each 2nd one.

Calls typically are not foreseeable especially if they are more agent involved and therefore it is for a single agent a “random” recording.

This feature requires build 1071 or higher.

=== PCAP Recording (1134) ===
If switched on the recorder keeps the native PCAP file format. While encryption is possible also in this recording mode no down mix to mono or single cannel recording (just the internal caller) id possible, of cause MP3 can also not be switched on in this recording mode.

Please note that this mode is mandatory if the recorder works as a service. A second recorder working in foreground can convert PCAP to wave or MP3 and also process the additional audio down mix. See relative articles.

=== Manual/Transparent/Optional recording ===

V11r2 (in the Phone) is required.

If the recording is done using a innovaphone IP Phone there are 3 recording modes possible:

- Manual: the user switch recording on/off using a Feature key

- Transparent: recording is always on

- Optional: recording is on by default but the user can switch it off using a feature key

The manual and optional mode is widely used because the operator can switch on and off recording during a conversation. For example if the customer want to buy the operator starts recording and give the advice that from now on the recording is on (by the way: that can be played also automatically modifying the [[Howto:Last_Call_Recording|last call recording]]). Switching off recording is usefully also if for example during a conversation a secret info (like a password) is stated and should not be recorded ad all.

The Recording link (url) to the Webdav or CF is defined in the user setup:

[[Image:RecSetup08.png]]

The mode is selected in the "recording" section:

[[Image:RecSetup09.png]]

Note: The recording described here does NOT require a phone 3 party conference; therefore a 3party conference is possible on the phone while recording is running.

== SRTP ==

Recording of encrypt conversation is possible, no particular setup is necessary, the system will decrypt automatically the media stream and store the conversation in unecnryptet wave files for further processing.

== Last Call Recording/Repeat ==

See relative article.

Do not confuse this feature with the Instant Play (rescue mode) feature of the innovaphone Player.

== Working as a Fileserver for the Player ==

In this operational mode the recorder will not record any file or communicate with the PBX or the reporting but just act a http Fileserver for the innovaphone Player. The application can run in this mode on the same PC than the one of the recording, in huge scenarios for better workload share it is better to separate the two applications. For more information see the article “Player over http”.

== Working as a PCAP converter ==

The recorder can also keep the original pcap file format; this is mandatory if the recorder work as a service. The player is able to reproduce even files in PCAP file format.

If a recorder works in PCAP recording mode no audio down mix to mono or single audio cannel is possible. Please note that encryption of PCAP can be done in the recorder.

If the customer wants down mix features and/or wave or mp3 files a recorder can be started in converter foreground mode doing this.

Similar to the Fileserver mode the recorder will not perform any recording task or communicate with PBX or reporting. Please note that the same application can work as a PCAP recorder and fileserver at the same time, the application has not to be started twice; in large scenarios for a better workload sharing anyway it is possible to start the two modes even on different PC´s.

In this working mode the recorder scan periodically all sub directory of the storing directory and if a PCAP file is detected it will be converted to Wave or mp3 and the down mix options will be observed.

If the original PCAP file is encrypted also the resulting wave or mp3 file will be encrypted. If the original PCAP file is not encrypted encryption is only done if the relative flag in the setup of the converter is switched on.

The idea of the converter mode is that the application is always on; the recording service provide the PCAP files and performs all the other tasks like the communication with the PBX, the file copy from the CF/mSATA/Webdav, renaming, encryption, TCR etc. while the converter in a second step convert. Anyway it is also possible start the converter in a second moment; of cause if there are many files to convert it will require some time until all PCAP files are converted. Therefore a typical situation is that the converter runs always, but if this operation fails (or example after a restart of the PC where only the service will start automatically or a logout of the user) the missing work can be done in a second moment or form another PC.

For the operation of the recorder as a service see relative article.

== Command line arguments ==
The recorder application “innovaphone_Recorder.exe” can be started with command parameters.

This option is only required if the application is started as a service (se relative article).

The order of the parameter has neither influence nor eventual characters between.

The Setup parameters itself are not case sensitive, but the value (the path itself) is case sensitive.

recpath=c:\abc is equal to RECPATH=c:\abc but not equal to <> RECPATH=c:\AbC

Example for fine imputs:

innovaphone_recorder.exe recpath=c:\myiqmdir\ setup

innovaphone_recorder.exe /recpath=c:\myiqmdir\/setup

innovaphone_recorder.exe recpath=c:\myiqmdir\ -setup

The parameter “Setup” forces the application to open just the setup. No timer or interfaces are started. An exit of the setup will terminate the program.

The parameter “recpath” defines where the setup is stored.

The parameter can be inserted in the cmd box (DOS like) or using a batch file. Please note that the cmd should be executed as administrator (windows 8: press the windows key, enter cmd and select pressing the right mouse key “execute as administrator”).

A batch file can be created easy, open the editor and enter the command string, for example

innovaphone_recording.exe setup

Now save the file as a batch file, for example RecordingSetup.bat in the directory where the Recorder is. If you click the file the application will start just showing the setup.

Note also here that it could be necessary to start the batch file with the administrator rights. Of cause you can make a shortcut for example to the Desktop.

If you start the recorder as a service it is also usefully being able to stop the service and start the recorder in foreground using the same setup, therefore just running in foreground, mainly for trouble shooting and maintenance reasons.

Also in this case you can start the recorder in a command line indicating the setup path or create a bat file.

If you have to start more recorder on one single PC (for example a recorder and a recorder as a fileserver) it will be also necessary indicate individual setup path using a command parameters.

Also the batch files should be started with administrator rights. To start an batch file with admin rights a little trick must be applied. After writing your .bat file, create a shortcut and put it for example on your desktop. Now press the right mouse, select property and select “Advanced Properties”.

== Overview ==

The recording itself is done by the innovaphone gateway. In each logical gateway a recording path can be configured as a URL; that means that the voice will be recorded in a file, this file can be on a compact flash or on an external WebDAV server. The recorder application copy the recorded file, read out the reporting, combine both, and rename the file. The original file on the compact flash/WebDAV is deleted. The new filename is formed using date and time, caller and called user, direction of the call, the time to answer (ringing time) and the unique ID number. The recorder converts the file from pcap to the wave format and stores the converted file in a directory. If requested a copy of this record can be saved in a second directory (for example a SAN or NAS disk area). A maximum number of storage time expressed in month can be defined, older files will be deleted automatically. In this way no disk space overflow will be in unattended systems. Parallel to the payload (the wave voice file) also a XML file containing the reporting data is created, the name of the file is the same than the one of the voce and just the extension is xml instead of wav. That is basically what the recorder is doing; copy and convert recorded files, retrieve data from the reporting, renaming of the files and copy them to different destinations as well as keeping track of history.

The player allows searching and browsing of records, show the oldest or newest first, can filter the search etc. For example it can be displayed calls in any direction or just incoming or outgoing calls, or calls from a certain number or to a certain number, using even wildcards for quick filter options. See relative description for details. Once the calls a displayed they can be marked using windows usual methods (one, many, all, range, etc.). The marked files can be copy, past, deleted or played in a playlist. A record in the playlist can be marked and the player allows the usual operations of a windows media player. Looping and audio signal before playing the next record in the playlist is included as well as moving inside the playlist from one call to the other. If all that sounds complicated calm down, it is quite simple in using and designed for “users”.

The player can even operate in a mode called “rescue mode” or “direct play mode”. If switched in this mode the latest record is always on top. This is a typical requirement for an emergency center operator, he is interested in replay the last or lasted recordings in a quick and simple mode.

The player shows also the reporting details and generally the most important data of the conversation. If recorded files are copied also the relative reporting information is copied.
Many player can be installed and work in the same moment in a scenario, while the recorder typically is just one. So the recorder is a kind of server and the player a kind of client. More recorders can be installed in a scenario and if necessary a player can be installed on the same PC where a recorder is working. Being the recorder always on usually it will be installed on a dedicated machine doing just that located in the server room.

But remember that the recording job is done as described by the gateway. So even if a recorder application is switched off voice recording is done. The idea anyway is not that the recorder is switched off and just sometimes switched on to retrieve the files. But if you must shut down the application or reboot or enter in setup, no data will lose.

The following diagram shows the logical interfaces between the innovaphone voice recorder, the innovaphone player and the rest of the equipment.

[[Image:Player07.png]]

(*) = Option

The player main data source is the disk where the records are stores. There could be active many player at the same time, and in theory also more than one recorder. One player could monitor just one recorder, but it is possible to start more player on the same PC.

== Installation Step by Step==

In this and many other wiki articles everything you need to install and operate the product is (hopefully) described. Partners some time have the problem that they could not find a logical flow in the description and the do not realize what is important and what interesting, but not essential.

To help here a simple step by step instruction, all details and comments are in the other paragraph and, of course, in other articles.

1. Check the Software version of your PBX, it must be 10 or higher otherwise do an upgrade or forget this recording. Your PBX must be up and running and to test you need at least 2 Phones.

2. Check that you have a valid license for the recording, if not just a demo-mode is possible, after 20 minutes the recorder stop and you have to restart him again.

3. Your CF should be working fine, create a directory to buffer the pcap files (for example http://123.123.123.123/DRIVE/CF0/IF_REC).

4. Setup the recording gateway, see http://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/System_Setup#Gateway_Setup . If you want to do a test with internal phones you have to assure that in call from one user to the other this gateway will be involved. Create for example a access code to this GW and flag Media-Relay. If you call this access code followed by the internal number ths should happen. Of course if you have a real trunk the you will do all that using the relative GW. At the end of the story your call must passing the recording gateway, check it; open you PBX interface, click on gateway and calls: you should see that the call goes through the recording GW. A pcap file will created at the CF directory indicated in the setup of the gateway (the same one you create in pass 3).

5. Start up the reporting (on a xx10 GW or IPVA), it must be up and working, you should be able to see the reports of the call done using the recording gateway.

6. Create SOAP user, a blank empty user object called SOAP (or _TAPI_ or _whatever_)

7. Create a root directory where the recorded files should be stores (for example “c:\mytest\” or “G:\myExternalDrive\”).

8. Start the application and open the setup.

== Installation ==

While the Recorder works “hidden” for the user, the Player has a huge user interface. The Player is typically installed on one or more PC of users. Therefore for the Player more effort to design a foolproof interface was done. The Player description is available, please check the relative section in the innovaphone Wiki.
Recorder and player applications are single executable file. The setup is stored in a xml file located in the same directory where the application is running; no registry entry is done; if you delete the directory where the recorder/player is in, the application is de-installed. If you like install on the same computer the recorder and the player application you have to create two different directories and copy the applications twice. Automatic execution is possible inserting in the auto start directory the recorder application.

Please note that the setup file is in xml format, but his content is encrypted.

The installation tool will copy all reqired files, if you install manually copping file note the following issues:

If you install a recorder application manually you must copy the “pcap2wav.exe” utility in the same directory!

Note: This utility “pcap2wav.exe” can be downloaded in the V7 application folder, access to a directory and download the “tools” Zip file; inside you will find the pcap2wav.exe.
The recorder is not a service because there is a full user interface available. To ensure that the recorder starts up even after a boot put the application in your autostart folder. In the setup an option to start up minimized is available.

Before starting the recorder application check the following items on the recorder PC:

*the directory where the recordings should be stored must be visible and it must be possible to create subdirectories, try using the file explorer

*If backup is requested also a write access to the backup path must be possible (but it is not necessary to be able create subfolders).

*Access to the reporting tool must be possible, use a browser to check

*The access to the CF (or the WebDAV server) must be possible, try to map a drive and access to the directory where the pcap files are

Do the setup the innovaphone PBX, the gateway and the reporting.

See eventually also http://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/Setup#Recorder_Setup for a better understanding of the requirements.

If you do now a call which has to be recorded this call must be logged in the reporting tool and a pcap file must be created in the indicated url path. Go only ahead if that is up and running.

Now start the recording software and open the setup and set the values. An online help will explain the single parameters. Maybe it is also a good idea reading first the rest of this article.

The installation of the Player is similar just simpler. After installing start the application, enter the setup and that its. But it has no sense install or setup a Player without before having a working recorder.

On a single PC multiple Recorder and Player can be installed, simple install and run them on different directories.

For installation as a service see relative article.

=== CPU load ===

The power of the innovaphone CPU on the different gateway models is high enough to ensure the recording of all ISDN cannels (or the same number of SIP/H323 Trunk) on that gateway. If recording is done on a CF the innovaphone PBX CPU will be involved also in the copy operation (if recording is done on an external WebDAV server no CPU load of the PBX for copy is required). After the copy operation no more CPU power of the PBX CPU is required.

The reporting CPU (which is anyway the second core in case of a gateway or a separate CPU in case of VMware) has some small workload because the recorder checks each 5 seconds the reporting.
Using the player will cause no workload for PBX, reporting or recorder CPU, so just the local workstation CPU power is require. Therefore the number of player is practically insignificant for any CPU load.

=== Logging ===

Recorder and the Player applications write an individual error log, this log is a text file and stored in the same directory where the application is. See online help for file names and description of the other files used by this applications.

The recorder can also write a trace file; if tracing option is switched on all operations of the recorder are logged in a file named “iREC_sys_log.txt”. Please not that this files become very large if the option is always on, and this file will not be deleted or resized automatically. The idea is not to keep on tracing all the time but to switch on the trace during the first period or in case of trouble checking.
If enabled in the setup the player stores all special operations in a central log file. All copy, delete and move operations done using the player are in this way stored automatically in a central log file.

A “user operational” log file is in a central point and unique for all players installed. Here all user manipulations done using the player applications are reported, so copy or delete is traced. This file is named “iREC_Player_log.txt” and located in the “\TMP” subdirectory of the root recording directory. In this way all operations of all Player-User are visible at a glance in one single file.

=== Security ===

The setup of the recorder and player is stored in an AES encrypted setup xml file. Therefore the user cannot manipulate or read out setup values. The access to the setup can be protected with a password. If a user deletes the setup file the software assumes that this is a new installation and allows access to the setup without password. If the user enters the correct path for the recording the software read out a centralized password and it is not possible to save the setup without that password. There is no way to read out or decode the password and this means that if you, as administrator, forget the password you have to clear the centralized password and the setup of the recorder and re-configure all. Try to avoid that situation and remember your password.

The centralized password is in the located in the “\TMP” subdirectory of the root recording directory and named “SPlayer.xml”. It is also encrypted of cause.

The Reporting xml data string is even encrypt.

In the first column header of the player a looked/unlooked symbol is displayed showing the encrypt/clear file mode. If (using the player) a encrypt records is copied it will be automatically decrypt, while moving a file (cut and paste) will not change the original file mode. In this way a clear copy of a xml can be done from an authentic encrypted data string.

=== Date ===

As most application also the recorder requires a correct date and time. But also the PBX Date and time must be correct and the same as the one on the recording PC.

Basically obviously, writing a file all file data should be correct, and also the CDR ticket data should.

So verify that both, PBX and PC have always a correct and synchronized date and time.

== Voice Recorder operation ==

As a normal application the recorder can operate in 3 layouts; minimized in the taskbar, viewing a small window or an extended panel.

[[Image:RecE112B2.png]]

Switching between small and large view is done pressing the “>” key, press “_” for minimize.

For operation as a service see relative article.

=== Start up ===

During start up the basic operational parameter are checked while the master alarm is disabled. The master alarm supervision is just switched on after about 20 seconds. This is necessary because sometimes network operation during start up fails, but becomes up in a second attempt. The sequence of testing is done by design and the software will not proceed in operation if a parameter fails but continuously try to fix it.

This initial health check during start-up is done in the following order:

*checking setup: try to understand if the setup parameters are reasonable.

*checking reporting: pings the reporting, if ping is o.k. try to load a dummy page. If ping or dummy fails the “REPORTING” lamp is red, error message “Reporting Link failure” is viewed.

*checking to access to the recording directory (url): try to read out the indicated path, if fails “PCAP” lamp is red, error message “PCAP directory access fails” is viewed.

*checking if access to the storage path is possible: If reading fails the “DISK” lamp is red, error message “Store path fails” is viewed.

If in the setup no backup path is indicated this last task is skipped and the Backup lamp is grey. Otherwise the access to the path is tested, if access fails the “BACKUP” lamp is red, error message “Backup path fails” is viewed.

If a test is passed the relative lamp becomes green. If after start up 6 lamps are green (or 5 green and one grey) everything is working fine and the message “Normal Operation” is displayed in the System status line.

After 20 second the Master alert supervision is switched to active, an eventual error causes a Master Alarm (see relative section).

=== Normal operation ===

The check counter shows you how many times the recorder reads out the recording directory and checks the reporting. As you see al 5 seconds a reading attempt is done, if data are found further processing operation will start. This counter goes automatically to 0 reaching 9999 and shows you that the software is working and checking but has no further signification.

The counter “Channels in recording” shows you how many recordings are ongoing. The panel shows you the ID of each recording file and the initial recording time. In this way you can see how long a call is jet in recording.

If the call ends it will disappear from the list. If there are more records then default lines a scroll down will automatically appear.

If you click the innovaphone logo the software version is displayed. The version is also displayed in the headline of the setup.

===Extended view ===

If you enlarge the window with the “>” key two additional panels appears.

The left one shows the regular normal operations, the right one the errors and basic messages (like Start-up). The messages displayed of the error panel are stored automatically in an error log file while the messages of the status panel only file if that is enabled in setup. Both windows can be cleared pressing the relative button. This clearage is just an “optical” issue; no file is deleted or similar. Both windows shows up to 100 entries, if entry becomes too large a scrollbar appear automatically. If “full” the oldest message will be cleared. On top the error panel can also display the last 30 Error reading out the error file.

Pressing the “<” key the windows will be resized again.

There is no operational difference between the different layouts. The recording application starts always with the small window stile.

The following picture shows two alarms, Reporting (because there where files without CDR records) and Software (because there was a license overflow).

[[Image:RecXX.png]]

=== Setup ===

Open a separate window, see relative online help.

http://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/Setup#Recorder_Setup

Note: during setup the recording timers are disabled, this means that no normal operation is done. For normal operation the setup must be terminated (with or without saving).

=== Alarms ===

[[Image:VR011.png]]

About 20 seconds after startup, and always during normal operation, alarms are detected from a particular master alarm routine. Some alarms are self-healing, others not. If an alarm occurs the relative source is switched from green to red, if an alarm disappears from red to green. You can simply test is, just shut down the reporting during operation and you will see that the reporting indicator becomes red. If you start up the reporting again the indication will switch automatically from red to green.

An alarm master routine will control the system and summarize the alarms. On the left side there is an indicator “Master alarm” and two buttons, “RESET” and “OFF”. While the alarms can toggle and appear and disappear, the master alarm once triggered will indicate that there was at least one serious error. The detail can be shown in the error log, but the point is that the master alarm shows you the correct operation in time and store the error event.

With the “OFF” button the master alert can be switched manually off. If the master alarm is switched off the “OFF” button will blink red to indicate this exceptional situation. A manual switch off of the master alarm could be necessary during setup or test, or simply to avoid receive alarm emails being anyway in front of the application or similar.

If the master alarm detect at least one error it will be switch on the Master Alarm status, the relative indicator will blink red, a warning triangle will appear and, if configured in the setup, and a warning email is send to the administrator.

[[Image:VR012.png]]

The icon of the application in the taskbar is changed and a warning triangle appears on the recorder logo; also operating in minimized status the Master Alert situation is visible.

[[Image:VR013.png]]

As explained the master alarm will not recover if an error disappears: to reset the master alarm the “RESET” button has to be clicked. Clicking the Reset Key the Master Alarm becomes again armed and will trigger again if an error is detected.

The single errors are partly described in the startup section while the “SOFTWARE” indicator will go into alarm if there is an unexpected error in the software. While some errors are expected and supported and will not cause such an error (for example “no files” if you browse an empty directory) others are not (for example if the decoding of pcap file fails). So while some errors could be an exception (like the failing of file conversation) others could be persisting (like “disk full”) or are simply bugs.

A particular expected, but not tolerable error is described in the next section.

=== Reporting time out error ===

Basically calls that should not be recorded should not be recorded even on the CF, this is desirable, but not always feasible.

In normal operations the recorder is connected to the PBX with a SOAP link and can so detect when a call is finished and the party involved. If there is a PCAP file and a SOAP connection fine, because in the very first step anything is clear and the recorder can decide to save or to just delete the PCAP file. But there is also the possibility that the recorder starts up later and “found” PCAP files stored in the meantime. In this case there could be or even not any SOAP information, if the call terminated before the recorder starts there will no SOAP info. Therefore if PCAP files are detected without any SOAP indication the recorder ask the reporting if there is any record to that PCAP. If yes the processing will follow the normal way, stored or just deleted. But if the reporting has no data there are more possible reasons. CDR data or the reporting could be “late”, so maybe in a few seconds data are in and processed. Or the reporting was just temperately busy or offline, a good idea is wait and try later again. Exactly that the recorder is doing, from build 1070 on the number of trial can be set in a range from 5 to 9999, default value is 5. On earlier build this value was set fix to 1444. Arrived to zero the call is deleted. Deleting recorded calls not knowing about the party involved is critical and therefore the recorder is so carefully.

The real problem is if in a system there are extensions creating PCAP files, but they did not produce CDR tickets / have no CDR license. In this case after a start-up each stored call will produce a PCAP file, the reporting query will fail and the recorder will try later again. To avoid large quantity of PCAP files and slow call processing switch on the reporting feature on each extension creating PCAP files. Or avoid that extension without a reporting creates PCAP files.

Receiving an answer form the reporting the recorder understand immediately the involved parties and can delete the file if the caller was not an Agent or store it.

=== Terminating ===

If you try to stop the application a warning message appears, if you confirm the recorder application stops.

== Files ==

Voice files are stored a subdirectory of the indicated path in the recorder setup.

The files are Wave stereo files where the left channel contains one speaker and the right channel the other one.

There are two working sub directories: the directory “/TMP” contains the central activity log file where the player applications will report their activities (“iRec_Player_Log.txt”). The second is the directory “/REC”, it is a working folder. Both folders are created automatically. The recorder creates a subdirectory for each month, so for June 2013 for example a directory “2013_06” is created and all recorded files in that period will be stored there. Note that in the backup folder no subdirectory folder are created and therefore all files in the backup path are in the same folder.

The recording files are always a couple, one file contains the audio (in wave format, can be reproduced using also standard audio player) and an xml file with the same name containing connection data. Both files are anyway independent and our player handles automatically a single wave file as well as the pair with additional detailed connection data.

One goal of the recorder was to produce a wave file that contains all relevant data.

The format of the name of the Wave file is the following:

"Date and Time of conversation start" + "internal user" + "direction" + "external user" + "time to answer in seconds" + "serial number"

Example:

“2013_06_24_1638_39_o_0800102_7_75c1f48e909d31188fc00903306225f.wav”

Date: 24.06.2013

Time: 16:38

Internal: 39

Direction: o = outgoing

External: 0800107

Time to answer: 7 seconds

Serial: 75c1f48e909d31188fc00903306225f

The file “2013_06_24_1638_39_o_0800102_7_75c1f48e909d31188fc00903306225f.xml” contains the reporting data of this call.

Eventual notes are stored in a file named “2013_06_24_1638_39_o_0800102_7_75c1f48e909d31188fc00903306225f.txt”.

This file is AES encrypt, see relative chapter. If this file is copied with the innovaphone Player it will be automatically decrypt and becomes a standard XML file.

The player retrieves the name of the wave file and displays the data from the xml file if present, otherwise at least the data inside the filename.

If you like you can open the xml file even with an editor and see all the relevant data, much more then displayed using the player.

The player shows also the duration of the call (the recoding) and other details. See relative description.

==Encryption==

The setup files for player and recorder are encrypted, as fix key is used an innovaphone specific secret key. The notes are not encrypted while the reporting and security file (the .xml) is encrypted.

So the reporting and security files are encrypted (those ending with “.xml”) using again as default the innovaphone system key. This default encryption key can be replaced with a customer specific key. In the in the setup of the recorder can be defined a customer key. The only reason to define a customer key is to avoid that other customer can decrypt the files, a remote and strange, but thinkable situation.

If this is done in the Recorder also in all Players must be set this customer decrypt key. Be careful in handling that key, because if you forget the key you will lose all encrypted information. The Player can handle contemporaneously the default key and the specific key. There is no update procedure foreseen if you change the key.

Example:

After 3 month of default operation you decide to insert a customer specific encryption key, for example “MySuperSecret007Key”.

You modify also the Player and insert in the setup this new key. Now you will observe that all data, the one of the first 3 month and the following one, will be decrypt automatically correct; the user will see no difference.

After other 5 Month you decide to return to the default key (leaving blank the key field again in recorder and player). Anything is going well, all records are decrypted correctly.

After other 2 Month you decide to enter a key named “MyBrandNewKey”, doing setup of recorder and player. You will observe now that the data of the month period 0 to 3 , 5 to 7 and after Month 7 will be decrypt while Month 3 to 5 (the one with the old key) will be displayed without CDR data and status “unknown”.

Therefore think well about your key, basically once selected it should remain. If you have the list of all Keys you can of cause change it on the fly in a player and decode the records in the period.

=== Audio encryption ===
The security system is based on AES encrypted xml data file. That file contains the CDR data but even the security parameter of the audio file. Therefore if an audio file is manipulated (changed in any way) that will be detected and show in the player (the “manipul” red label is on while off and the green “original” on if the audio file is the original one).

That means that the audio file itself is not encrypted, some customers want reproducing the file even with other media player.

But there are also customer that have another view and are worried about for example that such an audio file once copied is no more controllable. Or they simply do not thrust that the security features described works fine.

Therefore also the audio file itself can be AES encrypted if that option is switched on in the recorder. The player will detect automatically that an audio file is encrypted and reproduced it anyway.
Here how a player shows a detected Audio encryption:

[[Image:SEC21.png]]

Of cause an encrypted audio file can be reproduced just with the innovaphone player, no other media player will work.

Please note that any innovaphone player can do the decryption, so if you want to assure that just “your” player can reproduce you have to define a customer decrypt key in the recorder (and player).

The recorder shows switched on encryption in the main view (see picture above).

Audio encryption has also disadvantages, recorder and player has more workload and require more disk space; in fact size of the audio files will double if encrypted!

==Audio compression==

=== Wave ===
As default the files are saved in the wave format. More precisely in G711 because wave is a container format and pure PCM would require near the double disk size than G711.

=== PCAP (Build 1134) ===

A recorder can save files also in the original PCAP format. As well as using wave or MP3 format encoding is supported also using PCAP files. A PCAP file require more or less the same disk space than wave recordings. Also the Player form Build 1134 on support PCAP file play.

Note: If the recorder work as a service only PCAP Recording is possible. See relative article.

Note: The Recorder can work also as PCAP to Wave or MP3 converter and/or http Player server. See relative articles.

=== MP3 ===

As an option a mp3 compression can be activated. The required disk size is about 75% less, so one minute in wave requires about 1Mb while the same data in mp3 will require 250kb.

If you wonder why the savings are not much higher consider that even the wave format itself is jet compressed as explained.

All other functions like encryption (an encrypted file size is again doubled, so one minute of mp3 audio encrypted requires about 500kb) or reproducing are the same, the user has nothing to do and the player works always in the same mode.

There is just one situation where an action is required: if the recorder works for a certain period with wave and then with mp3 (or vice versa) in the directory of that month there will be mixed files (wave and mp3). The player detect this and shows automatically an additional key where the user must switch between those two formats: if a directory has just one type of files no action is required and the button is hided.

===MP3 Stereo to Mono conversion===

If the MP3 option is on, files could also be converted form stereo to mono. The file size savings will be nearly 50%, so one minute conversation in mono MP3 requires about 130kB.

Note that conversion from wav to mp3 causes quality lost and stereo to mono even. Once converted, there is no possibility to return to the original format in terms of quality or format. So a bad mono mp3 quality cannot be recovered and even the stereo separation of the cannels cannot be done once converted to mono.

===MP3 just internal channel===

An interesting option in using MP3 is to record just one channel, the left (default) or the right one. The result is a mono file (130kB/min) where just one party is recorded.

If a GW point to an external trunk the internal user is always talking on the left channel. Therefore with this option on just the voice of the internal user is recorded, and doing that in many countries is simply allowed without any restrictions (basically I can record myself).

If recording is done on the phone the channel assignment is vice-versa, the internal caller (the phone) is recorded always in the right channel. Therefore in the setup of the recorder can be selected which cannel should be recorded. That means also that no mixed scenarios (GW and Phone recording) are supported for that feature.

[[Image:SetupR01.png]]

== Redundancy ==

The recorder is able to handle redundancy scenarios with active and standby devices.
The recorder has to handle 3 sources in different scenarios, the PBX itself, the reporting and the CF or webdav server. Those devices can be all together in one single device (for example in an active IP6010 with reporting and CF and a standby IP6010 with reporting and CF) or on different devices (for example an active and a standby IP800 and two reporting on two different PCs).
Another example is active and standby PBX on Gateways but reporting on a high availability VMware environment, so at the end just one reporting from the recorder point of view.

Therefore the standby can be defined for each of those devices.
If you have no redundancy scenario just leave blank the relative setup values.

=== Active/Standby PBX ===

The failure of the PBX is detected because the SOAP connection will go down. If that happen the recorder will try to establish an alternative link to the standby PBX, if that fails he try again with the primary PBX and so one. That means also that a breakdown of the SOPA connection, for example if you reset the PBX, will require some more seconds until the system is up again (because first the recorder try the standby PBX, this will also fail and after that the main SOAP will be up again).

Note that after a restart the recorder try always the first the main address and then the standby one.

In the panel of the recorder near the PBX status indicator is shown the actual link: if the “ACT” lamp is green than the active PBX is tempted, if gray and the “STB” lamp on the standby link is on.

Please note that the recorder can handle differences in active and standby mode just regarding the IP address. All other parameter must be the same, so for example the path to the reporting must be the same.

=== Active/Standby Reporting ===

If the link to the reporting fails and there is a standby address indicated the recorder try to reach the reporting using the standby IP address for the reporting. If there is just one reporting leave the standby address blank.

As you (hopefully) know the reporting can also be installed on two devices, in that case both PBX (the active and the standby one) will transmit CDR ticket to both reporting applications. The reporting database is replicated and therefore if both devices are on the recorder will find the same informations on each reporting. So in theory if both are on it is not important where the reports are requested. In fact if the active reporting fails the recorder will try a connection to the standby reporting. Now if the active device and relative reporting is on again the recorder could also continue get records from the standby reporting. And he will do that until he is restarted or the standby reporting is down because the reporting will answer. If that is not desired flag the option in the recorder setup (“follow Standby/Active PBX”); doing so the recorder will communicate again with the reporting on the active PBX if the active PBX is up again. So basically the switch is done on link down but also following the SOAP.

=== Active/Standby CF/mSATA ===

If the PCAP files are buffered on a CF/mSATA and the PBX goes down also the recorder has to re-map his drive to the standby PBX. In the setup there is a flag in the PCAP section (“follow Standby/Active PBX”), if on the recorder will try to reach the CF of the standby PBX (he takes the IP address of the standby PBX) in the setup.

In scenarios where an external Webdav server is used that flag should not be switched on. The redundancy in that case is demanded to the external devices (for example VMware).

So if you have a “classic” innovaphone redundancy (for example two IP6010 with reporting and CF) indicate the standby address in the PBX and Reporting panel and switch on the “follow Standby/Active PBX” in the reporting and PCAP panel and anything is fine.

== External Applications ==

The recorder as well the player can be interfaced with external applications like booking or ticketing systems or similar.

The basic idea is that the external application will share common information in his database with the recorder and pilot a player. The user should be able to play a recorder conversation directly from his application interface.

In this chapter the interface is described. If you are not interested is such a feature you can skip this paragraph.

This description is done for the software developer of the external applications. No particular setup for the recorder or player is described, part of other descriptions.

For better understanding the description “hides” all other interfaces.

The “recorder” is a software solution running on a Windows “server” (can also be a simple PC). In the network there will be one or several “players” able to reproducing the recorded conversations.

Under “agent” in this description we understand operators working with the voice recording and using an external application.

It is possible to have a TCP connection between player and recorder but this is not mandatory because the player just access to stored data and read out setup file in the network. The number of player has no limit while the number of player connected to the recorder via TCP is limited to 100. That means that the external application can control up to 100 “agents” trough the recorder. But it is also possible to control a player directly; in this case the remote control has no limit.

Contact us if you have more than 100 agents with voice recording using an external application, we can easily extend this limit.

=== Principle and definition ===

This is the described scenario:

Recorder communicates with Player 1, Player 2 … Player x

The Application server communicates with the Application Client 1, 2, … xx

This description regards the TCP/IP interface in the following picture, the only one to build new from the application point of view.

[[Image:Layout02.png]]

Going on in the description as “Appclient” is intended the User frontend (“Application on terminal x” in the picture).

“AppServer” is called the server of the application (Application Server in the picture), so the server for the ticketing or booking system or whatever.

Keep in mind that just one AppServer can communicate with the Recorder while even each Player can be called even directly from the Appserver or an AppClient. Do not confuse: There are two ways to interface the voice recording system, via TCP and via URL. The smarter and better way is the TCP one. We describe both, read both because in the second section some concepts described in the first one are not repeated.

=== TCP/IP Interfacing ===

This is the preferred and smart way to realize the interface.
All messages and command goes to one single interface as shown in the picture. The Appserver act as a TCP/IP “Master” and will receive from the recorder messages and can send commands to the single Players trough the recorder. So it is a 3rt Party interface, piloting single player using one single IP address. The “play” command for a certain player is send to the recorder (and not to the relative player).

If for example a AppClient wants that the Player starts reproducing a record the command flow will be:

AppClientX press the play key -> AppServer send command to the -> Recorder -> Recorder send a command to -> PlayerX

So the idea is that in the applications is a “Play” and a “Stop” button; if the agent press this button the recording relative to the displayed database record will start to play, pressing stop the play will stop.
Therefore the applications database must contain the record name.

The problem is that the entire information about the record is available just a certain time period after the call end. In most of the cases the application session is terminated or a new one started. Therefore the link is provided in two times.

When voice recording starts, the recorder will send a first record to the AppServer in the following format:

''!FRST!<Extension Number of the Agent>!<UID>!<Agentname>''

<FRST> = indicate that this is the first (of two records)

Extension Number = the Phone number of the Agent

<UID> = a unique ID of the record

<Agentname> = the CN (common name) of the Agent in the PBX

Example:

''!FRST!24!c03a55c2e909d311b6450090331b3e3b!Rossi''

where ''“24”'' is the extension number of the agent, ''“c03a55c2e909d311b6450090331b3e3b”'' is the unique “serial number” of the record and ''“Rossi”'' the name of the agent.

Just the filed ''“!FRST!”'' has a fix length, all the others not; the single field therefore has to be separated searching the “!”.

At this point the applications probably store this information (number, ID and Name) in his database or buffer this info until the Agent has his client ready or similar. Important is that the database record of the application is linked to the record UID.

Basically it is necessary for later data processing that the application server knows the name of the player (in our example “Rossi”). The simplest way to do that is giving the extension in the PBX the right common name (the same name than the application user name). If that is not possible (for example because the application has other items to identify a user) the application has to hold a cross reference table: application user name 1 = recording user name 1 etc. Consider also that not necessarily a record is played only on the player of a certain agent; recording for agent 1 can be required to be played on work station agent 2.

When a call has terminated, the record converted, saved etc. (means, ready to be played) a second record is transmitted from the recording server to the AppServer:

''!LAST!<Extension Number of the Agent>!<UID>!<Track>!<Agentname>''

<Track> = Name of the recorded file, to transmit later to the recorder to play.

Example:

''!LAST!24!93adee5ee909d311b6450090331b3e3b!2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav!Rossi''

You see that the UID is in again and on the same position; even the extension number and name is repeated. In this way the application can easily search the UID in his database (and the name and/or the number) and when found complete the record entry with the record name (in the example ''2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav'').
You see the UID is also part of the record name and in theory the original “stand alone” UID in the application database is no longer required. Therefore a overwriting of the UID field in the application database with the record name is possible.

Note: In the actual version a reverse search is not implemented (that the player told the application to display a record). If implemented in the future the search string will be the entire record name and not just the UID, therefore the stand alone UID has no further sense from the voice recording point of view.

From the timing point of view the first message is critical because the UID has to be written until the Agent has opened his application record and that can be even a short time.

The last string is not very time critical because the retrieving of a record and a update can be done in every moment.

The recorder software has a small send buffer (about 25 recordings) where the messages will be buffered if the AppServer is not reachable or the link is down or. If for example the AppServer is switched off and later on again, the recorder will send to the AppServer the FRST and LAST messages buffered during downtime. The Buffer is a Fifo (first in first out) but not an Overflow-Fifo; if full not the oldest but simply all newer messages are lost. The buffering is done just to buffer short time periods, for example to allow a restart of the AppServer PC without losing information (but not for a “offline” operation).

In the application software design should also be considered the possibility that the AppServer receives a First record, is then stopped, and receives the second one after the restart.

That’s all regarding the recording part, now we discuss the remote control of the player.

Remember that a name can be assigned to a player, for external applications that is mandatory. The name can be defined in the player setup; a good idea to simplify the scenario is to give the player the common name of the phone. So in our example we will name the player of the agent “Rossi” just “Rossi”. Not a must of cause, you can call the player of Rossi even “myFirstAgent” or “1234”; but in doing so the external application must store a table where “Rossi” is mapped to “myFirstAgent”. To avoid such complication we suggest unifying the names and assigning to the phone user, Player name and application user in the same one.

To force a certain player to reproduce a certain recording the AppSever has to transmit to the recorder the following command string:

''TRAC!<PN>!<Track>''

<PN>=player name

Example:

''TRAC!Rossi!2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''

The Player with the name “Rossi” will start playing the record ''2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''.

There are not foreseen any error messages, if for example the player will not find the record or is switched off nothing will be transmitted to the AppServer. In case of record not found on the Player a blank result will indicate the fail. If the recorder start reproducing a record a green “RC” label (for Remote Control) near the play symbol shows that a remote control message and not a manual play key press has started the reproduction.

There are available also other commands:

''STOP'' (Stops the actual play)

''EJEC'' (the actual record is unloaded, the player stops)

''PAUS'' (the actual record is paused)

''PLAY'' (the actual record is played again)

Example:

''EJEC!Rossi''

Will force the player Rossi to stop the reproduction of the track and go in an idle mode.

Generally it is not necessary that the AppServer takes care about the actual Player status or observe command flows. If the Player is for example playing a track and the application server send the command to play another track he will Eject the actual track and play the desired one.

Note also that the player can work minimized in the taskbar and play “invisible”, so the user will see just the application. In the setup of the player can also be defined an automatic popup if a remote play is received and automatic hiding if an eject-command is received. If this is enabled in this way the player is minimized in the taskbar and the user works just with the application screen.

The TCP/IP link between recorder and AppServer is based on the fact that the recorder acts as a slave while the AppServer act as a Server. In the Setup of the recorder the IPadress and the port of the AppServer has to be indicated. The recorder expects on the same port where he is transmitting the response from the AppServer.

The recording server performs a keep alive with an interval settable in seconds. The keep alive message send from the recorder to the AppServer each xx seconds is:

''RecKA''

The message has no further meaning and can be thrown away from the AppServer. If any command is received from the Appserver the keep alive will be skipped and repeated after the, in the recorder setup indicated timespan. Unknown messages form the application server will be throw away from the recorder server.

=== URL Interfacing ===

URL interfacing is available only on a local port (127.0.0.1) and used for interfacing with the reporting (see relative article). The following description is just for internal use.

''<IPLTRAC><PN>''

There are also available the commands

''IPLPLAY''

''IPLSTOP''

''IPLEJECT''

''IPLPAUS''

Example:

''IPLTRAC2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''

will force the player to reproduce the indicated record ''2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''.

Basically the interface of the player is anyway a TCP/IP interface and no mini Webserver is integrated. But a “Get” from an browser will be detected and decoded, but no answer occurs. That means if you try to launch a command with a browser it will work, but the browser will show you “no page”.

Example:

If you post in your browser “''http://127.0.0.1:9090/IPLPLAY''“, the player will start to play the marked record.

If a port for direct remote control is switched on a “RC on” label is displayed in the player status line.

=== General Note ===

The first UID will be detected form the recording using the SOAP interface in the PBX. Therefore all Agents has to be in the same group that the SOAP user object.

Example: You have a simple user object called “MYSOAP”, put that object in an active group called “Recording” and now put all you Agents in the same group.

Remember that basically recording is done even without the group stuff. So the group is just required to detect the UID in “advanced”. But there is also an additional benefit; the reporting has less stress because the recorder will query the reporting just at the end of the call (knowing via SOAP when the “end” is) while calls without the group are detected as “finished” because the reporting has a valid CDR record, and so the recorder polls each 4 second the reporting on active calls. That means that it is in any case a good idea put the agents in a group, even if no external application is running.

== Recording rules ==

The recording rules describe how the innovaphone PBX and the innovaphone voice recorder works in complex situations.

While basic calls are simple and strait forward in logic, voice recording behavior becomes non clear in complex situations.

What about voice recording if for example a recorded user transfers the call to a “normal” user? Answer: This call will be entirely recorded and booked under the recording user by design; those behaviors are intended under “recording rules”.
From a technical point of view mostly no other solution is possible, form a political point of view any rule could be endless discussed.

Remember that in this chapter “Agent” is just the wording for “user enabled to recording with license” while “user” is a “normal” user, eventually even recording pcap files, but he is not in the recording user group.

In theory senseless recording should not be done. So deleting a record because it should not be stored is a task of the recorder; not recording at all if not necessary is better. That can be achieved avoiding or forcing extensions to the recording gateways or doing recoding directly from the IP-Phone.

The length (or contend) of a record depends; if the recording is done on a GW the entire call will be recorded (if not you will find a note in the rules), from his very first answer to the end. Therefore all the parties involved are even recorded. If recording is done on the phone level just the active call time on that phone will be recorded.

Generally spoken there are not necessary recording rules if the recording is done from the innovaphone IP-Phone: the recording starts when the phone answer the call and ends when the phone hangs up.

So the following table shows the recording rules if recording is done on a GW level.

“External” is the external calling or called party. Of cause if you record even internals calls (forcing all calls in a GW) in some situation the “External” is in reality a internal user, but this will not change the rules. The recorder recognizes the “external” party involved simply because it is the longest number involved.

The recorder stores always even the reporting data and therefore all details are visible in case of doubts. The audio filename anyway if formed just from the internal user number and the external user number even if more numbers are involved in the call (for example in a 3party conference).

Example: External call from number 012345 goes to the Agent number 24, after 3 second he will answer: the result will be a file name like “2014-05-12 14:00_24_i_012345_3_UID”.

Later on in the player you can search “24” or “012345” (or a fraction of it like “0123*” ecc.). In the reporting you can search also all other fields (like other involved extensions) and start the player than from the reporting (see relative function in the innovaphone player).

Note: the following rules works on any type of call transfer (with or without announcement).

“Delete” means that the call will be deleted on the CF. “Call” means that they talk. For example “Agent calls External” indicated the direction and means also that the involved parties talk (or at least produce a pcap file).

Rules:

• External call to Agent = Agent

• External call to User = Deleted

• External call to Agent, User pick-up the call = Agent

• External call to User, Agent pick-up the call = Agent

• External call to broadcast group, Agent answer = Agent

• External call to broadcast group, User answer = Deleted

• External call to User, User hold and transfer to Agent = Agent

• External call to Agent A, Agent A hold and transfer to Agent B = Agent A

• External call to Agent A, Agent B pick up the call = Agent A

• External call to WQ, WQ call XML with DTMF input, XML call WQ, WQ call Agent = Agent (just the external Number is considered, not the DTMF codes and numbers between)

• Agent call External = Agent

• Agent call External, Agent hold and call transfer to User = Agent

• Agent call User, User hold and transfer to External = Deleted

• Agent call External, Agent hold and talk with User but no call transfer = Agent (just external conversation is recorded)

• Agent A call External, Agent A hold and transfer to Agent B = Agent A

• Agent B call External, Agent B hold and transfer to Agent A = Agent B

• User call to Agent, Agent hold and transfer to External = Agent

• User call External, User hold and transfer to Agent = Agent

• User call External = Deleted

• User call External, User hold and talking with Agent but no call transfer = Deleted

• User call Agent, Agent hold and Agent talk with External = Agent (just the external conversation is recorded)

• External call to Agent, Agent has activated a unconditional call forward (CFU) to a User = Deleted

• External Call to Agent, Agent has activated a call forward on busy (CFB) to a User and is busy = Deleted

• External Call to Agent, Agent has activated a call forward on no response (CFNR) to a User, User answer after timeout = Agent

• External call to Agent A, Agent A has activated a unconditional call forward (CFU) to Agent B = Agent B

• External Call to Agent A, Agent A has activated a call forward on busy (CFB) to Agent B and is busy = Agent B

• External Call to Agent A, Agent A has activated a call forward on no response (CFNR) to Agent B, Agent B answer after timeout = Agent A

Note: If Threat call recording is on a call can be marked to store from the calling or called agent. But if both parties are Agent, the called Agent has to dial the code for storing: if the caller dials the code the record will not be saved.

From version 11 on the generated pcap file have a different format. While in former versions the name of a pcap file was a unique single long number form version 11r1 on the ticket as two additional id, one is build form the serial number of the device and the other one if an increasing number. This new format is also generated when recording is done form directly the phone. The recorder can handle both formats automatically, no special setup is required.

We want to focus your attention on the reason of the new format. If for example the recording is done on the phone the phone will generate a new pcap file each time a new call is opened form the PBX point of view.

Example: Phone rings and the user answers, the recording starts with record 1. Then the user put the call on hold and call another extension, this generates record number 2. Then the phone returns to the first call and continuous talking that will be the 3td call. Of cause using the player you will see those 3 calls one after the other (using the user as filter). That this is one situation you recognize looking the reporting details displayed and if you select the 3 calls the player will play one after the other (switch on the loop key) and you listen the entire call in one shoot.

== TAN ==

Build 1167

TAN stand for “Transaction authentication number” used mainly in electronic banking and is a 6 digit long number. Of cause also other applications could use numbers like ticket systems or project handling.

In voice recording a record should be assigned to a TAN and a filter (search) should be possible. The actual integrated function work exclusive with a 6 digit number.

Please note that also a automatic association is possible as described in the relative chapter in this document: in this case all TAN issues are handled by the 3rt party application while this feature works without 3rt party application.

The operation depends of the Recording Mode in the innovaphone IP-phone.

If the Recording Mode in the IP-phone is switched on to “transparent” or “off” during a conversation the agent press the redial key.

If the Recording Mode in the phone is switched to “manual” or “optional” during a conversation the agent press a feature key (Redirect).

Than the agent enter the prefix for the TAN feature (the prefix for the TAN feature depends of the setup, see installation) and the 6 digit TAN code (without * and #) of this conversation.

During that operation the agent is in conversation with the far party, no DTMF tones are transmitted. In any moment (but during the conversation, not after) the Agent press the redial button to store the number. His phone release and ring again, during that the far party hear a call control tone. If the agent picks up the receiver the connection is again established. Therefore it is good practice to inform the far party that he will be shortly disconnected for operational reasons.

The call can be terminated now in any moment normally, the TAN information will be in the record and also in the reporting. The Recorder has not to be online in that moment because all information about the TAN is in the reporting.

A record can be edited in any moment using the player (if relative permission is switched on in the setup). A TAN can be edited (for example because erroneous operation in the online operation) and to any record can be added a TAN number. Please note that once a TAN number was add to the record the number can be modified but not cancel. Best practice is to assign “000000” as TAN for “no TAN records”. Please note that the option to add TAN to records and filter for TAN can be used also without the recorder just using the player.
In the player a filter for TAN can be activated and combined with any other filter. To filter enter the 6 digit TAN code and press enter. To reset the filter clear at least one digit and press enter.

[[Image:TAN02.png]]

In the record name the TAN is at the end of the filename, starting with a “T”.

The TAN feature is designed to work with innovaphone IP-Phones. The feature works also if a player-server is installed (http access to records). The feature is integrated in the reporting, therefore a player could be controlled directly as usual also from the reporting.

The feature works in the same way regardless if the Agent was called or has called a customer.

=== Setup ===

In the Setup of the Agent, Tab “permission” the “TAN” checkmark enables the player to search and modify TAN numbers. If that checkmark is on the main view of the player shows automatically the relative optional window with tooltip support.

[[Image:TAN01.png]]

To enable the online input during the conversation there are more setups required. Copy the xml “TAN.xml” on the CF/msata/webdav and create a VM object pointing on it. The number of this object will be the “TAN prefix”. Open the Recorder setup, tab “PBX” and enter the TAN prefix.

TCR require a XML (TAN.xml included in the software package of the Last call recording feature, see Related Articles, see Related Articles, go to the article and follow the download [http://download.innovaphone.com/ice/wiki-src#lcr http://download.innovaphone.com/ice/wiki-src#lcr] ).

== Known Problems ==

===Open a ticket===

If you have a problem with the recording tool you have to open a ticket as usual. Describe your problem, but send us also the following information:

- Setup of your PBX (with standard password or tell us the password)

- Version of the reporting

- Attach all log and error files and the setup of the recorder. All those files are in the log folder (so zip the entire folder), you find the path and link to the folder in the recorder setup.

- Make some screenshots if possible.

- Open the reporting and do a query where the recorded conversations are in (if possible). Do an export in XML and attached it.

=== No CDR ticket after start-up ===

If a record is not found on the CF and there is no SOAP info about that (for example if you start the recording and there are old terminated calls) the recording checks if the reporting has a related record. If a record is found and it is an Agent involved the record is stored as usual, if no Agent is involved the record will be deleted.

But if there is a recording file found and in the recording there is no related record, the recorder cold simply deletes that record; but this could be fatal. For example the reporting could answer once bad, or the link between the reporting and the PBX is temporary down; in that cases the recording will be lost if simply deleted. Therefore the recorder waits in this situation and asks the reporting again after 2 hours. If even after 2 hours the reporting answer with no record found the file will be deleted (otherwise normally processed and stored or deleted as described before).

Note that the reporting is not aware about the health of the connection between PBX and the Reporting. If the recorder gets no answer from the reporting an alarm occurs and the reporting will not proceed with the storage. But the answer “no record found” is not a clear situation for the software. Therefor this situation has to be avoided and occurs for example if pcaps are recorded, but the users involved have no reporting while the recorder is down and starts up later. So the recorder will “find” pcap files but no reporting information.

During online operation this will not happen, because the SOAP driver will tell the recorder that a specific record has to be deleted, and so the recorder will not check the reporting. This is done even to speed up the recorder because the communication with the reporting is relatively slow. If for example there are many users doing a recording (because a bad setup or simply because a huge PBX) and there are only few users to record a huge amount of files are simply to delete without any further processing. Deleting of files is relatively fast during online operation while in case of startup and then recover historic records it becomes slow, and very slow if there are no CDR tickets. The online deleting of files is just “relatively fast” because the SOAP is very fast but the recorded file has to be closed before deleting. Trying to delete a not closed file will cause an error, if that happen the system after e while will recover, but it is not nice. On top there is no way on a CF to understand if a file is in use or not. Therefore the system will wait 2 seconds before deleting a file.

=== No CDR ticket online ===

There is even an unclear situation in online operation. Imagine that an Agent transmits no CDR information to the reporting (for example because there is no reporting license assigned to that user) or, because of a bad setup in the PBX, the ticket will not arrive to the reporting. A call of an Agent is terminated, the SOAP driver informs the upper layer of the software about that and now the recording ask the reporting about the CDR details. Note that the reporting is not down; the recorder can reach the reporting and get also answers (otherwise the REP alarm would be on). If after a detected call end of an Agent signaled by SOAP and a timeout of 5 seconds no CDR is in the reporting a garbage select routine is activated in the recorder software; this routine ask a second time after other 5 seconds the reporting. If even now the response is “no record found” the reporting waits for this call 2 hours. After 2 hours a third time the reporting is asked, if no record is found the pcap is deleted, otherwise normal processed.

If a record is waiting in the 2 hours timeout status in the field “status” the countdown proceed is shown, for example “P1443”, after 5 seconds “P1442” and so one (number*5/60 = time in minutes to zero).

To fix it just stop the recording, solve the problem if possible (if you are lucky for example the CDR data are in the PBX buffer and will be send to the reporting when connection is up again), if not save the Pcap file, at least it will not be deleted. Then delete the pcap file on the CF to avoid a slowdown of the entire system.

A simple but good idea is to enable the CDR on the recording trunk line, in this case “some information” for the call is retrieved all time and at least the system will not face that problem.

All described can be the result of a bad or erroneous setup, or the customer is aware of that and simply not interested in a good working application. So a “no record” answer could be a real alarm or not. Therefore in the setup that can be selected.

See recording setup, panel reporting, option “Alarm if no CDR ticket found”.

=== Asynchronous reporting/PBX date and time ===

PBX and reporting must have the same date and time. If not, the reporting will detect that and display error and warning messages about a possible manipulation in the files.

So check first the actual date and time of PBX and reporting.

IPVA: Remember that date can be set in the reporting in administration, General, Configure NTP server.

===Voice Recorder Window is truncated===

It could happen that the Voice Recorder Window is truncated. The reason for this is the screen resolution setting in windows. To solve the problem, the screen resolution adaptation must be switched off (set to 100%) in windows system settings.

=== Player Crash on start-up===

If the player won’t start try first play a wave file using the Windows media Player. If the Windows Media Player cannot reproduce the wave file (for example because there is no audio device or the audio device is not ready) the player will not start up. Fix first the PC problem.

=== Recorder stopped responding after the start ===

We have had reports that recording did not run on windows 2008 r2. Symptoms were: recorder stopped responding after the start (recorder hang) and the link to the PBX was down. This had been fixed by running sfc.exe.

=== PBX Trap ===

If the PBX is doing a restart during a recording no CDR record will be produced. Therefore the partial PCAP File will be dropped. If the trap of the PBX is during a file copy from the Webdav, the recorder try up to 5 minutes, but will recover the operation automatically after that time.

===Recorder stopped converting records into mp3===
It can happen that the Recorder do not convert any record into mp3, event if the mp3 driver are detected and the mp3 conversion is on.
In that case, you should check if the name of the storage path contains special characters like "()","".

== Related Articles ==

[[Reference10:Player_Voice_Recording]]

[[Reference10:Voice_Recorder/Setup]]

[[Howto:Last_Call_Recording]]

[[Howto:Universal_Track_Recording_Tool]]

[[Howto:Integration_reporting_and_voice_recording]]

[[Howto:Soft-migration_%28looping_in_a_innovaphone_gateway%29_and_Voice_Recording]]

[[Howto:Player_over_http]]

[[Howto:Marking_a_record_in_Voicerecording]]

[[Howto:Voice_Recording_in_Master_Slave_scenarios]]

[[Howto:Recorder_as_a_service]]

[[Category:Concept|{{PAGENAME}}]]

Reference10:Player Voice Recording

2017-11-30T13:16:32Z

Gnd: /* Note */

This is a layout of the innovaphone voice recording Player Build 1135.

The figures in the descriptions maybe slightly different, but the functions are equal.

Note that this help shows all options enabled, your setup could hide some functions

The innovaphone voice recording software is intended for professional use.

It is presumed that the solution is operated only by trained personnel. Setup and servicing is reserved to skilled technicians.

== General ==

The following picture shows the 3 main sections of the innovaphone player.

[[Image:P1035_01_01.png]]

In the entire solution tooltips gives you additional information and hints. During a play the volume slider for the left and right channel shows the number of the relative participants.

All sections and items are described further on.

== Views ==

The Player functions can be limited in the setup, the following picture shows a player with all options switched off in the player setup, note the difference to the picture above.

[[Image:P1035_02.png]]

The user can also minimize views clicking on the relative sliders:

[[Image:P1035_03.png]]

The following picture shows some possible views:

[[Image:P1035_04.png]]

The player stores automatically the user setup and views when stopped. At the next start you will see the previous view mode, filter and audio settings etc.

The player works also if minimized in the taskbar. A typical example is the remote control of the player directly from the reporting.

[[Image:P1035_05.png]]

If a CDR ticket has a voice record a play symbol is displayed, and as tooltip the basic player elements (play/pause/stop) appears.
A click on those elements controls the player even if minimized.

==Headline==

The following picture shows the headline elements described from left to right.

[[Image:P1035_06.png]]

The '''lock''' symbol is only shown if the player has one or two User password. A click in the icon will lock the player; the result is shown in the picture, the user interface is “closed”. If the player is locked a click on the lock symbol will open on the left side of the headline an input box for the password. If there are two passwords defined in the setup after the first one the second one has to be entered (4 eyes principle).

The '''setup''' icon opens a menu, the options “Beep at end” and “Transcription” will be shown only if enabled in the setup. If the option “Beep at end” is switched on (the icon has a border like in the left menu shown) the PC reproduce a ”beep” at the end of the reproduction of a track if the repeat play function is switched on. Particularly usefully if more tracks are played from a playlist. See player section for mor einformation.

The '''transcription''' feature can be switched on and off, the relative window and control elements on the player will appear. This feature is described further on.

If the '''setup''' is protected by a password you must enter the password on the left side of the headline to access.

The '''help''' Button will open online this document, the '''about''' shows software and build information.

The '''minimized''' button puts the Player in the taskbar.

The '''exit''' button will show a dialog box.

=Records=
In the record section you can search and view records, select and play, decrypt, copy, cut and delete them and add notes.

[[Image:P1035_15.png]]

==Source==

[[Image:P1035_07.png]]

The records in the selected '''Year''' and Month will be displayed in the '''actual''' record list.
Note the colour of the list stack; in the picture it is orange, that indicates active and so the list will immediately act when you switch on for example a filter or change the Year/month. In some cases that is not usefully, for example if there are many records it could be better set first all the parameter and then push a query. A click to the Actual button will switch off the online display and the stack will have a grey colour, to display again the actual status press again the actual button.

The '''last played''' button shows the list of the last played records. The number of entry can be limited in the setup (max. 99).

There are two types of '''favourite''' lists: a '''global''' one, visible from all players and a personal one (“my”), visible just on this specific player. During reproduction of a track you can mark a record in one or both favourite list. Typically there are records that should be listen again or for example be shared with other player.

If there is a '''backup''' drive defined the player will browse records from there.

The '''last record''' view or “SOS” mode switch off all filter and simply shows the latest records first. Such mode is typically for emergency applications where a quick access to the last records is important.

'''Media player''' switches off the recording issues and you can select a searching path, the audio files in there are displayed and can be reproduced.

== Filter ==

[[Image:P1035_08.png]]

The '''Day''' filter limit the list view to the record of one day, blank = all days in the source month.

The '''internal''' number limits the list to calls to/from a specific internal extension, on the left audio cannel and left column of the list view. In the setup this filter can be set to a fix value, in this mode the player shows just calls from a specific number, typically the “own” calls. It is also possible set a list of numbers, if that is switched on the extension can be selected form a list displayed automatically. A typical application is a team leader that should be able to view just the calls of his team members.

The internal number must match exactly; if for example there is the number 361 and 362 the filter 36 will show no results. Wildcards are possible, for example 3* will show all numbers beginning with 3, 3?6 all numbers from 306 to 396.

The '''external''' number is the one the right cannel/ right column. External numbers have not to match exactly; therefore for example 36 has the same effect than 36*, 0703?730 again shows all numbers from 07030730* to 07039730*.

Calls can be filtered by direction to display '''incoming''' or '''outgoing''' calls, if a direction filter is selected the relative symbol will be displayed in orange.

If in a directory there are file in different formats the relative filter will appear automatically. Typically this will not happen because the recorder record in just one format. But if for example during a month the format is switched to on other one the filter criteria appear automatically. In normal situation no format is shown, even if you switch from a month with a specific format to a different one the player will change automatically the search mode.

== Convert Pcap to Wave ==

Build 1157

Player is able to convert pcap files to wave files if the source pcap files are not encrypted.

If pcap files are displayed a covert button appears automatically.

== List ==

The '''order''' button switch the list order, form the newest to the oldest or vice versa.

The '''direction''' shows if A called B or vice versa.

The '''record status''' indicates if the marked record is the original one. Please not that this feature work just in normal recording modes, for example not in pcap recording. Anyway the integrity of a record can be granted if the record is encoded by the recorder. The player will show if a record is encoded or not.

The '''record count''' shows the number of records in the list considering the filter parameter.

[[Image:P1035_09.png]]

Each records shows '''Date and Time''' (start time), the '''internal and external''' parties and the call direction. The '''file size''' in kB is just displayed if the player access to the filesystem (not if working with an http Player Server).

In the example one record is '''marked''' (blue), to mark a record just click on it. It is possible to mark multiple records using the Microsoft marking directives; Shift + click = from the marked record to the one indicated, Ctrl + click to mark single records.

Once a record is marked you can open the '''file operations''' list clicking the right mouse button. These options can be limited in the setup of the player, so do not wonder if no list appears at all. Please note also that some operations are only possible if a connection to the recorder is up. This is usefully because the recorder will update the reporting if for example a record is deleted.

A double click on a single record will start the player and the record will be reproduced. If more records are selected all marked records will be stored in a playlist and reproduced one after the other. See player section for more details.

The '''info''' button toggles the list view and display the real filename.

[[Image:P1035_10.png]]

Observe that the filename contains jet some important information: date and time, internal number, direction, external number, ringing time in seconds, a unique number and the file format.

== Note ==

If the details view is open notes are displayed automatically when a record is selected. If enabled in the setup you can add or modify notes, just put the cursor in the notes files and write your note.

[[Image:P1035_16.png]]

Save the note clicking on the icon situated on the left side of the text field.

Remark:
It is not possible to add a Note to a record if a TAN has already been assign to it.
The "no note possible" text will be displayed on the Note text field if you select that record.

== Details ==

If enabled call details records of the call are displayed automatically when e record is selected. The information of the displayed CDR is the same than the one in the reporting, so the exact call flow is shown. This information is always encrypted and stored independently. Please note that in the recorder this feature can be switched off and therefor no details are shown.

= Audio=

[[Image:P1035_13_01.png]]

== Counter ==

The upper part shows the track position counters in 1/10 second precision. Please note that the counter will jump to the relative values if the position in the record is changed manually (see player section).

The '''historic timestamp''' shows the historic timestamp. In the example the playing reproduce the conversation recorder at 9:55 AM and 41 seconds. This counter will only be visible if the information is present (present in the CDR ticket), for example not if a normal audio file is played.

The '''countdown''' shows the missing time to the end of the record, in the example missing 14 second to the end of the record.

The '''cuntup''' is a traditional track time counter, in the example one second was reproduced up to now.

[[Image:P1035_11.png]]

== Volume and Metering ==

The '''volume''' of the left and right channel can be modified, that is usefully because typically the internal caller is much louder than the external (far) one. Therefore there is a volume slider for the right and left audio level and a general volume slider. Please note that the volume of this application is done on application level, and therefore the general audio level of the PC is not modified. In this way the application can be adapted to other audio sources.

The '''level''' of left, right and general is displayed, this values are the volumes send to the PC audio device (as explained, the real level depend on the general volume set on the PC).

Clicking on the loudspeaker icon the single channels and the overall audio output can be '''muted'''. If a single channel is muted and then unmuted, the restored volume is the one before muting.

A click to the '''max volume''' label will bring all slider to 100%.

The audio level setup can also be stored pressing the '''store my Volume''' icon label; pressing the label the stored setup is switched on.

The audio meter bridge shows also the '''channel difference''' with two delta level indicators, left channel minus the right channel and vice versa.

[[Image:P1035_12.png]]

The '''double sensitivity''' button allows displaying better very low audio levels. Please note that in telephony the audio level is about 60% lower than the usually PC audio level.

The two buttons for '''meter dynamic''' responses switch the meter display from integration to peak indication.

In the example a peak is shown, the meter bridge shows and clears '''peak values''' automatically.

= Player =

[[Image:P1035_14.png]]

== Information ==

The Information panel shows some information of the actual in the player loaded record, basically the information stored inside the name of the record itself; the track (extension) '''number''' of the two participant, the left (typically internal) and the right (typically external) and the '''call direction'''.

[[Image:P1035_17.png]]

In the example the extension 24 calls the number 5736. The '''ringing time''' shows in seconds the time to answer. The player analysed the file format and eventual '''encryption''' before playing. If a reproduced record is encrypted the relative symbol appear automatically. The '''Record ID''' is the unique number of this recording.

The slider '''audio features''' opens the memory recorder feature.

[[Image:P1035_18.png]]

The recorder can store up to 4 “from” – “to” positions in a record and play one or all positions. This is useful if in a long recorded conversation should be retrieved or repeated some portions. The player stores automatically that memory entry and if in a second time this record is loaded again the timestamps are displayed automatically.

To mark a position select a '''memory position''', starting with the first if all are blank. In the example the sleeted active button is M2. Press at the desired moment the '''“from”''' key to fix the start point and the '''“to”''' key to indicate the stop point. This can be done as described for 4 positions. In the example the first memory start at 49 seconds an terminated at 1 minute and 17 second.

A active memory position (M2 in the example) can be deleted using the delete memory icon.

A memory position can be played, select the memory position and press the '''play memory''' button. Now the player will reproduce in a loop this partial track. If key play memory is pressed again the player go on playing the entire track.

If there are more memory positions like in our example the '''memory looping''' can be pressed, if active one memory position after the other will be reproduced. In our example first form 00:49 to 1:47, that form 3:12 to 3:23 and then again from 0:49 to 1:17 an do so one.

The '''Slider information''' closed this panel.

== Position ==

The slider can be dragged to any position, once dropped the player will continue playing at the new position and also the counters will following in real time the movements.

A click on the position slider causes a jump to the new position.

[[Image:P1035_19.png]]

Once loaded the historic '''start and stop time''' is displayed as well the '''date''' of the recording. '''Duration''' is displayed; remember that the counter in the audio section displays in real time the '''actual position'''. You can see the approximate actual position also in the position slider.

== Operation ==

The '''Play''' key toggles with the '''Pause''' function if in play mode.

The '''Stop''' key stops the player, unlike using the Pause function if now play is pressed the player starts again from the beginning.

The '''Eject''' key unload the record form the player and enabled again the search section.

If one track is loaded in the player and the previous key is pressed the player reproduce the previous track in the list of records, the same mechanism applies the next key, next track in file list will be played.

[[Image:P1035_20.png]]

In the file list more records can be marked, if in this situation play is pressed all the selected records are stored in a '''playlist''' an reproduced one after the other (max. 99 tracks). The Playlist counters are shown automatically if more than one track is loaded. The '''Actual rack''' counter shows the track actual in play, the '''Total track''' counter how many track are in the playlist. In the example track 2 of 5 is in play.

During a loaded playlist the previous and next key will jump to the previous and next track in the playlist.

A click on the actual track during the reproduction of a playlist will stop the player, clear the playlist but hold the actual record that could be started again. This is useful if in searching a record the record is found and should be now further processed. If in the setup the feature “beep at end” is switched on the PC will beep between each record of the playlist.

== Features ==

If the '''repeat play''' feature is switched on like in the example the player loop the record. If switched off (symbol is in grey colour) reached the end of the track the player stops.

[[Image:P1035_21.png]]

The actual record can marked as favourite: if marked as '''global favourite''' all player in a system will see these records in the global favourite list. Tracks marked as '''favourite''' (“my”) are visible just by this player.

A loaded record can be '''export'''ed, the audio file will be automatically encoded if encrypted, the encrypted XML file will be encoded.

If the player is controlled from '''remote''', typically from the reporting, a advising is switched on.

==Recorder==

The recorder can be supervised and controlled from remote. See relative description in the article for recorder as a service. The information in this chapter is just for document completeness.

[[Image:P1035_22.png]]

'''Channel in use''' shows how many recording are actually in use. If a recording is detected the status icon shows turning recoding wheels. '''Files recorded''' are the number of files recorded from the beginning on.
'''Files to process''' are files detected but not jet converted or in converting. The '''file converting''' icon is green during file audio processing while grey during other recorder operation. The '''Heartbeat''' will flash during inactivity of all other process to signal active recorder status. The '''Stop recorder''' icon allows to stop the recorder from remote.

== Transcription ==

The transcription tool is used if a transcription of the conversation (for example on a Word document) is required.

The Autostop function will stop the player automatically each time the actual not talking party volume threshold is reached.

Once activated a second small window allows a remote control of the player. This window is hold in foreground while the player is not. Typically the word document is open and the small pilot window is on top. In our example the small window is dragged over the player to show the relation between the commands.

[[Image:P1035_23.png]]

If one channel reaches the Autostop trigger level the player stops automatically and start again pressing the play button. The Trigger cannel causing the stop is indicated as well the number speaking on the left and right channel.

Reference12r1:Concept Innovaphone Virtual Appliance (IPVA)

2017-11-27T11:45:47Z

Gnd: /* What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'' */

[[Category:Concept12r1|{{PAGENAME}}]]

==Applies To==
This information applies to:
*V12r1 SR7
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation
**Player <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.x-6.x
**ESXi 6.0
*For support of Hyper-V, refer to this [[Concept_IPVA_On_Hyper-V|article]].

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A virtual machine according to the '''O'''pen '''V'''irtualization '''F'''ormat specification. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot harddisk (hd)
**On IDE 0:0
*hd-cf.vmdk: The hd for emulation of a Compact Flash card
**On IDE 0:1
*hd-flash.vmdk: The hd for emulation of flash memory
**On IDE 1:0
*hd-dump.vmdk: The hd serving as a store for a crash dump
**On IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

;ipva-vmx.zip:
A legacy zip file containing the IPVA according to a VMware proprietary format.

===VMware Player And VMware Workstation===
*Copy the file ipva.ova to e.g. your desktop
*Double-click on ipva.ova.
**The IPVA is going to be imported.
*Edit the file ipva.vmx according to [[#What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]
**'''Note''': Skipping this configuration setting will let the IPVA crash
*Power-on the machine

===VMware vSphere===
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]
**'''Note''': Skipping this configuration step will let the IPVA crash
*Power-on the machine

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

==Download==

IPVA.zip
* v12r1: https://download.innovaphone.com/ice/12r1/#firmware
* v12r2: https://download.innovaphone.com/ice/12r2/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==

=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== No Fault Tolerance Support from VMWare vSphere 6.5 ===
We have reports that VMWare vSphere 6.5 Fault Tolerance (FT) no longer works. For further information regarding this feature, please refer to the respective note in [[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Implement PBX with zero downtime using IPVA and VMWare Fault_Tolerance]].

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

==FAQ==
===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|Console displays ''Loading failed for image=IPVA BIN'']]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*With ipva.ova deploy a fresh IPVA by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*In the old IPVA remove the 1st disk on IDE 0:0.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA's directory.
*In the old IPVA add the 1st disk on IDE 0:0.
*In the old IPVA confirm and start the machine

==Notes==
<references/>

==Related Articles==
[[Reference10:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference11r2:General/SSD/Image

2017-11-14T13:05:53Z

Gnd: /* Download */

===General===
You have to unmount/remove the SSD, before you can upload an SSD image to your card. 

====Image size====
As uploads of files > 2 GB are not supported by browsers, images must be downloaded and uploaded in 2 GB parts. 
Select the current part and submit the change before you download or upload the part.

===Upload===
Select an uncompressed image file and upload it to your SSD. 

'''Warning''': this will delete all partitions and files, which are currently present on your SSD!

===Download===
Downloads the currently selected part.

Image file parts needs to be downloaded manually and one after the other.
You have to select the first image part and download it. After the first one as been completly downloaded (Size of the disk_image File about 2GB), then select the next one, download this etc. until the last image part.
The name of the image part indicates the actual image part and last image part to be downloaded.
Example: disk_image-1(15).img
1: image file part 1 (the first one).
15: the last image file part to be downloaded.

===External tools===
To create an own image from an SSD under windows, you can use the [http://www.securepoint.de/securepoint-downloads.html Securepoint Imaging Tool]. 
If you want to upload such an image, you have to split it into 2.147.483.136 bytes sized parts. There are enough free tools available for this job.

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2017-01-10T14:44:17Z

Gnd: /* How to run a restored backup that fails to start */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware
* v12r1: http://download.innovaphone.com/ice/12r1/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA does not run on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue.

From V12r1 sr7 on, the .ova version is available in v12r1 too.

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|Console displays ''Loading failed for image=IPVA BIN'']]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.
*'''[Update 22 December 2016]''' with the release of 12r2 beta an OVA file was made available. Watch out for the folder '''ovf''' within the downloadable zip file.
*'''[Update 10 January 2017]''' with the release 12r1 sr7 an OVA file was made available. Watch out for the folder '''ovf''' within the downloadable zip file.
**Read section [[#What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21|What Can I Do In Case Of Boot-Problem:perf-counter not enabled?]]

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2017-01-05T13:36:51Z

Gnd: /* How to run a restored backup that fails to start */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware
* v12r1: http://download.innovaphone.com/ice/12r1/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA does not run on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue.

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|Console displays ''Loading failed for image=IPVA BIN'']]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.

'''[Update 22 December 2016]''' with the release of 12r2 beta an OVA file was made available. Watch out for the folder '''ovf''' within the downloadable zip file.

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2016-12-06T13:15:57Z

Gnd: /* How to run a restored backup that fails to start */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

If you perform backup and restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2). 
You can proceed as follows:

* Download the "ipva.ova" 
* Import and deploy it in your ESXi 6 Server. 
>Go to File-> Deploy OVF template. 
>Select the File or the url where the ova file is located and follow the steps on the screen. 
* Perform a backup of the IPVA using Veeam 9. 
* Then delete the not working IPVA from the ESXi datacenter. 
* Perform a restore of using Veeam 9. 
* Upload the config of the old IPVA.

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2016-12-06T10:19:59Z

Gnd: /* Restored IPVA may not run */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

If you perform backup and restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2). 
You can proceed as follows:

* Download the "ipva.ova" 
* Import and deploy it in your ESXi 6 Server. 
>Go to File-> Deploy OVF template. 
>Select the File or the url where the ova file is located and follow the steps on the screen. 
* Perform a backup of the IPVA using Veeam 9. 
* Then delete the not working IPVA from the ESXi datacenter. 
* Perform a restore of using Veeam 9. 

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2016-12-06T10:15:08Z

Gnd: /* How to run a restored backup that fails to start */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

Note: If you perform Backup and Restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2).
To import and deploy an ipva.ova in your ESXi 6 Server,
go to File-> Deploy OVF template.
Select the File or the url where the ova file is located and follow the steps on the screen.

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

If you perform backup and restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2). 
You can proceed as follows:

* Download the "ipva.ova" 
* Import and deploy it in your ESXi 6 Server. 
>Go to File-> Deploy OVF template. 
>Select the File or the url where the ova file is located and follow the steps on the screen. 
* Perform a backup of the IPVA using Veeam 9. 
* Then delete the not working IPVA from the ESXi datacenter. 
* Perform a restore of using Veeam 9. 

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2016-12-06T10:10:22Z

Gnd: /* How to run a restored backup that fails to start */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

Note: If you perform Backup and Restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2).
To import and deploy an ipva.ova in your ESXi 6 Server,
go to File-> Deploy OVF template.
Select the File or the url where the ova file is located and follow the steps on the screen.

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

If you perform backup and restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2). 
You can proceed as follows:

* Download the "ipva.ova" 
* Import and deploy it in your ESXi 6 Server. 
Go to File-> Deploy OVF template. 
Select the File or the url where the ova file is located and follow the steps on the screen. 
* Perform a backup of the IPVA using Veeam 9. 
* Then delete the not working IPVA from the ESXi datacenter. 
* Perform a restore of using Veeam 9. 

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference10:Concept Innovaphone Virtual Appliance (IPVA)

2016-12-05T17:48:25Z

Gnd: /* Restored IPVA may not run */

[[Category:Concept9|{{PAGENAME}}]]
==Applies To==
This information applies to:
*V10
*innovaphone Virtual Appliance
*Intel/AMD CPUs
*VMware
**Workstation 7.1
**Player 3.x <ref>VMware Player Download(free): http://vmware.com/download/player/</ref>
**vSphere 4.1
**vSphere 5.x
***[[User:Inno-mst|Inno-mst]] 14:25, 16 October 2013 (CEST): vSphere '''5.5''' compatibility has been reported
**vSphere 6.0 and also the Operating System ESXi 6.0
**Fusion 5.x (Mac OS X 10.7)

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.
Whereby, VMware<ref>http://www.vmware.com</ref> is is the solely supported virtualization platform to-date.

The IPVA is a software-only solution. It appears as and performs as an innovaphone "hard-box" excluding DSP-, ISDN-/AB-resources.

The following core-components are contained within the IPVA:
*innovaphone PBX
*innovaphone Gateway (a.k.a ''Relay'')
*integrated mass-storage (alike innovaphones' CF-card support)


==Configuration==
[[#Download|Download]] the IPVA.

*The compressed archive ''ipva-vmx.zip'' contains 1 virtual machine configuration file (*.vmx) and 4 virtual machine disk files (*.vmdk):
**ipva.vmx: The virtual machine configuration file
**hd-boot.vmdk: The virtual boot harddisk (hd)
**hd-cf.vmdk: The hd for emulation of a Compact Flash card
**hd-flash.vmdk: The hd for emulation of flash memory
**hd-dump.vmdk: The hd serving as a store for a crash dump

The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

===VMware Player===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

A shortcut (*.lnk file) to the vmx-file will start the IPVA without additional user interaction. Such a shortcut may also be copied into the Windows ''Autostart'' program folder, in order to have the IPVA started automatically on windows startup.
===VMware Workstation===
*Copy the IPVA to e.g. your desktop
*Double-click on ipva.vmx
The IPVA is going to be started.

The ''Workstation 7'' directory comprises the command line utility ''vmrun.exe''. A batch file according to the following pattern may be crafted to programmatically start the IPVA.
<pre>
"D:\Programme\VMware\VMware Workstation\vmrun" start "C:\Users\Tester\Desktop\ipva\ipva.vmx"
</pre>
'''Note''': By altering ''start'' into ''stop'' a virtual machine may be stopped.
===VMware vSphere===
This applies to vSphere 4.x and later (such as e.g. vSphere 5.5, vSphere 6.0). 

====VMware vCenter Converter Standalone====
The IPVA offered for downloading must be converted into a vSphere-processable form.
The IPVA can be converted by means of the tool ''VMware vCenter Converter Standalone''<ref>VMware vCenter Converter Standalone: https://www.vmware.com/tryvmware/?p=converter</ref>.
*The user guide can be found [http://www.vmware.com/pdf/convsa_50_guide.pdf here] and also a step-by-step guide may be found [https://kb.swivelsecure.com/wiki/index.php/VMWare_Converter_How_to_Guide here].
Make sure you ''always use the latest VMware converter'' to convert your IPVA.

See [[#Why_Isn.27t_There_An_OVA.2FOVF_File_Made_Available.3F | here]] for a discussion why the conversion is needed.

===Network Configuration===
Manufacturer-configured as DHCP client only. I.e. a DHCP server must be available. Afterwards the network configuration may be administrated as used to within the web ui of other innovaphone boxes. If there's in no case a DHCP server available for the 1st-time configuration, read through [[#What_Is_The_Console_Good_For?|What Is The Console Good For?]].

====VMWare Player and Workstation====
In order to assign a new MAC address on a VMWare Workstation or VMWare Player:
*Power-off the virtual machine
*Open the file ipva.vmx for editing within a text editor.
*Edit the last 3 hex-values of the lines starting with ''ethernet0.generatedAddress'' & ''uuid.bios'' from e.g.
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:d9"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 d9"
</pre>
into e.g
<pre>
ethernet0.generatedAddress = "00:0c:29:f4:c6:da"
uuid.bios = "56 4d 64 b9 52 ce 38 57-66 29 e8 f2 77 f4 c6 da"
</pre>
(Note: in this example just the very last hex-value '''d9''' is going to be altered into '''da''')
*Within my.innovaphone.com try once again to generate licenses for the virtual machine with the new MAC address.

===License Configuration===
For the IPVA10 license see [[Reference10:Licenses]].

The licensing procedure is the same as for other innovaphone products, except for one peculiarity: The MAC address, generated by VMware, may have been assigned already to another customer/installation. Such a conflict must be settled manually as explained below.

If, while generating licenses within ''my.innovaphone.com'', a message ([[Reference:My_Innovaphone#IP-VA_MAC_exists|My_Innovaphone#IP-VA_MAC_exists]]) is displayed:
<pre>
IP-VA MAC exists
</pre>
then a new MAC address must be assigned manually to the affected installation.

'''Note:''' We recommend to not use auto-generated MAC Address for the IPVA machine. Please assign a static MAC address like '00-50-56-...' to prevent license issues if the machine must be rebuild since you will assign the same MAC address after and not the auto-generated MAC.

====VMWare vSphere, ESX/ESXi 4.1 and ESXi====
For information related to vSphere, ESX/ESXi 4.1 and ESXi 5.x, see the Mac Addresses section of the [https://www.vmware.com/support/pubs/vsphere-esxi-vcenter-server-pubs.html vSphere Networking Guide] for your version of ESX/ESXi.

==Provision Of External Resources==
External Resources are required, in order to provide:
*Access to ISDN interfaces
*DSP conferencing channels

The IP1060<ref>[[IP1060 Technical Data]]</ref> or IP1130<ref>[[IP1130 Technical Data EN]]</ref> media gateways may be considered as a suitable complement for such purposes.

==Download==

IPVA.zip

* v9: http://download.innovaphone.com/ice/9.00/#firmware
* v10: http://download.innovaphone.com/ice/10.00/#firmware
* v11r1: http://download.innovaphone.com/ice/11r1/#firmware
* v11r2: http://download.innovaphone.com/ice/11r2/#firmware

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Admistration/Diagnostics/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).
**Note: Deviating from innovaphones' physical appliances, the DRAM-content(with may be post-mortem info) does not survive a CPU-reset. This is why post-mortem information is going to be stored persistent on the 4th disk, named ''hd-dump.vmdk''.

Some known issues are listed further below under [[#FAQ | FAQ]].

==Known Issues==
===ESX 3.x is unsupported===
The IPVA does not run under ESX 3.x and below, since virtual IDE disks aren't supported.

===Don't use Maintenance/Upload/DRAM on vSphere 4===
Until further notice this way of uploading a new firmware is currently not supported. The VMM detects and assumes the guest (IPVA) is going to shutting-off. All the virtual harddisks may get lost in the aftermath.
vmware.log shows:
<pre>
...

Mar 02 13:02:25.439: vcpu-0| Vix: [4864986 vmxCommands.c:9609]: VMAutomation_HandleCLIHLTEvent. Do nothing.
Mar 02 13:02:25.462: vcpu-0| MsgHint: msg.monitorevent.halt (sent)
Mar 02 13:02:25.462: vcpu-0| The CPU has been disabled by the guest operating system. Power off or reset the virtual machine.

...and then when trying to power-on later...

Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide0:1 vscsi=8303
Mar 03 08:37:00.260: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.260: vmx| VMMon_VSCSIDestroyDev: Not found
Mar 03 08:37:00.260: vmx| Destroying virtual dev for ide1:0 vscsi=8304
Mar 03 08:37:00.261: vmx| VMMon_VSCSIStopVports: Invalid handle
Mar 03 08:37:00.261: vmx| VMMon_VSCSIDestroyDev: Not found
...
</pre>



=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

Note: If you perform Backup and Restore under ESXi6 and Veeam 9, you should use an "ipva.ova" (available from V12r2).
To import and deploy an ipva.ova in your ESXi 6 Server,
go to File-> Deploy OVF template.
Select the File or the url where the ova file is located and follow the steps on the screen.

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How_To_Replace_The_Boot_Disk_On_vSphere.3F | How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

==FAQ==
===Are Firmware Updates Possible?===
Yes, alike the well-known *.bin firmware files for other innovaphone products (ip6000.bin, ip2000.bin,..) , there's a similar bin-file (ipva.bin) for the IPVA. The file is contained on the boot-hd and can be found by browsing to e.g. http://192.168.0.5/drive/HD-BOOT . The versioning of ipva.bin is the same as for the other products. The firmware file may exactly be uploaded as for other products:
* by ''Upload/Firmware''
* by ''Upload/Dram''
* by a script for the innovaphone Update Process

===What is the ipva default password?===
*user: admin
*password: ipva

===Do I Always Need To Download The Entire IPVA?===
No, after the 1st-time deployment of an entire IPVA only the firmware file ''ipva.bin'' needs to be downloaded from ''download.innovaphone.com''. See [[#Are_Firmware_Updates_Possible.3F| Are Firmware Updates Possible?]] for how to proceed further.
===How Is The Network Connection Being Handled?===
The network connection is pre-configured to: ''Bridged: Connected directly to the physical network''
===What Is The Size Of the Emulated CompactFlash?===
1GB

===Can The Emulated CompactFlash Be Increased In Size?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated CompactFlash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)

===What Is The Size Of the emulated Flash Storage on the IPVA?===
The virtual flash storage used to store configuration file of the IPVA and LDAP directory of the PBX is defined with 64 MB and can not be changed. This is two times more than on IP6010. The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is fixed to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

<code type="text">
0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)
</code>

===How Much RAM Is Required Per IPVA Instance?===
The downloadable virtual appliance comes preconfigured with 64MB RAM. This amount is seen as a good trade-off for the majority of all installations.
The RAM-size can be administrated by VMware-means.

The minimum RAM size allocatable to an IPVA in VMware is 20MB. This results in a DRAM size seen by the IPVA of 17MB and roughly 8MB allocatable runtime memory after boot. Note though that even a small IP302 model has 17MB allocatable runtime memory after boot.

===What Is The Maximum Amount Of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why Does ''General/Info/DRAM'' Show Less Than the Configured Memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===How Many IPVA Instances Are Possible Per Host?===
There's no worst-case estimate available. For a best-case calculation,
*see [http://www.vmware.com/pdf/vsphere4/r41/vsp_41_config_max.pdf Configuration Maximums VMware vSphere 4.1]
*see [[#How_Much_RAM_Is_Required_Per_IPVA_Instance.3F | How Much RAM Is Required Per IPVA Instance?]]
Additional preformance reflections
*see [[HOWTO:A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

===Where Has PPP-Functionality Gone?===
PPP-scenarios (PPTP, PPPoE) are not envisaged with the IPVA, because it has only one network interface controller.

'''Update'''(07.Mar.2011), from on 90468:
*PPP has been integrated
*a second network interface is available (now ETH0 and ETH1)
**ETH1 comes pre-configured: ''host-only, disconnected''. I.e. it must be reconfigured manually and by VMware means to become functional.

===Does The IPVA Support Non-VMware Hypervisor Products?===
No, currently it doesn't.

===How do I perform a factory reset?===

replace the 3rd disk, served on IDE 1:0, named hd-flash.vmdk with an empty disk:

[[Image:VM_Settings.png]]

1)download the IPVA and watch out for the file hd-flash.vmdk

2)Power-off the IPVA instance

3)Replace hd-flash.vmdk with the one downloaded in step 1). If on vsphere it may have been assigned a different name. Ensure it’s the one on IDE 1:0.

4)Power-on the IPVA instance

===Is VMWare Fault Tolerance (FT) supported by IPVA?===

Yes, we have successfully tested<ref>[[Howto:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance | Howto:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance]]</ref> VMWare Fault Tolerance<ref>VMWare Fault Tolerance: http://www.vmware.com/products/fault-tolerance/overview.html</ref> with a virtual machine running IPVA on VMWare vSphere 4.1.

===What About VMware Tools?===
VMware Tools are not supported.

===What Is The Console Good For?===
The console is a remains of the early development phase. It resembles the IP3000's serial console. It doesn't offer any convenience like command history or backspace funtionality. Nevertheless may the console be of help in exceptional situations where e.g. the required DHCP server isn't available for 1st-time configuration or in situations where the ip configuration was misconfigured. Thereby any command from a device's config is acceptable.

For instance to configure the static IP address 1.2.3.4/24 on ETH0:
*Click into the console
*Press ENTER
*Enter credentials
*Enter
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0
config change DHCP0 /mode off
config write
reset
</pre>
Since no backspace is offered it may become a daring task to enter a single line without typos. In case of a typo hit ENTER and input the same line again.
The keyboard layout is the US layout.
[[Image:Ip-via-console.png|center|thumb|200px|Console-edit of IP address]]

Display the IP configuration for ETH0:
<pre>
config show IP0 ETH0
</pre>

Display the DHCP configuration for ETH0:
<pre>
config show DHCP0
</pre>

Additional the DNS-server(s) and the default gateway can be configured:
<pre>
config change IP0 ETH0 /addr 1.2.3.4 /mask 255.255.255.0 /dns 8.8.8.8 /dns2 8.8.4.4
config change IP0 RT0 /gateway 1.2.3.254
config change DHCP0 /mode off
config write
reset
</pre>

Also some simple diagnostics (ping and traceroute) are possible via the console (output is given in the console):
<pre>
mod cmd PING0 tracert 8.8.8.8
mod cmd PING0 ping 8.8.8.8
</pre>

Resetting the entire FLASH space - '''Note, all configuration will get lost'''. this is similar method to the manufacturer reset method from above [[#How_do_I_perform_a_factory_reset.3F|How do I perform a factory reset?]]
<pre>
mod cmd FLASHMAN0 reset all
reset
</pre>

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|Console displays CRC boot error]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|Console displays ''NIC unavailable!'']]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|Console displays ''perfcounter-not enabled!!!'']]

'''Solution''' 
This problem is likely caused by a faulty configuration file ''ipva.vmx''. Such a situation will definitely occur after importing the appliance into vSphere without importing the appliance's configuration file ''ipva.vmx''.
*The solution therefore is a complete conversion of the IPVA as outlined above [[#VMware vSphere | VMware vSphere]].

'''Remarks''' 
The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

===Why Isn't There An OVA/OVF File Made Available?===
Simply because of the feature discussed in [[##What_Can_I_Do_In_Case_Of_Boot-Problem:_perf-counter_not_enabled.21 | What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]. That feature can only be described in VMX files and is not projectable onto an OVA/OVF file.

===Are Additional vCPUs useful?===
No, the innovaphone OS is a single task OS. Additional virtual CPUs(vCPUs) cannot be utilized.

===How To Replace The Boot Disk On vSphere?===
The recommended way is as follows:
*Convert and deploy a fresh IPVA.
**Its use to just serve as a copy source.
*Power-Off the old IPVA.
*From the new IPVA copy the 1st harddisk(on IDE 0:0) towards the old IPVA.
**The old boot disk gets thereby replaced by the fresh one.

This procedure guarantees that the new boot disk conforms to vSphere's disk format.

==Notes==
<references/>

==Related Articles==
[[Reference9:Licenses]]

[[#A_rough_estimate_of_IPVA_Performance | A rough estimate of IPVA Performance]]

[[Category:Concept|Innovaphone Virtual Appliance]]

Reference9:Concept Linux Application Platform

2016-11-22T17:19:38Z

Gnd: /* Linux Application Platform (VMWare) */

==Introduction==

The innovaphone Linux Application Platform permits to install innovaphone or custom applications for certain purposes, like Reporting or a Fax Server. 
It also allows to backup/restore configuration files, uninstall applications or see and backup logs. 
 
The Linux distribution Debian 6 (Squeeze) is used and linux kernel is 2.6.35.4. 
 
The architecture of the platform is armel. 
 

==Requirements==

There are two ways to use the innovaphone Linux Application Platform:

===On an IPxx10 Gateway===
* An IP810, IP0010, IP3010 or IP6010 Gateway
* Firmware Version 9
* A compact flash card with UDMA support (minimum 4 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

===As a Virtual Machine===
* VMWare Player
* VMWare Workstation
* VMWare Server
* VMWare vSphere

==Installation==

Download the latest Linux Application Platform from [https://download.innovaphone.com download.innovaphone.com ]. 
You can download and install two different packages:

===Default Credentials===
* Web/Webdav: '''admin'''/'''linux'''
* Root-Login (e.g. with Putty): '''root'''/'''iplinux'''

===Disk space usage after first time installation===

====IPxx10 Gateways====

* /dev/sda1: 32 MB (fat32 partition with kernel, which is started by the IPxx10)
* /dev/sda2: 450 MB (ext2 initial installation partition)
* /dev/sda3: 120 MB (swap partition)
* /dev/sda4: 600 MB / xx GB depending of the size of the used CF card (ext4 partition, which is actually booted)

All in all about 1.2 GB are already in use after the initial installation.

====VMWare====

* /dev/sda1: 665 MB (ext2 initial installation partition)
* /dev/sda2: 120 MB (swap partition)
* /dev/sda3: 680 MB / xx GB depending of your pre installation configuration (ext3 partition, which is actually booted)

All in all about 1.5 GB are already in use after the initial installation.

===Linux Application Platform (IPxx10 Gateways)===

It is recommended to use CF-Cards with sizes of 8GB or more and the card '''must''' support UDMA! 
* Enable Linux under Linux General.
[[image:IPxx10_Linux_-_enable.png]]
* Enable Proxy-ARP on ETH0 or ETH1 [[ Reference:Configuration/ETH/IP|here ]]
* Decompress the downloaded package. You should have an image file like <code>linux_ipxx10_armel.img</code> now.
* Upload the decompressed file over the gateways web interface under [[ Reference9:General/Compact-Flash/Image ]]. Unmount the CF card if necessary. Select "Part 1" before starting the upload!
[[image:IPxx10_Linux_-_upload_image.png‎]]
* Reset the box (which also activates the config change of step 1).
* Configure IP under [[ Reference9:Linux/IP ]]: select either "Disabled" to assign a static IP or ETH0/ETH1 to receive an IP-Address from DHCP-Server behind ETH0 or ETH1.
* Configure the kernel file, which you find under [[ Reference9:General/Compact-Flash/General#Browse_CF_Content ]] on [[ Reference9:Linux/General ]] '''Linux kernel file''' (Currently <code>Image-6010-3.4.10</code>)
* Configure <code>root=/dev/sda2</code> under [[ Reference9:Linux/General ]] '''Kernel command line'''.
* If you want, configure the autostart flag.
* Submit your changes.
* Click the [[ Reference9:Linux/General ]] '''Start'''-Link. The page refreshes until Linux gets an IP and then tries to get a link to the Linux Web Server, which can take some time for the first time installation (~ 5 minutes to 2 hours).
[[Image:device_conf.jpg]]
* Open the Linux Web Server to see the installation progress (which might take several minutes too). The default credentials are '''admin'''/'''linux''' for both platforms.
[[Image:installation.jpg]]
* Enter the innovaphone device admin credentials when the installation has finished. Now wait until the page refrehses. The web server credentials are now the innovaphone device admin credentials, e.g. '''admin'''/'''ip6010'''.
** If the device couldn't be reconfigured, you will get an error message '''Command line at the PBX could not be changed...''' In this case, you have to open [[ Reference9:Linux/General ]] on your device, click stop and enter <code>root=/dev/sda4</code> under '''Kernel command line'''. Then start again. Your Linux webserver credentials will be '''admin'''/'''linux''' in this case.
* Linux install has finished.
* You will see now <code>root=/dev/sda4</code> under [[ Reference9:Linux/General ]] since Linux is running in on the fourth partition. You shouldn't change that unless you want to install Linux again.

===Linux Application Platform (VMWare)===

* Decompress the downloaded archive. You should have two files: '''IP-Debian.vmx''' and '''IP-Debian.vmdk'''.
* We can open using Vmware Player/Workstation, if you wish to run on Vsphere 4.x or later please convert it by the same method it's done with the IPVA (see [[Reference10:Concept_Innovaphone_Virtual_Appliance#VMware_vSphere | Using VMware vSphere]])
* Now you have two possibilities (example for VMWare Player, VMWare Workstation should be similar):
** If you want to assign more than 4 GB disk space (8 GB since Hotfix 7):
*** Do '''not''' directly start/doubleclick the vmx file!
*** Start the VMware Player and Open the vmx file with '''Open a Virtual Machine'''.
*** Open '''Edit virtual machine settings'''.
*** Select the hard disk and '''Expand''' it under '''Utilities''' to the wished size.
*** Apply the change and klick '''Play virtual machine'''.
** If 4 GB (8 GB since Hotfix 7) are enough, simply double click the vmx file and Linux will start.
* The first time, a script will automatically configure a new partition, the web server etc., which will take some time. The waiting time depends on the CPU of the computer running the vmware player. In some cases the waiting time can be up to 30 minutes, in most cases the installation finishes in about 2-5 minutes.
* In the meantime, fetch your IP from the VMWare Player screen or login as root and get your IP address with the command '''ifconfig'''.
* Login to the web server to see the installation progress (it may take some minutes until the web server is up).
* Linux will restart automatically after the first time installation has finished.
* Linux install has finished.

===Hotfix Installation===
If you have already installed the latest version of the Linux Application Platform, simply download the Linux...HotfixIncremental for your platform (VM or IPxx10) or if you have missed some hotfixes, download the Linux...HotfixCumulative archive, which contains all hotfixes since hotfix1.
 
 
Upload this hotfix archive [[Reference9:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].

====Refreshing issue on installation====
You might get a PHP error when the browser is refreshing during the installation. Just refresh (F5) the page and you'll get the installation progress again.

===Static IP?===
The Linux itself '''must''' be running in DHCP client mode to run properly. If you want to assign a static IP address, do it like this:

* On an IPxx10: assign a static IP under [[ Reference9:Linux/IP ]]
* On a VMWare: assign a static IP in your local DHCP server for your MAC address defined in the *.vmx file

==Administration==

===General===

====Change the root credentials====

Here you can change the credentials of the Linux root user. 
Default password: '''iplinux'''

====Configure Authenticated URLs====

Configure credentials for authenticated URLs. These credentials will be used in automatic backups. 
You can add/remove Urls with the '''+''' and '''-''' at the right side of the list.

* URL: the URL, e.g. https://172.16.123.123/backup
* User: the user for this URL
* Password: the password for this URL

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

Default is Europe/Berlin but you can change that to a valid timezone (an error is given if timezone not present). 

====Change postgresql admin password====

If innovaphone Reporting is installed, you can configure another password for the postgres admin user. 
Default password: '''postgres'''.

===Web Server===

We use lighttpd version 1.4.28. The linux web server user is '''www-data''' and group user also '''www-data'''. Root directory for the web-server is '''/var/www/innovaphone'''. This information is mainly relevant if you plan to develope custom applications and integrate them into linux application platform.

Default users and password for the different levels on the Linux application plattform (see figure below):
[[image:Linux_Application_hierarki.PNG]]

====Change web server properties and public access to the web/webdav====
* Force HTTPS: enables redirection for HTTP to HTTPS
* Public Web Paths: these paths are not password protected, e.g. '/ap'
* Public Webdav Paths: these webdav paths are not password protected, e.g. '/backup'
** These paths are by default readonly. You can set the 'Write' flag to make the path also writable. This flag will be anyway ignored if credentials are provided. 

Enter a single '/' for a public root directory. All sub directories and files will be also public then. 
If you enter e.g. '/update/', the directory 'update' and all sub directories/files will be public. 
If you enter e.g. '/update', only the directory 'update' and its files will be public.

====Change the Linux web server credentials====

Here you can change the credentials for Web Server access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change the Linux webdav access credentials====

Here you can change the credentials for webdav access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change application access credentials====

If you have installed an application, which has the lighttpd-auth property set in its configuration file, you can configure a separate user/password for the applications web site. 
If you want to disable the separate authentication, leave the '''user''' field empty and enter the currently configured password. The authentication will be the same as the root web server authentication afterwards. 
One can just login on the application web site with this access.

A configured access overrides a configured public web path to '/apps/application-name'!

===Certificates===

The current server certificate installed on the web server is shown here. A self signed certificate, innovaphone-linux, is installed by default. It is recommended to change it with your own certificate.

It is also possible to trust or reject other certificates.

===Backup===

The web server can be configured to poll a Command File URL (on a web server). 
The backup process is similar to [[Reference9:Services/Update]]. 

An alarm server can be also configured to receive alarms during an automatic backup: [[ #Alarm_Server | Alarm Server under Diagnostics ]].

At the bottom you will see a list of the current automatic backup serials from the Command File URL and the log of the last automatic backups.

[[Image:backup_restore.jpg]]

====Command File====

Example:
saveinnovaphonecfgs http://172.16.123.123/webdav/backup/cfgs-#i-#b10.tar.gz

The available default commands are:

=====saveinnovaphonecfgs=====

Saves all neccessary configuration files (no application specific files) as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphonelogs=====

Saves all available (also application related) log files as a tar gz archive (so you should use .tar.gz as ending).

=====times=====
Executes the following command(s) only, if the specified time matches and only once per hour (independent of poll timeout value). 
Example:

<pre>
# both commands always executed
saveinnovaphonelogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-logs-#i-#m-#b10.tar.gz 
saveinnovaphonecfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-cfg-#i-#m-#b10.tar.gz 
# commands only from monday till saturday at 10am and 11am executed.
times day:1,2,3,4,5 hour:10,11
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz 
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz 
# commands only Saturdays and Sundays at 00am executed.
times day:6,7 hour:00
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz 
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz 
</pre>

* day goes from 1 (Monday) to 7 (Sunday). 
* hour goes from 00 to 23. 

You can specify multiple times commands to override the last one. 

=====Backup file name macros=====

You can use some macros for the backup filename:

* #i - will be replaced with the current IP address
* #m - will be replaced with the current MAC address
* #d - will be replaced with date/time in format Ymd-His (20110231-111010)
* #bxx - will be replaced with the current backup index, whilst xx is the maximum index

====Save configuration files/data====

Open this link to see all available files/data/logs to download them manually.

Password files for web server authentication won't be saved!

====Restore configuration files/data====

Open this link to restore all available files/data.

Password files for web server authentication won't be restored!

===Mails===

The Application Platform contains a mail client which speaks smtp (mutt+sendmail). This is used by default. 
Mail could be also configured to send mails via an external server (smtp relay).

[[Image:smtp.png]]

==Applications==

===List===

A list of all currently installed applications. 
If an application has an own web interface, you can reach it by using the application name link. 

====Uninstall====
Use the uninstall link in the list to uninstall an application.

===Upload/Update===

Here all new applications, application updates and application platform updates are installed. 
After uploading the file, the installation will start automatically and the installation process will be shown. The page refreshes until the installation has finished.

==Diagnostics==

===Logs===

Here you can view, download or clear the available log files from the application platform or from installed applications. 
You can also download all log files at once (this archiv also contains older versions from the log files).

===RPCAP===

Enable/disable RPCAP for use with Wireshark. 
A link will be displayed, which you can use within Wireshark.

===Alarm Server===

Configure an innovaphone device as alarm server:

* '''ip''': IP address of the innovaphone device
* ['''port''']
* ['''user''']: user for authentication to the alarm server
* ['''password''']
* ['''https''']: use https to send the alarm

Options in '''[]''' are optional.

Alarms from installed applications or the application platform itself will be sent to this configured server.

===Status===

View the disk usage.

===Reset===
====IPxx10====

Shutdown the application platform. You'll have to restart it over the IPxx10 gateway.

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns a xml file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference9:Services/Logging]].
 
The following scripts are used to retrieve the logs/alarms:
* logs: /ap/log.fcgi
* alarms: /ap/alarm.fcgi

So you can make the path '''/ap''' public on the ''Linux Web Server'' or you configure an authenticated URL for these files/this path on your ''innovaphone gateway''. 

If you configure an authenticated URL, don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like
https://111.111.111.111:443/ap or http://111.111.111.111:80/ap

==Use as File/VM-Server==

You can use the application platform as file server, e.g. for udpate scripts, voicemail etc. 
You can access the server with a webdav client via '''http(s)://Linux-IP/webdav''' 
Public access to certain paths etc. can be configured under the [[Reference9:Concept_Linux_Application_Platform#Web_Server | web server configuration]].

Keep in mind that the Linux Filesystem(ext3) is case sensetive. The PBX will always search for lowercase letters. If you name your file ‘greetings.G711A’ it won’t be found. You have to name the file ‘greetings.g711a’.

==Enable further Tracing==
There are different trace options, which can be enabled by calling a certain php script: 
https://LINUX-IP/trace.php?level=63

The level is calculated by the addition of one or multiple of the following trace options:

{| border=1
|| '''Option''' || '''To add'''
|-
|| TRACE_STD || 1
|-
|| TRACE_DB || 2
|-
|| TRACE_TIME || 4
|-
|| TRACE_CALL_FLOW_TOTAL || 8
|-
|| TRACE_CALL_FLOW || 16
|-
|| TRACE_PARSE_CFG || 32
|-
|}

So currently all trace options are enabled with the level '''63'''.

==Appendix==
===Creating own applications===
See [[Reference9:Concept Linux Application]]

===Tools===

====NetDrive====

[http://www.heise.de/software/download/netdrive/55134 NetDrive] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

[[Category:Concept9|{{PAGENAME}}]]

===Manual Debian Upgrade===
If you have installed one of our upgrade hotfixes and you had installed packages, which weren't included in innovaphone applications, the upgrade of some packages might have failed. You will see a warning message on your application platform. Something like:

<code type="text">
The following packages couldn't be upgraded due to missing dependencies: php5-cgi php5-cli
Take a look at our wiki to see, what you have to do now!
</code>

Now you have to perfom some actions yourself:
* make sure, your Linux Application Platform has internet access
* login with a terminal client like Putty
* start 'apt-get update'
* start 'apt-get install php5-cgi php5-cli' (list the packages of the warning message)
* delete the file /var/www/innovaphone/log/missing_packages.log to clear the warning message:
** rm /var/www/innovaphone/log/missing_packages.log

Your installation should be now up to date again.

===Configuring a new Kernel===
If you have installed a hotfix with a new kernel, you will see a warning message on your application platform. Something like:

<code type="text">
You're not running the latest kernel Image-6010-3.4.10!
Take a look at our wiki to see, what you have to do now!
</code>

To change to the new kernel, you have to reconfigure something on your device, where the CF card is plugged in.
* First shutdown your Linux (see [[ Reference9:Concept_Linux_Application_Platform#IPxx10 ]])
* Stop Linux under [[ Reference9:Linux/General ]]
* Configure the latest kernel file (currently <code>Image-6010-3.4.10</code>) under [[ Reference9:Linux/General ]] '''Linux kernel file'''
* Start Linux under [[ Reference9:Linux/General ]]

===Alarms of the Application Platform===
If you have configured an [[ #Alarm_Server | Alarm Server]], you will receive certain alarms. 
Currently, the following alarms exist:

* Disk Usage >= 90%
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

=== Configure apt-get update with proxy server ===

For setting the proxy server, declare the file : /etc/apt/apt.cond.d/01proxy

With this following line:
Acquire::http::Proxy "http://mylogin:mypass@ip-of-my-proxy:port";

==Known Issues==
===Separate authentication for innovaphone applications===
If you configured a separate authentication, it depends on the used browser, whether you have to re-authenticate on switching between the root web and the innovaphone application web access or not.

===Refreshing issue on hotfix installation===
[[ Reference9:Concept_Linux_Application_Platform#Refreshing_issue_on_installation | See here. ]]

===Kernel Update in VM Platform===
The installation of a new kernel fails and this process leaves the system unstable, not being able to install any more debian packages. Hotfix installations will probably fail.

===IP810 with Linux Application Platform V1 hotfix 11 or previous===
If a Linux Application Platform V1 hotfix 11 or previous is installed, an innovaphone firmware V9 hotfix 20 or later can not be used on the IP810. It is necessary to update the Linux Application Platform to V1 hotfix 12 or later first before updating the innovaphone firmware. The LAP V1 hotfix 12 installs a new Linux kernel which is necessary for the IP810 with the latest firmware.

===Outdated packages? Debian Upgrade?===
From time to time we will deliver upgraded debian packages with a new hotfix. As we have to insure compatibility with our applications, we won't perform an upgrade for each hotfix!

===Don't use more than one blank in your update script===

If your script looks like this you will get an error message
<pre>
Backup saveinnovaphone-reportingdb failed: curl: (6) Couldn't resolve host 'innovaphone-reporting_xx.xx.xx.xx.gz'
</pre>

<pre>
saveinnovaphone-faxservercfgs http://xx.xx.xx.xx/webdav/backup/backup-app-fax-cfgs-#d-#b14.tar.gz 
saveinnovaphone-reportingcfgs http://xx.xx.xx.xx/webdav/backup/backup-app-reporting-cfgs-#d-#b14.tar.gz 
saveinnovaphone-reportingdb http://xx.xx.xx.xx/webdav/backup/backup-app-reporting-database-#d-#b14.tar.gz 
saveinnovaphonecfgs http://xx.xx.xx.xx/webdav/backup/backup-cfgs-#d-#b14.tar.gz 
</pre>

it has to look like this script, without the blanks:

<pre>
saveinnovaphone-faxservercfgs http://xx.xx.xx.xx/webdav/backup/backup-app-fax-cfgs-#d-#b14.tar.gz 
saveinnovaphone-reportingcfgs http://xx.xx.xx.xx/webdav/backup/backup-app-reporting-cfgs-#d-#b14.tar.gz 
saveinnovaphone-reportingdb http://xx.xx.xx.xx/webdav/backup/backup-app-reporting-database-#d-#b14.tar.gz 
saveinnovaphonecfgs http://xx.xx.xx.xx/webdav/backup/backup-cfgs-#d-#b14.tar.gz 
</pre>

[[Category:Concept|Linux Application Platform]]

Reference12r1:IP4/ETH/DHCP-Server

2016-09-27T11:36:20Z

Gnd: /* Offer Parameters: */

== Offer Parameters: ==
All settings marked with a "'''*'''" are innovaphone vendor-specific settings recognized only by innovaphone devices.
{|
|valign=top nowrap=true|'''Network Mask:'''
| The (sub)network mask to be used by the client. The mask is silently adjusted to cover only ''classful'' mask for the IP-Adresses to be provided (for example, the ''classful'' mask for the class-C address 192.168.0.1 is 255.255.255.0, for the class-B address 172.16.0.1 it is 255.255.0.0).
If not specified, the mask configured at the ethernet interface of the DHCP server is used.
|-
|valign=top nowrap=true|'''Default Gateway:'''
| Standard router address (for example, 192.168.1.1).
If not specified, this will be defaulted to the DHCP server's IP address
|-
|valign=top nowrap=true|'''TOS Priority *:'''
| Two comma separated 8 bit values for the TOS/DSCP field in the IP header of UDP-RTP and TCP-signalling packets (Bit 0..2 'precedence', bit 3..6 'type of service'). The default for RTP packets is 0xb8 (RFC 3246 - Expedited Forwarding), for signalling packets it is 0x68 (RFC 3246 - Assured Forwarding). 0xb8,0x68 for example define the default values.
|-
|valign=top nowrap=true|'''IP Routing:'''
| List of static IP-Routes in form of comma separated ''Address:Mask:Gateway'' triples (for example, 192.168.20.0:255.255.255.0:192.168.1.2,192.168.30.0:255.255.255.0:192.168.1.3). Note if you have only one IP Route you need to finish with "comma" in the end, using the previous example would be: 192.168.20.0:255.255.255.0:192.168.1.2,
|-
|valign=top nowrap=true|'''DNS Server 1:'''
| Primary DNS server address.
If not specified, this will be defaulted to the DHCP server's IP address
|-
|valign=top nowrap=true|'''DNS Server 2:'''
| Secondary DNS server address.
|-
|valign=top nowrap=true|'''Domain Name:'''
| Domain name that client should use when resolving hostnames via DNS (aka primary DNS prefix).
|-
|valign=top nowrap=true|'''SYSLOG Server:'''
| SYSLOG server address.
|-
|valign=top nowrap=true|'''TFTP Server:'''
| The TFTP server address.
|-
|valign=top nowrap=true|'''Time Server 1:'''
| Primary Time server address.
If not specified, this will be defaulted to the DHCP server's IP address
|-
|valign=top nowrap=true|'''Time Server 2:'''
| Secondary Time server address.
|-
|valign=top nowrap=true|'''Timezone String *:'''
| Time zone setting according to the IEEE POSIX standard (for example, CET-1CEST-2,M3.5.0/2,M10.5.0/3).
|-
|valign=top nowrap=true|'''WINS Server:'''
| The WINS server address.
|-
|valign=top nowrap=true|'''Node Type:'''
|NetBIOS over TCP/IP name resolution method (e.g. 2 for P-node)
|-
|valign=top nowrap=true|'''Primary Gatekeeper *:'''
| The primary gatekeeper IP address.
|-
|valign=top nowrap=true|'''Secondary Gatekeeper *:'''
| The alternative Gatekeeper IP address.
|-
|valign=top nowrap=true|'''VoIP Protocol *:'''
| The VoIP Protocl to be used for the Primary Registration (User-1), one of: 
H.323, H.323/TCP, H.323/TLS, SIP/UDP, SIP/TCP, SIP/TLS
|-
|valign=top nowrap=true|'''Coder *:'''
| Coder preferences for VoIP telephones. You get additional information's in this article [[Reference11r1:DHCP client]]
|-
|valign=top nowrap=true|'''Gatekeeper Identifier *:'''
| The VoIP gatekeeper or the gatekeeper ID for VoIP telephones.
|-
|valign=top nowrap=true|'''Dial Tones *:'''
| The dial tone that is transmitted as the standard dial tone to the VoIP telephones (for example, German PBX = as German PBX, US = US dial tone, UK = British dial tone).
|-
|valign=top nowrap=true|'''Enblock Dialling Timeout [s] *:'''
| Switches on enbloc dialling for VoIP telephones.
|-
|valign=top nowrap=true|'''Faststart [0|1] *:'''
| Faststart 0/1 turns off/on the H.323 Faststart procedure. If this option is not defined the default (on) applies.
|-
|valign=top nowrap=true|'''Tunneling [0|1] *:'''
| Tunneling 0/1 turns off/on the H.245 Tunneling procedure. If this option is not defined the default (on) applies.
|-
|valign=top nowrap=true|'''Local Networks *:'''
| List of local networks in form of comma separated ''Address:Mask'' pairs (for example, 192.168.1.0:255.255.255.0,192.168.2.0:255.255.255.0). For VoIP Calls that end up in a local network the device will try to use the coder preferred for the local network (as provided in the Coder option or defined locally).
|-
|valign=top nowrap=true|'''Language *:'''
| The language to be used as default language on a VoIP Telefone, one of the shorthands: 
{|
|Shorthand || Language
|-
| ger || Deutsch
|-
| eng || English
|-
| frn || Française
|-
| dut || Nederlands
|-
| ita || Italiano
|-
| esp || Español
|-
| swe || Svenska
|-
| dan || Dansk
|-
| nor || Norsk
|-
| fin || Suomi
|-
| cze || Cestina
|-
| est || Eesti
|-
| por || Português
|-
| lat || Latvieðu
|-
| cro || Hrvatski
|-
| pol || Polski
|-
| rus || Русский
|-
| slo || Slovenija
|-
| hun || Magyar
|}
|-
|valign=top nowrap=true|'''Dialling Location *:'''
| Defines the various PBX access numbers on VoIP telephones for directory access. This character string must contain /cc, /ac, /ntp, /itp, /col and /pbx options. The "Max Internal Number Length" is optional and coded with the tag /len. A valid string may look like this one: <code>/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 7 /len 3</code>.
|-
|valign=top nowrap=true|'''AM/PM Clock [0|1] *:'''
| Enables/disables the English time format for VoIP telephones. The German time format is displayed as standard: "dd.mm.yy hh:mm, 24-hour clock." If a 1 is entered in this field, the English time format "mm/dd hh:mm xm, 12-hour am/pm clock" is displayed.
|-
|valign=top nowrap=true|'''LDAP Directory *:'''
| To allocate a functioning LDAP configuration to all VoIP devices integrated via DHCP, a configuration character string can be entered in the LDAP Directory field. You obtain this configuration character string by executing the following command in the browser of a configured device: "<IP-Adresse of the VoIP device>/!mod cmd PHONE/DIR ldap-config". When this command has been executed, a configuration character string is output in the browser, which you copy and paste into the LDAP Directory field of the DHCP server. In this way, all further devices are given a correct LDAP configuration.
|-
|valign=top nowrap=true|'''Update Interval [min] *:'''
| All devices integrated via DHCP are assigned the interval specified here in the Interval [min] field of the update server (see chapter entitled "[[{{NAMESPACE}}:Services/Update|Services/Update]]").
|-
|valign=top nowrap=true|'''Update Server URL *:'''
| All devices integrated via DHCP are assigned the URL specified here (for example, <nowiki>http://192.168.1.2/update/script.htm</nowiki>) in the Command File URL field of the update server (see chapter entitled "[[{{NAMESPACE}}:Services/Update|Services/Update]]"). An automated update of the devices is thereby ensured.
|-
|valign=top nowrap=true|'''802.1q VLAN ID *:'''
| The configuration at the switch must be observed for setting the VLAN ID. An empty 802.1q VLAN ID field (16 bit) assumes the value 0. The VLAN ID with the value 0 switches QoS (Quality of Service) off according to 802.1q ab. If the switch at the port to the innovaphone device happens to be configured to a different VLAN ID, the same value must be specified here to allow a prioritisation from the Ethernet. To be able to distinguish between the VLANs, the Ethernet packet is extended by 4 bytes, of which 12 bits are intended for the inclusion of the VLAN ID, making 4094 VLANs possible (VLAN ID 0 and 4095 are reserved or invalid).
|-
|valign=top nowrap=true|'''802.1p VLAN Priority *:'''
| In the 802.1p VLAN Priority field (3 bit), the associated VLAN priority level (a value between 0 and 7) can be specified, in order that voice data is given priority forwarding, for example.
|-
|valign=top nowrap=true|'''STUN Server *:'''
| See [[{{NAMESPACE}}:IP4/General/STUN]] for the format.
|-
|valign=top nowrap=true|'''TURN Server *:'''
| See [[{{NAMESPACE}}:IP4/General/STUN]] for the format.
|}

Reference10:Concept Voice Recording 2014

2016-07-07T16:13:42Z

Gnd:

== Introduction ==

The innovaphone Voice Recorder application allows recording while the innovaphone Player application a comfortable search and playback of phone calls.

All kinds of calls can be recorded:

*Incoming calls

*Outgoing calls

*Calls from innovaphone IP Phones

*Calls form 3rd party IP-Phones

*Calls from IP-DECT phone sets

*Calls from analogue phone sets

*Calls from with mobile phones (mobility, forking)

*Calls done on a legacy PBX (soft migrations scenarios)

The records are stored in a first step on the Conpact flash or webdav server and processed then form the recorder tool.

Voice recording can be done on a logical or fiscal gateway (BRI, GW, SIP etc.), and therefore all kind of audio traffic can be recorded. Technically spoken a gateway is doing media relay and writes the audio data to the webdav or CF.

The second way to record is recording directly from the innovaphone IP-Phone. In this case the phone itself writes the audio data to the CF or webdav server.

See the “Scenarios” for further details.

The solution requires an innovaphone PBX, the reporting tool and two applications;

*a recording tool described in this document called “Recorder”

*a search and playback tool called “Player”.

The usage of the Player is not part of this description, a separate localized help and user manual is available.

While the recorder (this description) has to be installed by professionals and the maintenance is done by system administrations people (and therefore English wording and this description is good enough) the player is operated by End user and may be not digital native, skilled or knowledge base workers.

Note also that the setup of the player is a typical admin job and not described in the player manual.

IMPORTANT: All users that should be recorded need the REPORTING! We recommend reporting for all user, see chapter “Requirements” for further details.

== Requirements ==
As webdav server just the innovaphone webdav server (on a GW or IPVA) is supported.

The recorder use HTTP and HTTPS access and not a webdav protocol to access.

===PBX===
You require a PBX version 11 or higher.

===Reporting===

The recording feature requires the innovaphone Reporting. Please update your platform to the latest Hotfix. Minimum Build 10043 is required.

At least any user that should be recorded must have the reporting. If user will generate pcap files (do a recording) it is recommended that also those users should have a recording; generally we recommend that all users in the PXN should have the recording on. Here is why: if the recorder found a pcap file (an audio file) he will “ask” the reporting about the involved users. If the reporting has no information (because those users have no reporting) the answer will be a “not found”. Therefore the recorder will try later on more times to found the record in the recording, all that will slow down the entire system.

=== Recorder ===

This document describes Build 10089. Please note that from build 10084 on no more drive mapping is done and 10089 supports https.

The recorder application requires a PC or server with Windows OS Win 7 or higher, also windows server 2008 (Windows 2003 server not tested) or higher is supported.

Disk space: One minute of conversation requires about 1 MB of memory.
The stores voce data is not PCM but a G.711 format in a wave container. PCM require much more disk space and is not used for storing. The audio files can also be encrypted. Encryption would double the required disk space. The recorded conversation is a stereo file where the external caller is on the left channel whiles the internal one in the right channel. It is possible down mix the conversation to mono; this would save about 50%. It is also possible compress the audio data to mp3.

The following table shows the required disk space for one minute of conversation:

[[Image:RecSetup07.png]]

Example: 500GB Hard disk, mp3 compression without encryption -> 1.389 days = 3,8 years of conversation

No particular memory or CPU speed is requested, standard editions are quite good enough. Invest better in a good quality because in professional environments those machines have to work for many years.

Voice recording requires a Version 11 innovaphone PBX and a actual Build of the Reporting tool. No compatibility with older versions is possible. PBX and/or Reporting can run on a gateway as well as on VMware.

The recording of the pcap file is done by the PBX firmware and requires a Compact flash or a WebDAV server. The recorder software will detect those records and copy them on the real storage path. Therefore the storage requirement for the CF/WebDAV not real high (but remember always 1 Minute =1 MB, so if you must record 30 conversations for 30 minutes = 900MB).

Voice recorder and Player could run on the same PC as well one single PC can also be used for the reporting, recording, playing and webdav server (and PBX if you like). So anything on one server is theoretically possible.

The two extreme setups are:

*innovaphone PBX on the GW, reporting on the GW, pcap recording on the CF, recording application on a PC

*innovaphone PBX on the PC, reporting on the PC, pcap recording on the PC, recording application on a PC

Each combination between is possible.

Remember that the CF is a relative slow drive, you will note this if you copy a file from the CF to the local HD of your PC. Exact this file copy is one of the task of the recorder, even a critical one (so not a good idea do anything else in between). The result is that the copy of a huge file (a long conversation) or many files will virtually froze the recorder software. In reality the recorder is just hanging around and waits that the file copy is finally done. So a recording on an external webdav server will solve this, but the CF has the nice flair working even if all PC’s are down. Take your choices and live with them.

Require Framework 4.5.

=== Codecs ===
Recording can only be done in G.711 or G.729. Calls with different codes (e.g. G.722) will still be recorded, but no wave files will be converted!

=== Player ===

The player application requires a PC with Windows OS Win 7 or higher, the Mediaplayer is necessary. All that on a standard office PC is installed and you have to do nothing in particularly.
Require Framework 4.5.
In theory also a Windows server 2008 could host the player, but in the server versions the media player typically is not installed and there are also different DLL missing. So if you have time or you are well Microsoft server trained face also that if necessary (normally not).

In theory it should work on any CPU, the Player was tested under Win7 32BIT, Win7 64Bit and Win8 64Bit.

===License===

The license model is based on user, so for each user to record a license is required.

The current implementation allows a recording of objects of type user or executive. Recordings on other objects will be discarded.

So in short: Per recorded user or executive object you need to have
* one recording license
* one reporting license

In start-up the recorder will read out the number of recording license in the PBX. After that the recorder will read out all users and check if a user is in the recording group (defined in the recorder setup). If a user with that group is found one license is counted down. If there are no more license but user in group detected they will be skipped. The recorder shows how many license where detected in the PBX and how many user are in the recording group. If there are more users than licenses a warning is show.

Remember that just users in the recorder user table are recorded; all other records are automatic deleted! This can be usefully if for example for internal reasons not just the user to record passes through the recording gateway but also others; not being in the group the records will be destroyed. But of course this will cause senseless PBX CPU workload because a recording anyway is done, just the recorder will delete after the files.

=== Legal Aspects ===

Please take extremely care about the legal issue: in most country voice recording of telephone calls is forbidden and persecuted by law as a crime. In some country it is legal in certain circumstances, for example you have to inform the caller that the call will be recorded. That can be done automatically (using for example a waiting queue) or “manually”, telling the far person that this call will be recorded. Of cause also this announcement should be recorded. In some country recording is legal without any announcement for certain services, for example in case of emergency calls or calls to the police. In most country authority like the secret service do not really care about all that stuff and do what they want, but this is probably not your case.

So inform yourself and the customer about the local legal situation. Using the recording tools is on your own risk and innovaphone will not take any responsibility, even not for eventual malfunctions. See also our general trading terms, valid even for this solution. If you have any doubt about legal questions in using voice recording; don´t do it, don’ use it!

== Feature list ==

=== General ===

• Using an innovaphone IP-Phone set immediately after call end the recording can be listened using the phone. One feature key stroke and the conversation is reproduced and repeated endless (auto replay). This call can also be transferred or put in a 3 party conference (immediate sharing)

• Online Help and tooltips for application and setup

• Setup password protected, setup files are encrypted

• Recorder in Demo Mode (20 minutes) , Player for free

• Many recorder in one system and unlimited number of players

=== Recorder ===

• Recording of any type of calls direction

• Recording of calls from any device: IP-Phones (innovaphone and 3rt Party), analogue phones, GSM (mobility), IP-DECT

• Recording of calls from/to legacy PBX (smooth migration)

• Recording can be done in a logical gateway or direct from a innovaphone phone set

• Recording of encrypted calls

• Standard and thread call recording. If thread call recording is on after a settable time period (for example 5 minutes) a call will be automatically deleted. If the user calls inside the time period a code the last call will be saved. This marking to keep the recorded call can be done from any type of phone. If the phone is a innovaphone IP Phone the marking can be done also during conversation

• Storage of all relevant data including the time to answer for each call

• Detail protocol of each call, documentation of the entire call flow, not just the recording period but even previous and following one. Detail report on all call situations, transfer, call forwarding, pick-up, group call, conference etc. Also calls in waiting queues or announcements are reported with second accuracy

• Encrypted protocol data

• Display number of channels in recording with start timestamp

• Error and Event log files

• Email alert in case of master alarm

• Automatic backup (copy to mass storage archive)

• Automatic delete of records older than 2-99 month (not on archives)

• Recordings are saved as wave files, can be reproduced with any player

• Wave data integrity supervision

• File name contains primary data (Timestamp, Caller and called, direction, time to answer, UID)

• Counter of recorded conversations

• Data Link to player, remote control of the recorder from player

• Interface to external applications, via TCP or URL, recorder provides data for later retrieving. Player can be controlled sending commands to the recorder (3rd party)

• Mark record during a conversation on the IP-Phone (build 1077)

• Https from Build 10087 on

• Slave sites from Build 10089 on

=== Player ===

• Integrity of the recorded wave files are recognized and displayed

• Agent note, a Player displays automatically agent notes and can add text notes to each call

• Integration with iQM server, display of missed calls, possibility to recall immediately

• Naming of Players

• Month and Day filter

• Filter for internal and external number with wildcards

• Filter for incoming and outgoing calls

• View of oldest or newest call on top

• SOS mode can be switched on/off with just one click. If on all unnecessary key are hide, the newest calls are displayed on top of the call list and filters are switched off

• Selection of calls, one single call, more single selected calls, from to, all

• Online search and display, can be switched off

• Copy, move and delete of calls

• Move and delete operations are logged in centralized manipulation log

• Permissions

• Multiple selected calls can are transferred automatically in a playlist and can be reproduced

• Display record size

• Display number of records in playlist and actual play

• Jump forward and backward in playlist

• Jump to next/previous title in search result list if playlist contains just one record

• Marc record in playlist, select actual record and clear all others

• Play one title after the other in playlist

• Play a beep if record change in playlist (loop playlist)

• Repeat play (loop record), up to 4 positions, stored automatically

• Repeat play of all stored memory positions

• Display internal and external number with name resolution

• Display timestamp, time to answer an call ID

• Display System and Player status

• Display if local remote control interface is on

• Display of play was forced be recorder remote control

• Keys for Stop, Play, Fast Forwarding, Rewind, Pause and Eject

• Display duration record

• Display elapsed time or count down, switchable

• Original time elapsing display

• Progress bar adjustable, direct jump to selected position, drag and drop

• Start and Stop position can be marked an played in loop (selection loop)

• Volume control with audio meter and peek indication

• Delta level Indication (L-R and R-L meter)

• Overflow level audio meter

• Enhanced sensitivity for audio meter

• Attenuation left and right channel adjustable

• Audio setup can be stored and recalled

• Audio level at maximum

• Levels are stored and set on restart

• Level meter with peek indicator for left and right channel

• Mute

• Large additional display with call details

• Automatic decryption if files are copied

• Player can be limited to display just calls of one extension

• Communication with recorder, display of link status, last master alarm and channels in recording

• Reset recorder from player

• Search an play on backup directories

• Operate as Media player, reproduction of audio format wav, mp3, wmp and video format avi, wmv, mp4 and mpg

• 1rst and 3rd party remote control

• Document security, manipulation is detected and displayed

• Browse last played records (build 1071)

• Browse marked records on this player (build 1071)

• Browse marked records in a system wide available directory (build 1071)

• Mark records on player and for system wide access (build 1071)

• Copy records marked in a player to the system wide available directory (build 1071)

• Write a central log for all player listening’s (build 1071)

• Work over http connections (build 1074)

• Limit view to a list of extensions (build 1077)

== Scenarios ==

The recorded files are in a wave format and can be played with a normal Mediaplayer, the delivered Player allows additional features.

The recorded records are stored in an indicated path and a copy of the records can be done automatically.

Errors and events are stored in a log file and alarms tracked; a mail can be send if an alarm occurs.

It is possible to limit the duration of the storing period; older files will be deleted automatically. This is to avoid disk full errors, keep in mind that this kind of systems usually works unattended all the time.

The number of player and recorder is unlimited.

=== Recording on a central point ===

Recording is possible on each logical Gateway and therefore on external lines (ISDN, SIP or H323 Trunks). In theory “external” is just a convention, even internal calls passing through those gateways could be recorded, but this is more a theoretical issue. An innovaphone gateway can also be used as a “recording” bar and introduced between a legacy PBX and the PSTN. Remember anyway that the innovaphone PBX must be activated and the Reporting tool is required.

Being recording defined on a logical Gateway opens different options, for example activate recoding just for a dedicated route. For example just for incoming calls or just for some outgoing calls. Typical examples for such a setup are business and private calls, where just business calls should be recorded. For example if a call is done using “0” as prefix recording is done, using “9” not.

Or normally (“0”) no voice recording is done, but if a user access to a trunk with a particular prefix (“9”), recording is on. This for example is widely used in selling contracts by phone (like mobile phone carrier do); they call the customer and if the customer agrees in the commercial proposal to extend or to “sign” the contract they will call back the customer again using another prefix and record now the conversation.

Recording rules can also be executed automatically because configured in the gateway setup. For example you can exclude certain user from recording or vice versa, doing recording just for some users. For example all calls to the financial operators are recorded, all other calls not. Or all users are recorder but the management not.

All that is a question of setup in then innovaphone gateway (and PBX) and not described in detail in this document, being standard features and described in many other articles (and being part of the advanced technical training).

Please note that recording starts when a connection is established and terminates when the connection is terminated. That means that eventual waiting situations in waiting queues, music on hold sequences calls etc. are recorded too.

Keep in mind that each extension that should be recorded must be active in the reporting, means require a recording license. Even if you operate a soft migration you must go up in the PBX to a dummy user with reporting on and back again down to the relay.

Notes: Recording can be done just in G711A or G729 on a logical gateway as endpoint. If you want record internal calls in this way calls must always transit a logical gateway (with the media relay flag on).

=== Recording with the IP-Phone ===

Recording can be done also directly from the innovaphone IP-Phone.
If switched on all calls from and to this phone are recorded, there are no recording rules. Calls could be stored in different files, because a new call means also a new file. If for example a phone put on hold a conversations and establish a second call this second call will be stored a an separate file.

Doing voice recording using the IP-Phone or using a Gateway has advantages and disadvantages; it depends on your point of view and the scenario.

Here some issues to remember:

Recording on a gateway is like the old “ISDN Recording”: anything passing that interface is recorded. That has the advantage that any type of endpoint (IP, 3rt party, Dect, analog etc.) will be recorded. The disadvantage is that internal calls are not recorded. Also the CPU load of the PBX will rise while recording with an IP-Phone has nearly no influence.

Recording directly from the Phone has the limitation that just innovaphone IP-Phone are able to doing that. Only innovaphone IP-Phones IP2x2, IP111, IP241 and IP240A with bigger DRAM (http://wiki.innovaphone.com/index.php?title=Howto:Upgrade_IPxxxA_to_support_more_DRAM_Memory) can performing Voice Recording directly.
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).

In the V11r1 IP recording on the phone can just switched on or off in the setup, not from the user. In V11r2 recording can switched on and off by the user (similar to the 3party version).

'''Note''': The recording described here does not require a phone 3 party conference; therefore a 3party conference is possible on the phone while Voice Recording 2014 is running.

== Recording Modes ==
=== Standard Recording ===

Operating in the “Standard Recording” (STD) mode recorded calls are converted and saved after the call has finished.

Note: A recorder canoperate just in one mode (for example "Standard"). Mixed scenario are possible but require two or more recorders, the setup in this case has to be done very carefully.

=== Thread Call Recording ===

Operating in the “Thread Call Recording” (TCR) mode only marked calls are converted and saved, all other calls are deleted automatically.

A call can be marked manually from the user or automatically from his innovaphone IP-Phone. A call can be marked during the call or after call, but within a defined time period (for example until 5 minutes after the call-end). Not marked calls are deleted while marked calls will contain the entire call, so from the beginning on (even if marking is done during or after the call).

Marking calls during the conversation can be done only using innovaphone IP-Phones while all type of phones can mark a call after the conversation. To mark a call after a conversation the user must call a XML object.

In a typical setup the user will hear a confirmation if he is marking a call, something like “the last conversation was recorded and will be saved” or similar.

If marking is done using an innovaphone IP-Phone during the call (pressing the redial key) audio or no audio can be played. For example an automatic advice like “this conversation will be recorded” or similar can be played.
==== Setup TCR ====

This paragraph discusses the different setups and aspects for Thread Call Recording. If you are not interested in those details skip it.

TCR require a XML (TCRec.xml included in the software package of the Last call recording feature, see Related Articles, see Related Articles, go to the article and follow the download [http://download.innovaphone.com/ice/wiki-src#lcr http://download.innovaphone.com/ice/wiki-src#lcr] ), you have to create a sub-directory TCR in your PCAP recording directory and copy the xml in, create a VM-Object in the PBX and insert those parameters in the recorder setup (TCR panel). Example: Your PCAp directory is http://172.16.88.98/DRIVE/CF0/REC, therefore the directory create is is http://172.16.88.98/DRIVE/CF0/REC/TCR. The XML can be called directly or using the recording functions on the innovaphone phones. If called directly the xml will play the audio file Track1.g711a, if called through the recording function of the IP-Phone the file Track2.g711a. If the files are not present the user will hear nothing. A solution for the confirmation could also be to play just a “beep” if calling directly the xml. You could copy the beep.g711a file (for example from the VM) and rename it. A better option is record them using the universal track recording tool, see related articles at the end iof this page.

Some additional information if you use the recoding function of the innovaphone IP-Phone:
Keep in mind that this function will not really recording the voice but just calling the XML (the recoding is done by the Gateway or the phone, but directly and not using this function). As explained the XML will play the file Track2.g711a if present, but to hear the announcement you have to use on your phone at least version 10.0887 or higher and switch on the flag “Two Way Media” in the Recording section of the phone setup. The rest is the usual one, if you setup “Mode=transparent” each call will flagged as “to record”, if Mode=manual you have to press the redial key to flag. No problem if the user presses more than one time the record key, just the actual call will be recorded.

The xml itself will terminate after playing the Tack 1 or 2, delayed for 2 seconds. If the user press the redial key in this way he will see in the display of his IP-Phone appear “Recording” for 2 seconds and has a feedback (even if no tone is played) that the conversation is flagged to record.

=== Random recording ===
The recorder can work in this mode also as an alternative to the Standard- or Threat call recording. Random recording will record just a sample of calls on normal Agents (User), typically for quality check purposes.

The system allows record just each x call where x can be set in the setup. The system can even record just each y call for an agent. Only “to recording” calls are counted, not calls in general.

Example: “Record in System just each 3. Call”’: the system will store one record and then skip the following 2 one.

Example: “Record for a Gent just each 2. Call”: for each agent one call will be recorded and one not.

Both setups can be set isolated, but combined (3rd in system and 2nd for a agent) the system will first skip 2 calls and then for the specific agent skip each 2nd one.

Calls typically are not foreseeable especially if they are more agent involved and therefore it is for a single agent a “random” recording.

This feature requires build 1071 or higher.

=== Manual/Transparent/Optional recording ===

V11r2 (in the Phone) is required.

If the recording is done using a innovaphone IP Phone there are 3 recording modes possible:

- Manual: the user switch recording on/off using a Feature key

- Transparent: recording is always on

- Optional: recording is on by default but the user can switch it off using a feature key

The manual and optional mode is widely used because the operator can switch on and off recording during a conversation. For example if the customer want to buy the operator starts recording and give the advice that from now on the recording is on (by the way: that can be played also automatically modifying the [[Howto:Last_Call_Recording|last call recording]]). Switching off recording is usefully also if for example during a conversation a secret info (like a password) is stated and should not be recorded ad all.

The Recording link (url) to the Webdav or CF is defined in the user setup:

[[Image:RecSetup08.png]]

The mode is selected in the "recording" section:

[[Image:RecSetup09.png]]

Note: The recording described here does NOT require a phone 3 party conference; therefore a 3party conference is possible on the phone while recording is running.

== SRTP ==

Recording of encrypt conversation is possible, no particular setup is necessary, the system will decrypt automatically the media stream and store the conversation in unecnryptet wave files for further processing.

== Last Call Recording/Repeat ==

See relative article.

Do not confuse this feature with the Instant Play (rescue mode) feature of the innovaphone Player.

== Overview ==

The recording itself is done by the innovaphone gateway. In each logical gateway a recording path can be configured as a URL; that means that the voice will be recorded in a file, this file can be on a compact flash or on an external WebDAV server. The recorder application copy the recorded file, read out the reporting, combine both, and rename the file. The original file on the compact flash/WebDAV is deleted. The new filename is formed using date and time, caller and called user, direction of the call, the time to answer (ringing time) and the unique ID number. The recorder converts the file from pcap to the wave format and stores the converted file in a directory. If requested a copy of this record can be saved in a second directory (for example a SAN or NAS disk area). A maximum number of storage time expressed in month can be defined, older files will be deleted automatically. In this way no disk space overflow will be in unattended systems. Parallel to the payload (the wave voice file) also a XML file containing the reporting data is created, the name of the file is the same than the one of the voce and just the extension is xml instead of wav. That is basically what the recorder is doing; copy and convert recorded files, retrieve data from the reporting, renaming of the files and copy them to different destinations as well as keeping track of history.

The player allows searching and browsing of records, show the oldest or newest first, can filter the search etc. For example it can be displayed calls in any direction or just incoming or outgoing calls, or calls from a certain number or to a certain number, using even wildcards for quick filter options. See relative description for details. Once the calls a displayed they can be marked using windows usual methods (one, many, all, range, etc.). The marked files can be copy, past, deleted or played in a playlist. A record in the playlist can be marked and the player allows the usual operations of a windows media player. Looping and audio signal before playing the next record in the playlist is included as well as moving inside the playlist from one call to the other. If all that sounds complicated calm down, it is quite simple in using and designed for “users”.

The player can even operate in a mode called “rescue mode” or “direct play mode”. If switched in this mode the latest record is always on top. This is a typical requirement for an emergency center operator, he is interested in replay the last or lasted recordings in a quick and simple mode.

The player shows also the reporting details and generally the most important data of the conversation. If recorded files are copied also the relative reporting information is copied.
Many player can be installed and work in the same moment in a scenario, while the recorder typically is just one. So the recorder is a kind of server and the player a kind of client. More recorders can be installed in a scenario and if necessary a player can be installed on the same PC where a recorder is working. Being the recorder always on usually it will be installed on a dedicated machine doing just that located in the server room.

But remember that the recording job is done as described by the gateway. So even if a recorder application is switched off voice recording is done. The idea anyway is not that the recorder is switched off and just sometimes switched on to retrieve the files. But if you must shut down the application or reboot or enter in setup, no data will lose.

The following diagram shows the logical interfaces between the innovaphone voice recorder, the innovaphone player and the rest of the equipment.

[[Image:Player07.png]]

(*) = Option

The player main data source is the disk where the records are stores. There could be active many player at the same time, and in theory also more than one recorder. One player could monitor just one recorder, but it is possible to start more player on the same PC.

== Installation Step by Step==

In this and many other wiki articles everything you need to install and operate the product is (hopefully) described. Partners some time have the problem that they could not find a logical flow in the description and the do not realize what is important and what interesting, but not essential.

To help here a simple step by step instruction, all details and comments are in the other paragraph and, of course, in other articles.

1. Check the Software version of your PBX, it must be 10 or higher otherwise do an upgrade or forget this recording. Your PBX must be up and running and to test you need at least 2 Phones.

2. Check that you have a valid license for the recording, if not just a demo-mode is possible, after 20 minutes the recorder stop and you have to restart him again.

3. Your CF should be working fine, create a directory to buffer the pcap files (for example http://123.123.123.123/DRIVE/CF0/IF_REC).

4. Setup the recording gateway, see http://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/System_Setup#Gateway_Setup . If you want to do a test with internal phones you have to assure that in call from one user to the other this gateway will be involved. Create for example a access code to this GW and flag Media-Relay. If you call this access code followed by the internal number ths should happen. Of course if you have a real trunk the you will do all that using the relative GW. At the end of the story your call must passing the recording gateway, check it; open you PBX interface, click on gateway and calls: you should see that the call goes through the recording GW. A pcap file will created at the CF directory indicated in the setup of the gateway (the same one you create in pass 3).

5. Start up the reporting (on a xx10 GW or IPVA), it must be up and working, you should be able to see the reports of the call done using the recording gateway.

6. Create SOAP user, a blank empty user object called SOAP (or _TAPI_ or _whatever_)

7. Create a root directory where the recorded files should be stores (for example “c:\mytest\” or “G:\myExternalDrive\”).

8. Start the application and open the setup.

== Installation ==

While the Recorder works “hidden” for the user, the Player has a huge user interface. The Player is typically installed on one or more PC of users. Therefore for the Player more effort to design a foolproof interface was done. The Player description is available, please check the relative section in the innovaphone Wiki.
Recorder and player applications are single executable file. The setup is stored in a xml file located in the same directory where the application is running; no registry entry is done; if you delete the directory where the recorder/player is in, the application is de-installed. If you like install on the same computer the recorder and the player application you have to create two different directories and copy the applications twice. Automatic execution is possible inserting in the auto start directory the recorder application.

Please note that the setup file is in xml format, but his content is encrypted.

The installation tool will copy all reqired files, if you install manually copping file note the following issues:

If you install a recorder application manually you must copy the “pcap2wav.exe” utility in the same directory!

Note: This utility “pcap2wav.exe” can be downloaded in the V7 application folder, access to a directory and download the “tools” Zip file; inside you will find the pcap2wav.exe.
The recorder is not a service because there is a full user interface available. To ensure that the recorder starts up even after a boot put the application in your autostart folder. In the setup an option to start up minimized is available.

Before starting the recorder application check the following items on the recorder PC:

*the directory where the recordings should be stored must be visible and it must be possible to create subdirectories, try using the file explorer

*If backup is requested also a write access to the backup path must be possible (but it is not necessary to be able create subfolders).

*Access to the reporting tool must be possible, use a browser to check

*The access to the CF (or the WebDAV server) must be possible, try to map a drive and access to the directory where the pcap files are

Do the setup the innovaphone PBX, the gateway and the reporting.

See eventually also http://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/Setup#Recorder_Setup for a better understanding of the requirements.

If you do now a call which has to be recorded this call must be logged in the reporting tool and a pcap file must be created in the indicated url path. Go only ahead if that is up and running.

Now start the recording software and open the setup and set the values. An online help will explain the single parameters. Maybe it is also a good idea reading first the rest of this article.

The installation of the Player is similar just simpler. After installing start the application, enter the setup and that its. But it has no sense install or setup a Player without before having a working recorder.

On a single PC multiple Recorder and Player can be installed, simple install and run them on different directories.

=== CPU load ===

The power of the innovaphone CPU on the different gateway models is high enough to ensure the recording of all ISDN cannels (or the same number of SIP/H323 Trunk) on that gateway. If recording is done on a CF the innovaphone PBX CPU will be involved also in the copy operation (if recording is done on an external WebDAV server no CPU load of the PBX for copy is required). After the copy operation no more CPU power of the PBX CPU is required.

The reporting CPU (which is anyway the second core in case of a gateway or a separate CPU in case of VMware) has some small workload because the recorder checks each 5 seconds the reporting.
Using the player will cause no workload for PBX, reporting or recorder CPU, so just the local workstation CPU power is require. Therefore the number of player is practically insignificant for any CPU load.

=== Logging ===

Recorder and the Player applications write an individual error log, this log is a text file and stored in the same directory where the application is. See online help for file names and description of the other files used by this applications.

The recorder can also write a trace file; if tracing option is switched on all operations of the recorder are logged in a file named “iREC_sys_log.txt”. Please not that this files become very large if the option is always on, and this file will not be deleted or resized automatically. The idea is not to keep on tracing all the time but to switch on the trace during the first period or in case of trouble checking.
If enabled in the setup the player stores all special operations in a central log file. All copy, delete and move operations done using the player are in this way stored automatically in a central log file.

A “user operational” log file is in a central point and unique for all players installed. Here all user manipulations done using the player applications are reported, so copy or delete is traced. This file is named “iREC_Player_log.txt” and located in the “\TMP” subdirectory of the root recording directory. In this way all operations of all Player-User are visible at a glance in one single file.

=== Security ===

The setup of the recorder and player is stored in an AES encrypted setup xml file. Therefore the user cannot manipulate or read out setup values. The access to the setup can be protected with a password. If a user deletes the setup file the software assumes that this is a new installation and allows access to the setup without password. If the user enters the correct path for the recording the software read out a centralized password and it is not possible to save the setup without that password. There is no way to read out or decode the password and this means that if you, as administrator, forget the password you have to clear the centralized password and the setup of the recorder and re-configure all. Try to avoid that situation and remember your password.

The centralized password is in the located in the “\TMP” subdirectory of the root recording directory and named “SPlayer.xml”. It is also encrypted of cause.

The Reporting xml data string is even encrypt.

In the first column header of the player a looked/unlooked symbol is displayed showing the encrypt/clear file mode. If (using the player) a encrypt records is copied it will be automatically decrypt, while moving a file (cut and paste) will not change the original file mode. In this way a clear copy of a xml can be done from an authentic encrypted data string.

=== Date ===

As most application also the recorder requires a correct date and time. But also the PBX Date and time must be correct and the same as the one on the recording PC.

Basically obviously, writing a file all file data should be correct, and also the CDR ticket data should.

So verify that both, PBX and PC have always a correct and synchronized date and time.

== Voice Recorder operation ==

The recorder can operate in 3 layouts; minimized in the taskbar, viewing a small window or an extended panel.

[[Image:RecE111B1.png]]

Switching between small and large view is done pressing the “>” key, press “_” for minimize.

=== Start up ===

During start up the basic operational parameter are checked while the master alarm is disabled. The master alarm supervision is just switched on after about 20 seconds. This is necessary because sometimes network operation during start up fails, but becomes up in a second attempt. The sequence of testing is done by design and the software will not proceed in operation if a parameter fails but continuously try to fix it.

This initial health check during start-up is done in the following order:

*checking setup: try to understand if the setup parameters are reasonable.

*checking reporting: pings the reporting, if ping is o.k. try to load a dummy page. If ping or dummy fails the “REPORTING” lamp is red, error message “Reporting Link failure” is viewed.

*checking to access to the recording directory (url): try to read out the indicated path, if fails “PCAP” lamp is red, error message “PCAP directory access fails” is viewed.

*checking if access to the storage path is possible: If reading fails the “DISK” lamp is red, error message “Store path fails” is viewed.

If in the setup no backup path is indicated this last task is skipped and the Backup lamp is grey. Otherwise the access to the path is tested, if access fails the “BACKUP” lamp is red, error message “Backup path fails” is viewed.

If a test is passed the relative lamp becomes green. If after start up 6 lamps are green (or 5 green and one grey) everything is working fine and the message “Normal Operation” is displayed in the System status line.

After 20 second the Master alert supervision is switched to active, an eventual error causes a Master Alarm (see relative section).

=== Normal operation ===

The check counter shows you how many times the recorder reads out the recording directory and checks the reporting. As you see al 5 seconds a reading attempt is done, if data are found further processing operation will start. This counter goes automatically to 0 reaching 9999 and shows you that the software is working and checking but has no further signification.

The counter “Channels in recording” shows you how many recordings are ongoing. The panel shows you the ID of each recording file and the initial recording time. In this way you can see how long a call is jet in recording.

If the call ends it will disappear from the list. If there are more records then default lines a scroll down will automatically appear.

If you click the innovaphone logo the software version is displayed. The version is also displayed in the headline of the setup.

===Extended view ===

If you enlarge the window with the “>” key two additional panels appears.

[[Image:RecE111B2.png]]

The left one shows the regular normal operations, the right one the errors and basic messages (like Start-up). The messages displayed of the error panel are stored automatically in an error log file while the messages of the status panel only file if that is enabled in setup. Both windows can be cleared pressing the relative button. This clearage is just an “optical” issue; no file is deleted or similar. Both windows shows up to 100 entries, if entry becomes too large a scrollbar appear automatically. If “full” the oldest message will be cleared. On top the error panel can also display the last 30 Error reading out the error file.

Pressing the “<” key the windows will be resized again.

There is no operational difference between the different layouts. The recording application starts always with the small window stile.

The following picture shows two alarms, Reporting (because there where files without CDR records) and Software (because there was a license overflow).

[[Image:RecXX.png]]

=== Setup ===

Open a separate window, see relative online help.

http://wiki.innovaphone.com/index.php?title=Reference10:Voice_Recorder/Setup#Recorder_Setup

Note: during setup the recording timers are disabled, this means that no normal operation is done. For normal operation the setup must be terminated (with or without saving).

=== Alarms ===

[[Image:VR011.png]]

About 20 seconds after startup, and always during normal operation, alarms are detected from a particular master alarm routine. Some alarms are self-healing, others not. If an alarm occurs the relative source is switched from green to red, if an alarm disappears from red to green. You can simply test is, just shut down the reporting during operation and you will see that the reporting indicator becomes red. If you start up the reporting again the indication will switch automatically from red to green.

An alarm master routine will control the system and summarize the alarms. On the left side there is an indicator “Master alarm” and two buttons, “RESET” and “OFF”. While the alarms can toggle and appear and disappear, the master alarm once triggered will indicate that there was at least one serious error. The detail can be shown in the error log, but the point is that the master alarm shows you the correct operation in time and store the error event.

With the “OFF” button the master alert can be switched manually off. If the master alarm is switched off the “OFF” button will blink red to indicate this exceptional situation. A manual switch off of the master alarm could be necessary during setup or test, or simply to avoid receive alarm emails being anyway in front of the application or similar.

If the master alarm detect at least one error it will be switch on the Master Alarm status, the relative indicator will blink red, a warning triangle will appear and, if configured in the setup, and a warning email is send to the administrator.

[[Image:VR012.png]]

The icon of the application in the taskbar is changed and a warning triangle appears on the recorder logo; also operating in minimized status the Master Alert situation is visible.

[[Image:VR013.png]]

As explained the master alarm will not recover if an error disappears: to reset the master alarm the “RESET” button has to be clicked. Clicking the Reset Key the Master Alarm becomes again armed and will trigger again if an error is detected.

The single errors are partly described in the startup section while the “SOFTWARE” indicator will go into alarm if there is an unexpected error in the software. While some errors are expected and supported and will not cause such an error (for example “no files” if you browse an empty directory) others are not (for example if the decoding of pcap file fails). So while some errors could be an exception (like the failing of file conversation) others could be persisting (like “disk full”) or are simply bugs.

A particular expected, but not tolerable error is described in the next section.

=== Reporting time out error ===

Basically calls that should not be recorded should not be recorded even on the CF, this is desirable, but not always feasible.

In normal operations the recorder is connected to the PBX with a SOAP link and can so detect when a call is finished and the party involved. If there is a PCAP file and a SOAP connection fine, because in the very first step anything is clear and the recorder can decide to save or to just delete the PCAP file. But there is also the possibility that the recorder starts up later and “found” PCAP files stored in the meantime. In this case there could be or even not any SOAP information, if the call terminated before the recorder starts there will no SOAP info. Therefore if PCAP files are detected without any SOAP indication the recorder ask the reporting if there is any record to that PCAP. If yes the processing will follow the normal way, stored or just deleted. But if the reporting has no data there are more possible reasons. CDR data or the reporting could be “late”, so maybe in a few seconds data are in and processed. Or the reporting was just temperately busy or offline, a good idea is wait and try later again. Exactly that the recorder is doing, from build 1070 on the number of trial can be set in a range from 5 to 9999, default value is 5. On earlier build this value was set fix to 1444. Arrived to zero the call is deleted. Deleting recorded calls not knowing about the party involved is critical and therefore the recorder is so carefully.

The real problem is if in a system there are extensions creating PCAP files, but they did not produce CDR tickets / have no CDR license. In this case after a start-up each stored call will produce a PCAP file, the reporting query will fail and the recorder will try later again. To avoid large quantity of PCAP files and slow call processing switch on the reporting feature on each extension creating PCAP files. Or avoid that extension without a reporting creates PCAP files.

Receiving an answer form the reporting the recorder understand immediately the involved parties and can delete the file if the caller was not an Agent or store it.

=== Terminating ===

If you try to stop the application a warning message appears, if you confirm the recorder application stops.

== Files ==

Voice files are stored a subdirectory of the indicated path in the recorder setup.

The files are Wave stereo files where the left channel contains one speaker and the right channel the other one.

There are two working sub directories: the directory “/TMP” contains the central activity log file where the player applications will report their activities (“iRec_Player_Log.txt”). The second is the directory “/REC”, it is a working folder. Both folders are created automatically. The recorder creates a subdirectory for each month, so for June 2013 for example a directory “2013_06” is created and all recorded files in that period will be stored there. Note that in the backup folder no subdirectory folder are created and therefore all files in the backup path are in the same folder.

The recording files are always a couple, one file contains the audio (in wave format, can be reproduced using also standard audio player) and an xml file with the same name containing connection data. Both files are anyway independent and our player handles automatically a single wave file as well as the pair with additional detailed connection data.

One goal of the recorder was to produce a wave file that contains all relevant data.

The format of the name of the Wave file is the following:

"Date and Time of conversation start" + "internal user" + "direction" + "external user" + "time to answer in seconds" + "serial number"

Example:

“2013_06_24_1638_39_o_0800102_7_75c1f48e909d31188fc00903306225f.wav”

Date: 24.06.2013

Time: 16:38

Internal: 39

Direction: o = outgoing

External: 0800107

Time to answer: 7 seconds

Serial: 75c1f48e909d31188fc00903306225f

The file “2013_06_24_1638_39_o_0800102_7_75c1f48e909d31188fc00903306225f.xml” contains the reporting data of this call.

Eventual notes are stored in a file named “2013_06_24_1638_39_o_0800102_7_75c1f48e909d31188fc00903306225f.txt”.

This file is AES encrypt, see relative chapter. If this file is copied with the innovaphone Player it will be automatically decrypt and becomes a standard XML file.

The player retrieves the name of the wave file and displays the data from the xml file if present, otherwise at least the data inside the filename.

If you like you can open the xml file even with an editor and see all the relevant data, much more then displayed using the player.

The player shows also the duration of the call (the recoding) and other details. See relative description.

==Encryption==

The setup files for player and recorder are encrypted, as fix key is used an innovaphone specific secret key. The notes are not encrypted while the reporting and security file (the .xml) is encrypted.

So the reporting and security files are encrypted (those ending with “.xml”) using again as default the innovaphone system key. This default encryption key can be replaced with a customer specific key. In the in the setup of the recorder can be defined a customer key. The only reason to define a customer key is to avoid that other customer can decrypt the files, a remote and strange, but thinkable situation.

If this is done in the Recorder also in all Players must be set this customer decrypt key. Be careful in handling that key, because if you forget the key you will lose all encrypted information. The Player can handle contemporaneously the default key and the specific key. There is no update procedure foreseen if you change the key.

Example:

After 3 month of default operation you decide to insert a customer specific encryption key, for example “MySuperSecret007Key”.

You modify also the Player and insert in the setup this new key. Now you will observe that all data, the one of the first 3 month and the following one, will be decrypt automatically correct; the user will see no difference.

After other 5 Month you decide to return to the default key (leaving blank the key field again in recorder and player). Anything is going well, all records are decrypted correctly.

After other 2 Month you decide to enter a key named “MyBrandNewKey”, doing setup of recorder and player. You will observe now that the data of the month period 0 to 3 , 5 to 7 and after Month 7 will be decrypt while Month 3 to 5 (the one with the old key) will be displayed without CDR data and status “unknown”.

Therefore think well about your key, basically once selected it should remain. If you have the list of all Keys you can of cause change it on the fly in a player and decode the records in the period.

=== Audio encryption ===
The security system is based on AES encrypted xml data file. That file contains the CDR data but even the security parameter of the audio file. Therefore if an audio file is manipulated (changed in any way) that will be detected and show in the player (the “manipul” red label is on while off and the green “original” on if the audio file is the original one).

That means that the audio file itself is not encrypted. A fact and feature most customers want (reproducing the file even with other media player). At the end the access to the files should be forbidden to not authorize people.

But there are also customer that have another view and are worried about for example that such an audio file once copied is no more controllable. Or they simply do not thrust that the security features described works fine.

Therefore also the audio file itself can be AES encrypted if that option is switched on in the recorder. The player will detect automatically that an audio file is encrypted and reproduced it anyway.
Here how a player shows a detected Audio encryption:

[[Image:Sec04.png]]

Of cause an encrypted audio file can be reproduced just with the innovaphone player, no other media player will work.

Please note that any innovaphone player can do the decryption, so if you want to assure that just “your” player can reproduce you have to define a customer decrypt key in the recorder (and player).

The recorder shows audio encryption in his extended view:

[[Image:Sec05.png]]

Audio encryption has also disadvantages, recorder and player has more workload.

But the worst thing is the required disk space; in fact size of the audio files will double if encrypted!

==Audio compression==

=== MP3 ===
As default the files are saved in the wave format. More precisely in G711 because wave is a container format and pure PCM would require near the double disk size than G711.

As an option a mp3 compression can be activated. The required disk size is about 75% less, so one minute in wave requires about 1Mb while the same data in mp3 will require 250kb.

If you wonder why the savings are not much higher consider that even the wave format itself is jet compressed as explained.

All other functions like encryption (an encrypted file size is again doubled, so one minute of mp3 audio encrypted requires about 500kb) or reproducing are the same, the user has nothing to do and the player works always in the same mode.

There is just one situation where an action is required: if the recorder works for a certain period with wave and then with mp3 (or vice versa) in the directory of that month there will be mixed files (wave and mp3). The player detect this and shows automatically an additional key where the user must switch between those two formats: if a directory has just one type of files no action is required and the button is hided.

===MP3 Stereo to Stereo conversion===

If the MP3 option is on, files could also be converted form stereo to mono. The file size savings will be nearly 50%, so one minute conversation in mono MP3 requires about 130kB.

Note that conversion from wav to mp3 causes quality lost and stereo to mono even. Once converted, there is no possibility to return to the original format in terms of quality or format. So a bad mono mp3 quality cannot be recovered and even the stereo separation of the cannels cannot be done once converted to mono.

===MP3 just internal channel===

An interesting option in using MP3 is to record just one channel, the left (default) or the right one. The result is a mono file (130kB/min) where just one party is recorded.

If a GW point to an external trunk the internal user is always talking on the left channel. Therefore with this option on just the voice of the internal user is recorded, and doing that in many countries is simply allowed without any restrictions (basically I can record myself).

If recording is done on the phone the channel assignment is vice-versa, the internal caller (the phone) is recorded always in the right channel. Therefore in the setup of the recorder can be selected which cannel should be recorded. That means also that no mixed scenarios (GW and Phone recording) are supported for that feature.

[[Image:RecSetup01.png]]

== Redundancy ==

The recorder is able to handle redundancy scenarios with active and standby devices.
The recorder has to handle 3 sources in different scenarios, the PBX itself, the reporting and the CF or webdav server. Those devices can be all together in one single device (for example in an active IP6010 with reporting and CF and a standby IP6010 with reporting and CF) or on different devices (for example an active and a standby IP800 and two reporting on two different PCs).
Another example is active and standby PBX on Gateways but reporting on a high availability VMware environment, so at the end just one reporting from the recorder point of view.

Therefore the standby can be defined for each of those devices.
If you have no redundancy scenario just leave blank the relative setup values.

=== Active/Standby PBX ===

The failure of the PBX is detected because the SOAP connection will go down. If that happen the recorder will try to establish an alternative link to the standby PBX, if that fails he try again with the primary PBX and so one. That means also that a breakdown of the SOPA connection, for example if you reset the PBX, will require some more seconds until the system is up again (because first the recorder try the standby PBX, this will also fail and after that the main SOAP will be up again).

Note that after a restart the recorder try always the first the main address and then the standby one.

In the panel of the recorder near the PBX status indicator is shown the actual link: if the “ACT” lamp is green than the active PBX is tempted, if gray and the “STB” lamp on the standby link is on.

Please note that the recorder can handle differences in active and standby mode just regarding the IP address. All other parameter must be the same, so for example the path to the reporting must be the same.

=== Active/Standby Reporting ===

If the link to the reporting fails and there is a standby address indicated the recorder try to reach the reporting using the standby IP address for the reporting. If there is just one reporting leave the standby address blank.

As you (hopefully) know the reporting can also be installed on two devices, in that case both PBX (the active and the standby one) will transmit CDR ticket to both reporting applications. The reporting database is replicated and therefore if both devices are on the recorder will find the same informations on each reporting. So in theory if both are on it is not important where the reports are requested. In fact if the active reporting fails the recorder will try a connection to the standby reporting. Now if the active device and relative reporting is on again the recorder could also continue get records from the standby reporting. And he will do that until he is restarted or the standby reporting is down because the reporting will answer. If that is not desired flag the option in the recorder setup (“follow Standby/Active PBX”); doing so the recorder will communicate again with the reporting on the active PBX if the active PBX is up again. So basically the switch is done on link down but also following the SOAP.

=== Active/Standby CF ===

If the PCAP files are buffered on a CF and the PBX goes down also the recorder has to re-map his drive to the standby PBX. In the setup there is a flag in the PCAP section (“follow Standby/Active PBX”), if on the recorder will try to reach the CF of the standby PBX (he takes the IP address of the standby PBX) in the setup.

In scenarios where an external Webdav server is used that flag should not be switched on. The redundancy in that case is demanded to the external devices (for example VMware).

So if you have a “classic” innovaphone redundancy (two IP6010 with reporting and CF) indicate the standby address in the PBX and Reporting panel and switch on the “follow Standby/Active PBX” in the reporting and PCAP panel and anything is fine.

== External Applications ==

The recorder as well the player can be interfaced with external applications like booking or ticketing systems or similar.

The basic idea is that the external application will share common information in his database with the recorder and pilot a player. The user should be able to play a recorder conversation directly from his application interface.

In this chapter the interface is described. If you are not interested is such a feature you can skip this paragraph.

This description is done for the software developer of the external applications. No particular setup for the recorder or player is described, part of other descriptions.

For better understanding the description “hides” all other interfaces.

The “recorder” is a software solution running on a Windows “server” (can also be a simple PC). In the network there will be one or several “players” able to reproducing the recorded conversations.

Under “agent” in this description we understand operators working with the voice recording and using an external application.

It is possible to have a TCP connection between player and recorder but this is not mandatory because the player just access to stored data and read out setup file in the network. The number of player has no limit while the number of player connected to the recorder via TCP is limited to 100. That means that the external application can control up to 100 “agents” trough the recorder. But it is also possible to control a player directly; in this case the remote control has no limit.

Contact us if you have more than 100 agents with voice recording using an external application, we can easily extend this limit.

=== Principle and definition ===

This is the described scenario:

Recorder communicates with Player 1, Player 2 … Player x

The Application server communicates with the Application Client 1, 2, … xx

This description regards the TCP/IP interface in the following picture, the only one to build new from the application point of view.

[[Image:Layout02.png]]

Going on in the description as “Appclient” is intended the User frontend (“Application on terminal x” in the picture).

“AppServer” is called the server of the application (Application Server in the picture), so the server for the ticketing or booking system or whatever.

Keep in mind that just one AppServer can communicate with the Recorder while even each Player can be called even directly from the Appserver or an AppClient. Do not confuse: There are two ways to interface the voice recording system, via TCP and via URL. The smarter and better way is the TCP one. We describe both, read both because in the second section some concepts described in the first one are not repeated.

=== TCP/IP Interfacing ===

This is the preferred and smart way to realize the interface.
All messages and command goes to one single interface as shown in the picture. The Appserver act as a TCP/IP “Master” and will receive from the recorder messages and can send commands to the single Players trough the recorder. So it is a 3rt Party interface, piloting single player using one single IP address. The “play” command for a certain player is send to the recorder (and not to the relative player).

If for example a AppClient wants that the Player starts reproducing a record the command flow will be:

AppClientX press the play key -> AppServer send command to the -> Recorder -> Recorder send a command to -> PlayerX

So the idea is that in the applications is a “Play” and a “Stop” button; if the agent press this button the recording relative to the displayed database record will start to play, pressing stop the play will stop.
Therefore the applications database must contain the record name.

The problem is that the entire information about the record is available just a certain time period after the call end. In most of the cases the application session is terminated or a new one started. Therefore the link is provided in two times.

When voice recording starts, the recorder will send a first record to the AppServer in the following format:

''!FRST!<Extension Number of the Agent>!<UID>!<Agentname>''

<FRST> = indicate that this is the first (of two records)

Extension Number = the Phone number of the Agent

<UID> = a unique ID of the record

<Agentname> = the CN (common name) of the Agent in the PBX

Example:

''!FRST!24!c03a55c2e909d311b6450090331b3e3b!Rossi''

where ''“24”'' is the extension number of the agent, ''“c03a55c2e909d311b6450090331b3e3b”'' is the unique “serial number” of the record and ''“Rossi”'' the name of the agent.

Just the filed ''“!FRST!”'' has a fix length, all the others not; the single field therefore has to be separated searching the “!”.

At this point the applications probably store this information (number, ID and Name) in his database or buffer this info until the Agent has his client ready or similar. Important is that the database record of the application is linked to the record UID.

Basically it is necessary for later data processing that the application server knows the name of the player (in our example “Rossi”). The simplest way to do that is giving the extension in the PBX the right common name (the same name than the application user name). If that is not possible (for example because the application has other items to identify a user) the application has to hold a cross reference table: application user name 1 = recording user name 1 etc. Consider also that not necessarily a record is played only on the player of a certain agent; recording for agent 1 can be required to be played on work station agent 2.

When a call has terminated, the record converted, saved etc. (means, ready to be played) a second record is transmitted from the recording server to the AppServer:

''!LAST!<Extension Number of the Agent>!<UID>!<Track>!<Agentname>''

<Track> = Name of the recorded file, to transmit later to the recorder to play.

Example:

''!LAST!24!93adee5ee909d311b6450090331b3e3b!2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav!Rossi''

You see that the UID is in again and on the same position; even the extension number and name is repeated. In this way the application can easily search the UID in his database (and the name and/or the number) and when found complete the record entry with the record name (in the example ''2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav'').
You see the UID is also part of the record name and in theory the original “stand alone” UID in the application database is no longer required. Therefore a overwriting of the UID field in the application database with the record name is possible.

Note: In the actual version a reverse search is not implemented (that the player told the application to display a record). If implemented in the future the search string will be the entire record name and not just the UID, therefore the stand alone UID has no further sense from the voice recording point of view.

From the timing point of view the first message is critical because the UID has to be written until the Agent has opened his application record and that can be even a short time.

The last string is not very time critical because the retrieving of a record and a update can be done in every moment.

The recorder software has a small send buffer (about 25 recordings) where the messages will be buffered if the AppServer is not reachable or the link is down or. If for example the AppServer is switched off and later on again, the recorder will send to the AppServer the FRST and LAST messages buffered during downtime. The Buffer is a Fifo (first in first out) but not an Overflow-Fifo; if full not the oldest but simply all newer messages are lost. The buffering is done just to buffer short time periods, for example to allow a restart of the AppServer PC without losing information (but not for a “offline” operation).

In the application software design should also be considered the possibility that the AppServer receives a First record, is then stopped, and receives the second one after the restart.

That’s all regarding the recording part, now we discuss the remote control of the player.

Remember that a name can be assigned to a player, for external applications that is mandatory. The name can be defined in the player setup; a good idea to simplify the scenario is to give the player the common name of the phone. So in our example we will name the player of the agent “Rossi” just “Rossi”. Not a must of cause, you can call the player of Rossi even “myFirstAgent” or “1234”; but in doing so the external application must store a table where “Rossi” is mapped to “myFirstAgent”. To avoid such complication we suggest unifying the names and assigning to the phone user, Player name and application user in the same one.

To force a certain player to reproduce a certain recording the AppSever has to transmit to the recorder the following command string:

''TRAC!<PN>!<Track>''

<PN>=player name

Example:

''TRAC!Rossi!2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''

The Player with the name “Rossi” will start playing the record ''2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''.

There are not foreseen any error messages, if for example the player will not find the record or is switched off nothing will be transmitted to the AppServer. In case of record not found on the Player a blank result will indicate the fail. If the recorder start reproducing a record a green “RC” label (for Remote Control) near the play symbol shows that a remote control message and not a manual play key press has started the reproduction.

There are available also other commands:

''STOP'' (Stops the actual play)

''EJEC'' (the actual record is unloaded, the player stops)

''PAUS'' (the actual record is paused)

''PLAY'' (the actual record is played again)

Example:

''EJEC!Rossi''

Will force the player Rossi to stop the reproduction of the track and go in an idle mode.

Generally it is not necessary that the AppServer takes care about the actual Player status or observe command flows. If the Player is for example playing a track and the application server send the command to play another track he will Eject the actual track and play the desired one.

Note also that the player can work minimized in the taskbar and play “invisible”, so the user will see just the application. In the setup of the player can also be defined an automatic popup if a remote play is received and automatic hiding if an eject-command is received. If this is enabled in this way the player is minimized in the taskbar and the user works just with the application screen.

The TCP/IP link between recorder and AppServer is based on the fact that the recorder acts as a slave while the AppServer act as a Server. In the Setup of the recorder the IPadress and the port of the AppServer has to be indicated. The recorder expects on the same port where he is transmitting the response from the AppServer.

The recording server performs a keep alive with an interval settable in seconds. The keep alive message send from the recorder to the AppServer each xx seconds is:

''RecKA''

The message has no further meaning and can be thrown away from the AppServer. If any command is received from the Appserver the keep alive will be skipped and repeated after the, in the recorder setup indicated timespan. Unknown messages form the application server will be throw away from the recorder server.

=== URL Interfacing ===

URL interfacing is available only on a local port (127.0.0.1) and used for interfacing with the reporting (see relative article). The following description is just for internal use.

''<IPLTRAC><PN>''

There are also available the commands

''IPLPLAY''

''IPLSTOP''

''IPLEJECT''

''IPLPAUS''

Example:

''IPLTRAC2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''

will force the player to reproduce the indicated record ''2013_09_24_1107_39.o.024_1_93adee5ee909d311b6450090331b3e3b.wav''.

Basically the interface of the player is anyway a TCP/IP interface and no mini Webserver is integrated. But a “Get” from an browser will be detected and decoded, but no answer occurs. That means if you try to launch a command with a browser it will work, but the browser will show you “no page”.

Example:

If you post in your browser “''http://127.0.0.1:9090/IPLPLAY''“, the player will start to play the marked record.

If a port for direct remote control is switched on a “RC on” label is displayed in the player status line.

=== General Note ===

The first UID will be detected form the recording using the SOAP interface in the PBX. Therefore all Agents has to be in the same group that the SOAP user object.

Example: You have a simple user object called “MYSOAP”, put that object in an active group called “Recording” and now put all you Agents in the same group.

Remember that basically recording is done even without the group stuff. So the group is just required to detect the UID in “advanced”. But there is also an additional benefit; the reporting has less stress because the recorder will query the reporting just at the end of the call (knowing via SOAP when the “end” is) while calls without the group are detected as “finished” because the reporting has a valid CDR record, and so the recorder polls each 4 second the reporting on active calls. That means that it is in any case a good idea put the agents in a group, even if no external application is running.

== Recording rules ==

The recording rules describe how the innovaphone PBX and the innovaphone voice recorder works in complex situations.

While basic calls are simple and strait forward in logic, voice recording behavior becomes non clear in complex situations.

What about voice recording if for example a recorded user transfers the call to a “normal” user? Answer: This call will be entirely recorded and booked under the recording user by design; those behaviors are intended under “recording rules”.
From a technical point of view mostly no other solution is possible, form a political point of view any rule could be endless discussed.

Remember that in this chapter “Agent” is just the wording for “user enabled to recording with license” while “user” is a “normal” user, eventually even recording pcap files, but he is not in the recording user group.

In theory senseless recording should not be done. So deleting a record because it should not be stored is a task of the recorder; not recording at all if not necessary is better. That can be achieved avoiding or forcing extensions to the recording gateways or doing recoding directly from the IP-Phone.

The length (or contend) of a record depends; if the recording is done on a GW the entire call will be recorded (if not you will find a note in the rules), from his very first answer to the end. Therefore all the parties involved are even recorded. If recording is done on the phone level just the active call time on that phone will be recorded.

Generally spoken there are not necessary recording rules if the recording is done from the innovaphone IP-Phone: the recording starts when the phone answer the call and ends when the phone hangs up.

So the following table shows the recording rules if recording is done on a GW level.

“External” is the external calling or called party. Of cause if you record even internals calls (forcing all calls in a GW) in some situation the “External” is in reality a internal user, but this will not change the rules. The recorder recognizes the “external” party involved simply because it is the longest number involved.

The recorder stores always even the reporting data and therefore all details are visible in case of doubts. The audio filename anyway if formed just from the internal user number and the external user number even if more numbers are involved in the call (for example in a 3party conference).

Example: External call from number 012345 goes to the Agent number 24, after 3 second he will answer: the result will be a file name like “2014-05-12 14:00_24_i_012345_3_UID”.

Later on in the player you can search “24” or “012345” (or a fraction of it like “0123*” ecc.). In the reporting you can search also all other fields (like other involved extensions) and start the player than from the reporting (see relative function in the innovaphone player).

Note: the following rules works on any type of call transfer (with or without announcement).

“Delete” means that the call will be deleted on the CF. “Call” means that they talk. For example “Agent calls External” indicated the direction and means also that the involved parties talk (or at least produce a pcap file).

Rules:

• External call to Agent = Agent

• External call to User = Deleted

• External call to Agent, User pick-up the call = Agent

• External call to User, Agent pick-up the call = Agent

• External call to broadcast group, Agent answer = Agent

• External call to broadcast group, User answer = Deleted

• External call to User, User hold and transfer to Agent = Agent

• External call to Agent A, Agent A hold and transfer to Agent B = Agent A

• External call to Agent A, Agent B pick up the call = Agent A

• External call to WQ, WQ call XML with DTMF input, XML call WQ, WQ call Agent = Agent (just the external Number is considered, not the DTMF codes and numbers between)

• Agent call External = Agent

• Agent call External, Agent hold and call transfer to User = Agent

• Agent call User, User hold and transfer to External = Deleted

• Agent call External, Agent hold and talk with User but no call transfer = Agent (just external conversation is recorded)

• Agent A call External, Agent A hold and transfer to Agent B = Agent A

• Agent B call External, Agent B hold and transfer to Agent A = Agent B

• User call to Agent, Agent hold and transfer to External = Agent

• User call External, User hold and transfer to Agent = Agent

• User call External = Deleted

• User call External, User hold and talking with Agent but no call transfer = Deleted

• User call Agent, Agent hold and Agent talk with External = Agent (just the external conversation is recorded)

• External call to Agent, Agent has activated a unconditional call forward (CFU) to a User = Deleted

• External Call to Agent, Agent has activated a call forward on busy (CFB) to a User and is busy = Deleted

• External Call to Agent, Agent has activated a call forward on no response (CFNR) to a User, User answer after timeout = Agent

• External call to Agent A, Agent A has activated a unconditional call forward (CFU) to Agent B = Agent B

• External Call to Agent A, Agent A has activated a call forward on busy (CFB) to Agent B and is busy = Agent B

• External Call to Agent A, Agent A has activated a call forward on no response (CFNR) to Agent B, Agent B answer after timeout = Agent A

Note: If Threat call recording is on a call can be marked to store from the calling or called agent. But if both parties are Agent, the called Agent has to dial the code for storing: if the caller dials the code the record will not be saved.

From version 11 on the generated pcap file have a different format. While in former versions the name of a pcap file was a unique single long number form version 11r1 on the ticket as two additional id, one is build form the serial number of the device and the other one if an increasing number. This new format is also generated when recording is done form directly the phone. The recorder can handle both formats automatically, no special setup is required.

We want to focus your attention on the reason of the new format. If for example the recording is done on the phone the phone will generate a new pcap file each time a new call is opened form the PBX point of view.

Example: Phone rings and the user answers, the recording starts with record 1. Then the user put the call on hold and call another extension, this generates record number 2. Then the phone returns to the first call and continuous talking that will be the 3td call. Of cause using the player you will see those 3 calls one after the other (using the user as filter). That this is one situation you recognize looking the reporting details displayed and if you select the 3 calls the player will play one after the other (switch on the loop key) and you listen the entire call in one shoot.

== Known Problems ==

===Open a ticket===

If you have a problem with the recording tool you have to open a ticket as usual. Describe your problem, but send us also the following information:

- Setup of your PBX (with standard password or tell us the password)

- Version of the reporting

- Attach all log and error files and the setup of the recorder. All those files are in the log folder (so zip the entire folder), you find the path and link to the folder in the recorder setup.

- Make some screenshots if possible.

- Open the reporting and do a query where the recorded conversations are in (if possible). Do an export in XML and attached it.

=== No CDR ticket after start-up ===

If a record is not found on the CF and there is no SOAP info about that (for example if you start the recording and there are old terminated calls) the recording checks if the reporting has a related record. If a record is found and it is an Agent involved the record is stored as usual, if no Agent is involved the record will be deleted.

But if there is a recording file found and in the recording there is no related record, the recorder cold simply deletes that record; but this could be fatal. For example the reporting could answer once bad, or the link between the reporting and the PBX is temporary down; in that cases the recording will be lost if simply deleted. Therefore the recorder waits in this situation and asks the reporting again after 2 hours. If even after 2 hours the reporting answer with no record found the file will be deleted (otherwise normally processed and stored or deleted as described before).

Note that the reporting is not aware about the health of the connection between PBX and the Reporting. If the recorder gets no answer from the reporting an alarm occurs and the reporting will not proceed with the storage. But the answer “no record found” is not a clear situation for the software. Therefor this situation has to be avoided and occurs for example if pcaps are recorded, but the users involved have no reporting while the recorder is down and starts up later. So the recorder will “find” pcap files but no reporting information.

During online operation this will not happen, because the SOAP driver will tell the recorder that a specific record has to be deleted, and so the recorder will not check the reporting. This is done even to speed up the recorder because the communication with the reporting is relatively slow. If for example there are many users doing a recording (because a bad setup or simply because a huge PBX) and there are only few users to record a huge amount of files are simply to delete without any further processing. Deleting of files is relatively fast during online operation while in case of startup and then recover historic records it becomes slow, and very slow if there are no CDR tickets. The online deleting of files is just “relatively fast” because the SOAP is very fast but the recorded file has to be closed before deleting. Trying to delete a not closed file will cause an error, if that happen the system after e while will recover, but it is not nice. On top there is no way on a CF to understand if a file is in use or not. Therefore the system will wait 2 seconds before deleting a file.

=== No CDR ticket online ===

There is even an unclear situation in online operation. Imagine that an Agent transmits no CDR information to the reporting (for example because there is no reporting license assigned to that user) or, because of a bad setup in the PBX, the ticket will not arrive to the reporting. A call of an Agent is terminated, the SOAP driver informs the upper layer of the software about that and now the recording ask the reporting about the CDR details. Note that the reporting is not down; the recorder can reach the reporting and get also answers (otherwise the REP alarm would be on). If after a detected call end of an Agent signaled by SOAP and a timeout of 5 seconds no CDR is in the reporting a garbage select routine is activated in the recorder software; this routine ask a second time after other 5 seconds the reporting. If even now the response is “no record found” the reporting waits for this call 2 hours. After 2 hours a third time the reporting is asked, if no record is found the pcap is deleted, otherwise normal processed.

If a record is waiting in the 2 hours timeout status in the field “status” the countdown proceed is shown, for example “P1443”, after 5 seconds “P1442” and so one (number*5/60 = time in minutes to zero).

To fix it just stop the recording, solve the problem if possible (if you are lucky for example the CDR data are in the PBX buffer and will be send to the reporting when connection is up again), if not save the Pcap file, at least it will not be deleted. Then delete the pcap file on the CF to avoid a slowdown of the entire system.

A simple but good idea is to enable the CDR on the recording trunk line, in this case “some information” for the call is retrieved all time and at least the system will not face that problem.

All described can be the result of a bad or erroneous setup, or the customer is aware of that and simply not interested in a good working application. So a “no record” answer could be a real alarm or not. Therefore in the setup that can be selected.

See recording setup, panel reporting, option “Alarm if no CDR ticket found”.

=== Asynchronous reporting/PBX date and time ===

PBX and reporting must have the same date and time. If not, the reporting will detect that and display error and warning messages about a possible manipulation in the files.

So check first the actual date and time of PBX and reporting.

IPVA: Remember that date can be set in the reporting in administration, General, Configure NTP server.

===Voice Recorder Window is truncated===

It could happen that the Voice Recorder Window is truncated. The reason for this is the screen resolution setting in windows. To solve the problem, the screen resolution adaption must be switched off (set to 100%) in windows system settings.

=== Player Crash on start-up===

If the player won’t start try first play a wave file using the Windows media Player. If the Windows Media Player cannot reproduce the wave file (for example because there is no audio device or the audio device is not ready) the player will not start up. Fix first the PC problem.

=== G722 ===

The actual version of the Pcap2wav (151.552kb) extension does not support G722, the result are empty small Wave container files.

=== Recorder stopped responding after the start ===

We have had reports that recording did not run on windows 2008 r2. Symptoms were (recorder stopped responding after the start (recorder hang) and the link to the PBX was down). This had been fixed by running sfc.exe.

== Related Articles ==

[[Reference10:Player_Voice_Recording]]

[[Reference10:Voice_Recorder/Setup]]

[[Howto:Last_Call_Recording]]

[[Howto:Universal_Track_Recording_Tool]]

[[Howto:Integration_reporting_and_voice_recording]]

[[Howto:Soft-migration_%28looping_in_a_innovaphone_gateway%29_and_Voice_Recording]]

[[Howto:Player_over_http]]

[[Howto:Marking_a_record_in_Voicerecording]]

[[Howto:Voice_Recording_in_Master_Slave_scenarios]]

[[Category:Concept|{{PAGENAME}}]]

Reference9:PBX/Objects/Edit Profiles

2016-07-05T09:05:47Z

Gnd: /* Properties of a Profile */

You can set various profiles per user, for each profile you can have a [[Reference9:Concept_myPBX#Contacts |buddy list (aka contacts)]] in the myPBX client.

'''Name''' Name of the profile, the myPBX user can choose from profile names if more are configured.

== Properties of a Profile==

{|
|valign=top nowrap=true|'''Name'''
|Name of the user that shows up in the buddy list
|-
|valign=top nowrap=true|'''No'''
|Number of that user that shows up in the buddy list
|
|-
|valign=top nowrap=true|'''Display'''
|How the user should be named in the buddy list
|
|-
|valign=top nowrap=true|'''Extern'''
|If its not an user from the PBX choose '''tel''' for a external phone number, or '''sip''' for an external sip user via federation
|
|-
|valign=top nowrap=true|'''Presence'''
|If you want to monitor the users presence state (that is only for external users), for internal you see the presence state if you have the [[Reference9:PBX/Objects/Edit_Allow |access rights]], used for federation
|-
|valign=top nowrap=true|'''Dialog'''
|If you want to monitor the users call state (that is only for external users), for internal you see the call state if you have the [[Reference9:PBX/Objects/Edit_Allow |access rights]], used for federation
|-
|}

* Note: For internal users configure either name or number. If the display is different to the one from the user configuration, only the name must be configured.

File:New RecE111S2.png

2016-06-28T09:02:24Z

Gnd: Recorder 2 im Location 2 wurde entfernt, da er nicht zum dargestellten Szenario passte.

Recorder 2 im Location 2 wurde entfernt, da er nicht zum dargestellten Szenario passte.