innovaphone wiki - User contributions [en]

Reference14r1:MyApps Plugin for Virtual Desktops

2023-12-18T14:48:52Z

Ani:

[[Category:Concept|Apps]]

== Description ==

A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.

Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
 This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
 Video suffers from the same limitations.

Innovaphone provides a solution for this problem with the RCC-App but there are still some limitations:

- Admin must configure a Softphone and a RCC-App for the user.

- myApps must be installed at the terminal client for the Softphone App which the RCC-App will control and the user must log in at the terminal client too.

- Configuration of the Softphone (Call-Waiting, Video, ...) happens at the terminal client.

- Management of the audio devices takes place at the terminal client.

- RCC-App does not support video. The Softphone App does. If the user wants video, he starts or receives the call with the RCC-App but he must switch to the Softphone App.

- RCC-App does not support appSharing. User could share a local application with the Softphone App or even the local desktop in order to show the remote desktop.

A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client and to offer a solution for the limitations of the RCC-App.

== Applies To ==
* innovaphone PBX from version 14r1
* Windows or MacOS operating systems

== Requirements ==
* innovaphone PBX
* innovaphone myApps V14r1
* innovaphone myApps Plugin V14r1
* Firmware V14r1 final

== Concept ==

The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:

- start or stop an audio/video device

- gathering of the ICE candidates

- connect to a remote peer with the ICE protocol

- start a ringing device

- rendering of video

But we now need a way of communicating between the myApps running at the terminal server and the myApps plugin running at the terminal client in order to carry out all these actions.

Main VDI Platforms (Citrix, Windows, WMware) provide a way of communicating between server and client through Virtual Channels:

https://support.citrix.com/article/CTX116890/citrix-ica-virtual-channels-overview

https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels

== Configuration ==

The myApps Plugin must be installed or deployed at the terminal client but it does not require any configuration.

The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

User starts the VDI software (Citrix Workspace App or Windows Remotedesktop) needed to connect to a remote server.

This software automatically starts the myApps Plugin. No user action required.

The user starts myApps at the server for the Softphone App. myApps discovers that it is running in terminal server environment and will connect to the plugin which was already started by the VDI software.

The user does not need to have any knowledge about the myApps Plugin.

== Licensing ==

== Known issues ==

- Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client.

- Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
Video is displayed but with delay due to the rendering process.
 Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.

- Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client.

== Troubleshooting Windows==

If Citrix is used as a terminal server environment:

1) Citrix must be installed '''BEFORE''' the plugin

2) Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll

3) Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there.

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

4) In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

Dump files are in the trace folder c:\users\$user\Appdata\local\innovaphone\myAppsPlugin if client crash at start.

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

Computer\HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Default\AddIns\innovaphoneRemoteServicesSvc64

and check as "Name" the path of the .dll <--- c:\program files(x86)\iinnovaphone\myAppsPlugin\myAppsRemoteServiceSvc64.dll

check that the .dll exist in the mentioned direcotry and the plugin.

== Troubleshooting MacOS==

'''Citrix Workspace App must be installed before the myAppsPlugin'''

In /Library/Application Support/Citrix/PlugIns

must exist myAppsCitrixPlugin.plugin -> /Application/myappsPlugin.app/Contents/PlugIns/myapps_citrix_plugin.plugin

under:

/Users/.../Library/Application Support/Citrix Receiver

there is a file called Modules. Inside this file the myApps Plugin is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

both things are done during the installation. In case something is not working must check that the link to the plugin exists and that the modules file contains these entries.

And under /Users/.../Library/Containers/com.innovaphone.myapps-plugin-14r1/Data/Documentsa log file is created: myAppsPlugin.txt

== Related Articles ==

* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_myApps
* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_App_SoftphoneApp

Howto14r1:Set up the MyApps Plugin for Virtual Desktops

2023-12-14T08:51:36Z

Ani: Created page with " Set up the MyApps Plugin for Virtual Desktops This article explains all necessary steps to set up the MyApps Plugin for Virtual Desktops ==Applies To== This information applies to any PBX/AP system since '''14r1'''. ==steps== Download the latest myApps plugin for Virtual desktops from our [https://store.innovaphone.com/ store] Always install the latest version. The plugin is not dependent on the myApps cli..."

[[Category:Howto|Set up the MyApps Plugin for Virtual Desktops]]

This article explains all necessary steps to set up the MyApps Plugin for Virtual Desktops
==Applies To==
This information applies to any PBX/AP system since '''14r1'''.

==steps==
Download the latest myApps plugin for Virtual desktops from our [https://store.innovaphone.com/ store]

Always install the latest version. The plugin is not dependent on the myApps client, and when updating myApps, it will not be automatically updated, so please
always install the latest version.

Run the installer and install the plugin, it will work "out of the box"

==Related articles==
[[Reference14r1:MyApps_Plugin_for_Virtual_Desktops]]

Reference14r1:MyApps Plugin for Virtual Desktops

2023-12-14T08:09:45Z

Ani:

[[Category:Concept|Apps]]

== Description ==

A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.

Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
 This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
 Video suffers from the same limitations.

Innovaphone provides a solution for this problem with the RCC-App but there are still some limitations:

- Admin must configure a Softphone and a RCC-App for the user.

- myApps must be installed at the terminal client for the Softphone App which the RCC-App will control and the user must log in at the terminal client too.

- Configuration of the Softphone (Call-Waiting, Video, ...) happens at the terminal client.

- Management of the audio devices takes place at the terminal client.

- RCC-App does not support video. The Softphone App does. If the user wants video, he starts or receives the call with the RCC-App but he must switch to the Softphone App.

- RCC-App does not support appSharing. User could share a local application with the Softphone App or even the local desktop in order to show the remote desktop.

A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client and to offer a solution for the limitations of the RCC-App.

== Applies To ==
* innovaphone PBX from version 14r1

== Requirements ==
* innovaphone PBX
* innovaphone myApps V14r1
* innovaphone myApps Plugin V14r1
* Firmware V14r1 final

== Concept ==

The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:

- start or stop an audio/video device

- gathering of the ICE candidates

- connect to a remote peer with the ICE protocol

- start a ringing device

- rendering of video

But we now need a way of communicating between the myApps running at the terminal server and the myApps plugin running at the terminal client in order to carry out all these actions.

Main VDI Platforms (Citrix, Windows, WMware) provide a way of communicating between server and client through Virtual Channels:

https://support.citrix.com/article/CTX116890/citrix-ica-virtual-channels-overview

https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels

== Configuration ==

The myApps Plugin must be installed or deployed at the terminal client but it does not require any configuration.

The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

User starts the VDI software (Citrix Workspace App or Windows Remotedesktop) needed to connect to a remote server.

This software automatically starts the myApps Plugin. No user action required.

The user starts myApps at the server for the Softphone App. myApps discovers that it is running in terminal server environment and will connect to the plugin which was already started by the VDI software.

The user does not need to have any knowledge about the myApps Plugin.

== Licensing ==

== Known issues ==

- Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client.

- Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
Video is displayed but with delay due to the rendering process.
 Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.

- Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client.

== Troubleshooting ==

If Citrix is used as a terminal server environment:

1) Citrix must be installed '''BEFORE''' the plugin

2) Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll

3) Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there.

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

4) In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

Dump files are in the trace folder c:\users\$user\Appdata\local\innovaphone\myAppsPlugin if client crash at start.

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

Computer\HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Default\AddIns\innovaphoneRemoteServicesSvc64

and check as "Name" the path of the .dll <--- c:\program files(x86)\iinnovaphone\myAppsPlugin\myAppsRemoteServiceSvc64.dll

check that the .dll exist in the mentioned direcotry and the plugin.

== Related Articles ==

* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_myApps
* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_App_SoftphoneApp

Reference14r1:MyApps Plugin for Virtual Desktops

2023-11-09T13:56:52Z

Ani:

[[Category:Concept|Apps]]
This product is currently in Beta. It is not officially released yet.

== Description ==

A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.

Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
 This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
 Video suffers from the same limitations.

Innovaphone provides a solution for this problem with the RCC-App but there are still some limitations:

- Admin must configure a Softphone and a RCC-App for the user.

- myApps must be installed at the terminal client for the Softphone App which the RCC-App will control and the user must log in at the terminal client too.

- Configuration of the Softphone (Call-Waiting, Video, ...) happens at the terminal client.

- Management of the audio devices takes place at the terminal client.

- RCC-App does not support video. The Softphone App does. If the user wants video, he starts or receives the call with the RCC-App but he must switch to the Softphone App.

- RCC-App does not support appSharing. User could share a local application with the Softphone App or even the local desktop in order to show the remote desktop.

A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client and to offer a solution for the limitations of the RCC-App.

== Applies To ==
* innovaphone PBX from version 14r1

== Requirements ==
* innovaphone PBX
* innovaphone myApps V14r1
* innovaphone myApps Plugin V14r1
* Firmware V14r1 final

== Concept ==

The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:

- start or stop an audio/video device

- gathering of the ICE candidates

- connect to a remote peer with the ICE protocol

- start a ringing device

- rendering of video

But we now need a way of communicating between the myApps running at the terminal server and the myApps plugin running at the terminal client in order to carry out all these actions.

Main VDI Platforms (Citrix, Windows, WMware) provide a way of communicating between server and client through Virtual Channels:

https://support.citrix.com/article/CTX116890/citrix-ica-virtual-channels-overview

https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels

== Configuration ==

The myApps Plugin must be installed or deployed at the terminal client but it does not require any configuration.

The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

User starts the VDI software (Citrix Workspace App or Windows Remotedesktop) needed to connect to a remote server.

This software automatically starts the myApps Plugin. No user action required.

The user starts myApps at the server for the Softphone App. myApps discovers that it is running in terminal server environment and will connect to the plugin which was already started by the VDI software.

The user does not need to have any knowledge about the myApps Plugin.

== Licensing ==

== Known issues ==

- Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client.

- Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
Video is displayed but with delay due to the rendering process.
 Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.

- Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client.

== Troubleshooting ==

If Citrix is used as a terminal server environment:

1) Citrix must be installed '''BEFORE''' the plugin

2) Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll

3) Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there.

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

4) In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

Dump files are in the trace folder c:\users\$user\Appdata\local\innovaphone\myAppsPlugin if client crash at start.

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

Computer\HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Default\AddIns\innovaphoneRemoteServicesSvc64

and check as "Name" the path of the .dll <--- c:\program files(x86)\iinnovaphone\myAppsPlugin\myAppsRemoteServiceSvc64.dll

check that the .dll exist in the mentioned direcotry and the plugin.

== Related Articles ==

* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_myApps
* https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_App_SoftphoneApp

Howto:Convert G711 files in to WAV files

2023-09-20T08:36:59Z

Ani:

This article describes how to convert G711 files recorded by innovaphone devices to WAV files.

==Applies To==

G711A and G711U files created by innovaphone devices.

==More Information==

===Problem Details===

The G711 files created by innovaphone devices (WEBMEDIA) are header-less raw PCM files. To be able to play this files on most audio players, you will need to convert them into WAV files. This can be done using open source audio file converter SoX.

===Installation===

The [https://sourceforge.net/projects/sox/files/sox/14.4.2/ SoX - Sound eXchange] is an open source (GPL) tool. Download and install it.

Here an example using SoX to convert a RAW G711A file to PCM ALAW WAV file:
sox --channels 1 --type raw --rate 8000 -A input_file.g711a output_file.wav

For G711U files replace the parameter <code>-A</code> with <code>-U</code>.

If you must convert big amount of files, try the DOS batch script in the download section.

Newer versions of sox need another syntax, like this:
sox --channels 1 --type raw --rate 8000 -e a-law input_file.g711a output_file.wav

===Known Problems===

The output file name extension must be <code>.wav</code>, otherwise SoX can not detect output file format.

==Download==
*[https://sourceforge.net/projects/sox/files/sox/14.4.2/ Download SoX executable for Win32 from sourceforge.net)]
*[http://wiki.innovaphone.com/index.php?title=Howto:Wiki_Sources#g711towav Download] a script for drag and drop batch conversion of G711 files to WAV files.

== Related Articles ==

[[Howto:Convert_wave_files_in_to_G7xx_coder_files]]

[[Howto:Convert wave files to G7xxx with softcode]]

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-27T07:28:34Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app.

If you want to make a note and you don't have your hands free e.g. when driving a car, using an App like the ToDoList could be problematic or even dangerous. That's why an audio note is useful, you just speak the note. The notes can be recorded with any device and played back and deleted from anywhere.

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Operation==
To record a message, you call the service, hear a "beep" and record the note simply speaking. The length is limited to 50 seconds per note, to end the recording simply hang up.

The service can either be called directly, e.g. with a function key on the phone or by saving the number as a favorite, or by pressing the recording voice note symbol (3) on the myApps homepage.

[[Image:Screenshot_rec.png‎]]

1 = App to play the Voice Note

2 = Batch Counter (in the example one new Voice Note stored)

3 = App to record the Voice Note

If a note is recorded, the batch counter increases for the corresponding VM app (2). Voice Notes are accessed in the same way as voicemail messages (1).
To listen to or delete the message use the VM App. Instead of the phone number, the text "VoiceNote" is shown in the number field.

In the example there are 3 voice notes, the first one has not yet been listened to (green bar on the left).

[[Image:Screenshot_play.png‎]]

The service does not require a license and can also be operated in parallel with a voicemail. In this case there are two icons on the home screen and the service can be recognized by the label.

External access, e.g. with DID, is not intended and is prevented by the system. Your notes are protected and can only be accessed via your myApps.

==How it works==
In fact, you call an XML script which plays a beep and then starts recording. The file is stored in a VM directory in VM format. This allows the regular VM app to access directly and also the batch conter will work automatically. The XML script itself can be called directly, but numbers outside the PBX are not accepted. The solution also includes an icon with which a link can be created directly on the homepage (3). This allows the service to be called directly.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.


===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the content of the Voice-Note-main.zip/Voice-Note-main/VoiceNote file in the custom folder (in the custom folder, only the .XML file and the beep.codec file must be pasted, vm_files fodler will be automatically created.

[[Image:VoiceNotefolderstructure.JPG]]

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicenote/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicenote/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicenote is used in this example, but you need to configure the correct Voicemail instance name there (for example, in the previous image, the instance name was "voicenote")

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Known Problems===
Access via the icon does not work with the browser, so only with Windows, MacOS, Android or iOS (recording dailing the number works always).

== Download ==
*[[Howto:Wiki_Sources#Voice-Note | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-27T07:27:02Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app.

If you want to make a note and you don't have your hands free e.g. when driving a car, using an App like the ToDoList could be problematic or even dangerous. That's why an audio note is useful, you just speak the note. The notes can be recorded with any device and played back and deleted from anywhere.

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Operation==
To record a message, you call the service, hear a "beep" and record the note simply speaking. The length is limited to 50 seconds per note, to end the recording simply hang up.

The service can either be called directly, e.g. with a function key on the phone or by saving the number as a favorite, or by pressing the recording voice note symbol (3) on the myApps homepage.

[[Image:Screenshot_rec.png‎]]

1 = App to play the Voice Note

2 = Batch Counter (in the example one new Voice Note stored)

3 = App to record the Voice Note

If a note is recorded, the batch counter increases for the corresponding VM app (2). Voice Notes are accessed in the same way as voicemail messages (1).
To listen to or delete the message use the VM App. Instead of the phone number, the text "VoiceNote" is shown in the number field.

In the example there are 3 voice notes, the first one has not yet been listened to (green bar on the left).

[[Image:Screenshot_play.png‎]]

The service does not require a license and can also be operated in parallel with a voicemail. In this case there are two icons on the home screen and the service can be recognized by the label.

External access, e.g. with DID, is not intended and is prevented by the system. Your notes are protected and can only be accessed via your myApps.

==How it works==
In fact, you call an XML script which plays a beep and then starts recording. The file is stored in a VM directory in VM format. This allows the regular VM app to access directly and also the batch conter will work automatically. The XML script itself can be called directly, but numbers outside the PBX are not accepted. The solution also includes an icon with which a link can be created directly on the homepage (3). This allows the service to be called directly.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.


===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the content of the Voice-Note-main.zip/Voice-Note-main/VoiceNote file in the custom folder (in the custom folder, only the .XML file and the beep.codec file must be pasted, vm_files fodler will be automatically created.

[[Image:VoiceNotefolderstructure.JPG]]

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there (for example, in the previous image, the instance name was "voicenote")

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Known Problems===
Access via the icon does not work with the browser, so only with Windows, MacOS, Android or iOS (recording dailing the number works always).

== Download ==
*[[Howto:Wiki_Sources#Voice-Note | download]] the complete file package of scripts and files described in this article.

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

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

File:VoiceNotefolderstructure.JPG

2023-03-27T07:25:45Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-27T07:25:33Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app.

If you want to make a note and you don't have your hands free e.g. when driving a car, using an App like the ToDoList could be problematic or even dangerous. That's why an audio note is useful, you just speak the note. The notes can be recorded with any device and played back and deleted from anywhere.

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Operation==
To record a message, you call the service, hear a "beep" and record the note simply speaking. The length is limited to 50 seconds per note, to end the recording simply hang up.

The service can either be called directly, e.g. with a function key on the phone or by saving the number as a favorite, or by pressing the recording voice note symbol (3) on the myApps homepage.

[[Image:Screenshot_rec.png‎]]

1 = App to play the Voice Note

2 = Batch Counter (in the example one new Voice Note stored)

3 = App to record the Voice Note

If a note is recorded, the batch counter increases for the corresponding VM app (2). Voice Notes are accessed in the same way as voicemail messages (1).
To listen to or delete the message use the VM App. Instead of the phone number, the text "VoiceNote" is shown in the number field.

In the example there are 3 voice notes, the first one has not yet been listened to (green bar on the left).

[[Image:Screenshot_play.png‎]]

The service does not require a license and can also be operated in parallel with a voicemail. In this case there are two icons on the home screen and the service can be recognized by the label.

External access, e.g. with DID, is not intended and is prevented by the system. Your notes are protected and can only be accessed via your myApps.

==How it works==
In fact, you call an XML script which plays a beep and then starts recording. The file is stored in a VM directory in VM format. This allows the regular VM app to access directly and also the batch conter will work automatically. The XML script itself can be called directly, but numbers outside the PBX are not accepted. The solution also includes an icon with which a link can be created directly on the homepage (3). This allows the service to be called directly.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.


===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the content of the Voice-Note-main.zip/Voice-Note-main/VoiceNote file in the custom folder (in the custom folder, only the .XML file and the beep.codec file must be pasted, vm_files fodler will be automatically created.

[[Image:VoiceNotefolderstructure.JPG]]

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Known Problems===
Access via the icon does not work with the browser, so only with Windows, MacOS, Android or iOS (recording dailing the number works always).

== Download ==
*[[Howto:Wiki_Sources#Voice-Note | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-27T07:12:33Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app.

If you want to make a note and you don't have your hands free e.g. when driving a car, using an App like the ToDoList could be problematic or even dangerous. That's why an audio note is useful, you just speak the note. The notes can be recorded with any device and played back and deleted from anywhere.

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Operation==
To record a message, you call the service, hear a "beep" and record the note simply speaking. The length is limited to 50 seconds per note, to end the recording simply hang up.

The service can either be called directly, e.g. with a function key on the phone or by saving the number as a favorite, or by pressing the recording voice note symbol (3) on the myApps homepage.

[[Image:Screenshot_rec.png‎]]

1 = App to play the Voice Note

2 = Batch Counter (in the example one new Voice Note stored)

3 = App to record the Voice Note

If a note is recorded, the batch counter increases for the corresponding VM app (2). Voice Notes are accessed in the same way as voicemail messages (1).
To listen to or delete the message use the VM App. Instead of the phone number, the text "VoiceNote" is shown in the number field.

In the example there are 3 voice notes, the first one has not yet been listened to (green bar on the left).

[[Image:Screenshot_play.png‎]]

The service does not require a license and can also be operated in parallel with a voicemail. In this case there are two icons on the home screen and the service can be recognized by the label.

External access, e.g. with DID, is not intended and is prevented by the system. Your notes are protected and can only be accessed via your myApps.

==How it works==
In fact, you call an XML script which plays a beep and then starts recording. The file is stored in a VM directory in VM format. This allows the regular VM app to access directly and also the batch conter will work automatically. The XML script itself can be called directly, but numbers outside the PBX are not accepted. The solution also includes an icon with which a link can be created directly on the homepage (3). This allows the service to be called directly.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.


===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the content of the VNote.zip file in the customer folder.

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Known Problems===
Access via the icon does not work with the browser, so only with Windows, MacOS, Android or iOS (recording dailing the number works always).

== Download ==
*[[Howto:Wiki_Sources#Voice-Note | download]] the complete file package of scripts and files described in this article.

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

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

Howto:Wiki Sources

2023-03-27T07:11:52Z

Ani:

==Applies To==
This information applies to all innovaphone products.

==More Information==

===Overview===
innovaphone and its partners have developed many solutions for special applications and scenarios over the years.

We make these solutions publicly available under the ''BSD-3-Clause'' license. The publication and maintenance of these solutions takes place on the [https://github.com/innovaphone innovaphone GitHub Account].

===Structure===
The following things are provided for a public solution:
* Wiki article with the concept of the solution as well as a description how to use it
* A GitHub repository
* A listing in this article including a short description and links to the documentation, the direct download and the GitHub repository

==Solutions==
===absencememo===
Leave a voice absence memo on your phone / a caller will hear first the message and after that your phone rings. Works from anywhere and on any type of phone.
* [[Howto:Absence_Memo_with_VoiceMail_XML_Script]]
* [https://github.com/innovaphone/absencememo/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/absencememo GitHub]

===acddirectory===
A external caller stored in the PBX directory is connected automatically to a defined extension.
* [[Howto:ACD_using_the_PBX-Directory]]
* [https://github.com/innovaphone/acddirectory/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/acddirectory GitHub]

===advonbusy===
The BusyAdvice service gives the caller multiple choices when the person he is calling not is available.
* [[Howto:Advice_On_Busy]]
* [https://github.com/innovaphone/advonbusy/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/advonbusy GitHub]

===alarmxml===
innovaphone Call Sequencer: localized version (German and Italian only).
* [[Howto-localized:Innovaphone_Call_Sequencer_(D)]]
* [[Howto-localized:Innovaphone_Call_Sequencer_(I)]]
* [https://github.com/innovaphone/alarmxml/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/alarmxml GitHub]

===annualcal===
Work around for using in version 8 a annual calendar function.
* [[Howto:Annual_calender_in_V8]]
* [https://github.com/innovaphone/annualcal/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/annualcal GitHub]

===autocallback===
A external caller will be connected automatically to the internal user called him before.
* [[Howto:Auto_Call_Back]]
* [https://github.com/innovaphone/autocallback/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/autocallback GitHub]

===autogreet===
A caller will hear automatically a recorded greeting when you answer the call. The greeting can be recorded directly with the phone set.
* [[Howto:Auto_Greeting]]
* [https://github.com/innovaphone/autogreet/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/autogreet GitHub]

===blacklst===
This script allows to create and to maintain a simple blacklist for incoming calls. Blacklisted calls to the PBX are immediately rejected or transferred to a default destination. Numbers can be easily added or removed by calling the Blacklist Service object and by following the instructions. Additionally a number can be put in the blacklist by simply transferring the undesired ringing/active call to a specific object.
* [[Howto:Black_List_Service_XML_Script_For_Incoming_Calls]]
* [https://github.com/innovaphone/blacklst/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/blacklst GitHub]

===busyadv===
If a busy innovaphone IP-Phone (with max. nr. of calls=1) receives a call an instant message containing the caller number is immediately forwarded to the set. If the phone is idle again the user can see who was calling him during busy.
* [[Howto:Busy_Advice]]
* [https://github.com/innovaphone/busyadv/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/busyadv GitHub]

===callid===
A caller can digit a number, the called user will see this additional information.
* [[Howto:Additional_call-ID_information]]
* [https://github.com/innovaphone/callid/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/callid GitHub]

===callmeback===
An external user can signal to an innovaphone IP-Phone using instant message that he wants to be called back. Typical feature in case of asymmetric calling costs.
* [[Howto:Call_Me_Back]]
* [https://github.com/innovaphone/callmeback/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/callmeback GitHub]

===callmonitor===
Classic passive busy lamp field for up to 400 users. Run on PC with Windows OS XP or higher.
* [[Howto:Callmonitor]]
* [https://github.com/innovaphone/callmonitor/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/callmonitor GitHub]

===call_limit===
Limit the duration and number of calls for certain extensions.
* [[Howto:Limit_number_of_calls_and_call_duration_on_some_extensions]]
* [https://github.com/innovaphone/call_limit/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/call_limit GitHub]

===cfstatus===
Check the CFU status of the own telephone set (usefully for analog or dect phones).
* [[Howto:Check_the_CFU_Status_with_Voicemail_XML_Script]]
* [https://github.com/innovaphone/cfstatus/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/cfstatus GitHub]

===checkinout===
A filter can be switched on and off from an other phone set.
* [[Howto:Check-In/Out_with_XML_Script]]
* [https://github.com/innovaphone/checkinout/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/checkinout GitHub]

===controlcfx===
Known as "Follow me" this feature allows setting a call forward (CFU) using a remote set (also form external for example a GSM set). All operations are voice guided.
* [[Howto:Control_Call_Forward_with_Voicemail_XML_Script]]
* [https://github.com/innovaphone/controlcfx/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/controlcfx GitHub]

===doorcontrol===
Working with multiple Door Cameras
* [[Howto:Working_with_multiple_Door_Cameras]]
* [https://github.com/innovaphone/doorcontrol/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/doorcontrol GitHub]

===ext_ann===
This xml allows playing a pre-registered audio message to an external announcement facility (PA system).
* [[Howto:External_announcement_facility]]
* [https://github.com/innovaphone/ext_ann/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/ext_ann GitHub]

===g711towav===
Batch files to convert G711 files recorded by innovaphone devices to WAV files.
* [[Howto:Convert_G711_files_in_to_WAV_files]]
* [https://github.com/innovaphone/g711towav/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/g711towav GitHub]

===ibl===
innovaphone Babylook: localized version (German and Italian only)
* [[Howto-localized:IBL_–_innovaphone_BabyLook_%28Raumüberwachung%29]]
* [[Howto-localized:IBL_–_innovaphone_BabyLook_%28Supervisione_stanza%29]]
* [https://github.com/innovaphone/ibl/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/ibl GitHub]

===idd===
Reproduce the display of an IP240 on the PC and map the PC-Keyboard to the Phone. Simple CTI-Solution, active busy lamp field, interface for visual impaired and blind operator. Run on Windows OS.
* [[Howto:Innovaphone_Desktop_Display_%28iDD%29]]
* [https://github.com/innovaphone/idd/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/idd GitHub]

===imcallback===
If a DID call return to the operator because the user was absent or busy the operator can leave an automatic instant message the called user. The message contains the number of the caller.
* [[Howto:Instant_Messaging_Call_Back]]
* [https://github.com/innovaphone/imcallback/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/imcallback GitHub]

===innoconf===
Enhanced Conference Bridge for the innovaphone BC-Conference unit. Users are announced with name when joining and leaving the conference.
* [[Howto:Innovaphone_conferencing]]
* [https://github.com/innovaphone/innoconf/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/innoconf GitHub]

===ipcallback===
Provides middleware for implementig a Callback via simple HTTP GET or POST request.
* [[Howto:Initiate_a_Mobility_CallBack_via_simple_HTTP_GET_or_POST_request]]
* [https://github.com/innovaphone/ipcallback/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/ipcallback GitHub]

===iqm_cbr===
XML for the innovaphone Queue Monitor (iQM), see description.
* [[Howto:IQM_CallBack_requests]]
* [https://github.com/innovaphone/iqm_cbr/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/iqm_cbr GitHub]

===lcr===
Last Call Recording, see article if matching with your requests.
* [[Howto:Last_Call_Recording]]
* [https://github.com/innovaphone/lcr/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/lcr GitHub]

===learnpin===
A self learning PIN-code suite.
* [[Howto:Learning_PIN_code]]
* [https://github.com/innovaphone/learnpin/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/learnpin GitHub]

===licsummary===
License Summary
* [[Howto:License_Summary]]
* [https://github.com/innovaphone/licsummary/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/licsummary GitHub]

===linearacd===
One particularly ACD strategy, see article if matching with your requests.
* [[Howto:Simple_Linear_ACD_with_Voicemail_XML_Script]]
* [https://github.com/innovaphone/linearacd/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/linearacd GitHub]

===mail_cfna===
Missed Calls are notified with an email.
* [[Howto:Email_on_missed_calls]]
* [https://github.com/innovaphone/mail_cfna/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/mail_cfna GitHub]

===mapdid===
Calls done using a map object in the PBX can dial additional digits to the number mapped. PIN code calls can be stored on defined numbers.
* [[Howto:DID_on_mapped_numbers_/_Hide_PIN_code]]
* [https://github.com/innovaphone/mapdid/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/mapdid GitHub]

===notify===
The calling Party will get a simple notification without possibility to leave a message (for example for calls beyond working hours).
* [[Howto:Simple_caller_notification_Voicemail_XML_Script]]
* [https://github.com/innovaphone/notify/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/notify GitHub]

===p2n===
Switch a Boolean abject in the innovaphone PBX using an external button.
* [[Howto:Push_to_Night]]
* [https://github.com/innovaphone/p2n/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/p2n GitHub]

===phonerec===
Record using the phone set voice messages and activate them. See also the related article "Simple Message Management" for simple administration of the prompts for users (using a voice menu).
* [[Howto:Record_an_announcement_by_phone]]
* [https://github.com/innovaphone/phonerec/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/phonerec GitHub]

===phonerec2===
Script to record dynamic announcements using a phone for announcing public holidays or special on-the-fly messages.
* [[Howto:V13_Record_an_announcement_by_phone]]
* [https://github.com/innovaphone/phonerec2/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/phonerec2 GitHub]

===php-update-server===
A PHP based Update Server Utility.
* [[Howto:PHP_based_Update_Server_V2]]
* [https://github.com/innovaphone/php-update-server/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/php-update-server GitHub]

===pinfortrunk===
Voice recording using a XML and storage on the CF.
* [[Howto:Pin-code_for_trunk_access]]
* [https://github.com/innovaphone/pinfortrunk/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/pinfortrunk GitHub]

===routepoint===
An ACD VoiceMail Script with logic implemented on external server.
* [[Howto:Create_a_Routepoint_with_external_Call_Distribution_Logic]]
* [https://github.com/innovaphone/routepoint/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/routepoint GitHub]

===rrobinacd===
One particularly ACD strategy, see article if matching with your requests.
* [[Howto:Simple_Round_Robin_ACD_with_Voicemail_XML_Script]]
* [https://github.com/innovaphone/rrobinacd/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/rrobinacd GitHub]

===savecdrs===
Some sample CDRs and two scripts to save CDRs in a text file or SQL database.
* [[Howto:Is_there_any_example_code_or_simple_scripts/programs_in_order_to_put_call-information_into_an_MySQL_(or_similiar)_database_in_order_to_build_CRM-alike_solutions_towards_the_MySQL_DB%3F]]
* [https://github.com/innovaphone/savecdrs/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/savecdrs GitHub]

===simplerec===
Voice recording using a XML and storage on the CF.
* [[Howto:A_Simple_Recording_Solution_On-Top_of_The_innovaphone_Voicemail]]
* [https://github.com/innovaphone/simplerec/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/simplerec GitHub]

===sivr===
Use a XML script for IVR.
* [[Howto:Simple_IVR]]
* [https://github.com/innovaphone/sivr/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/sivr GitHub]

===soapcsharp===
SOAP sample code in C#.
* [[Howto:PBX_SOAP_Api_C-sharp_sample_code]]
* [https://github.com/innovaphone/soapcsharp/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/soapcsharp GitHub]

===soapphp5===
SOAP sample code in PHP.
* [[Howto:SOAP_API_PHP5_Sample_Code]]
* [https://github.com/innovaphone/soapphp5/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/soapphp5 GitHub]

===soapvbdotnet===
SOAP sample code in Visual-Basic.Net.
* [[Howto:SOAP_Api_VisualBasic.Net_Sample_Code]]
* [https://github.com/innovaphone/soapvbdotnet/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/soapvbdotnet GitHub]

===speakclock===
Speaking Clock with Voicemail XML Script.
* [[Howto:Speaking_Clock_with_Voicemail_XML_Script]]
* [https://github.com/innovaphone/speakclock/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/speakclock GitHub]

===spokepre===
Spoken presence means that you take your smart phones and set activity (busy, vacation, meeting, lunch etc.) and time (when you are back).
* [[Howto:Spoken_Presence_with_VoiceMail_XML_Script]]
* [https://github.com/innovaphone/spokepre/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/spokepre GitHub]

===spokpres===
Implement the spoken Presence Feature for DECT and analogue Phones.
* [[Howto:Spoken_Presence_for_DECT]]
* [https://github.com/innovaphone/spokpres/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/spokpres GitHub]

===ticketing===
Create a simple ticketing system with voice recording.
* [[Howto:Ticketing]]
* [https://github.com/innovaphone/ticketing/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/ticketing GitHub]

===trackrecord===
You can record Tracks and build your own voice main-menu for recording them.
* [[Howto:Universal_Track_Recording_Tool]]
* [https://github.com/innovaphone/trackrecord/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/trackrecord GitHub]

===tvm-simplified===
Announcement Before Answering (simplified).
* [[Howto:Announcement_Before_Answering_%28simplified%29]]
* [https://github.com/innovaphone/tvm-simplified/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/tvm-simplified GitHub]

===vmvoicen===
You will be called if a new Voicemail is stored.
* [[Howto:Voice_Notification]]
* [https://github.com/innovaphone/vmvoicen/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/vmvoicen GitHub]

===vm_note===
If a user has one or more messages in his voicemail the following XML sample plays a voice message instead of the usual dial tone.
* [[Howto:Voicemail_MWI_for_analogue_user]]
* [https://github.com/innovaphone/vm_note/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/vm_note GitHub]

===Voice-Note===
With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
* [[Howto:Voice_Note_VoiceMail_XML_Script]]
* [https://github.com/innovaphone/Voice-Note/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/Voice-Note GitHub]

===websocketphp5===
Talking to the v13 Application Platform using PHP.
* [[Howto:Talking_to_the_v13_Application_Platform_using_PHP]]
* [https://github.com/innovaphone/websocketphp5/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/websocketphp5 GitHub]

===whitelst===
White List Service XML Script For Outgoing Calls.
* [[Howto:White_List_Service_XML_Script_For_Outgoing_Calls]]
* [https://github.com/innovaphone/whitelst/archive/refs/heads/main.zip Download as .zip]
* [https://github.com/innovaphone/whitelst GitHub]

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

Howto13r3:Busy lamp field (partner keys) with SIP phone

2023-03-24T10:34:09Z

Ani: New page: ==Applies To== This information applies to * innovaphone PBX, v10sr5 * SIP phones supporting "Dialog Package" according to RFC-4235 <!-- Keywords: enter keywords, foreign translations a...

==Applies To==
This information applies to

* innovaphone PBX, v10sr5
* SIP phones supporting "Dialog Package" according to RFC-4235



==Introduction==
Partner keys are primarily used to monitor the call state of an associated partner.
Usually partner keys fulfill the following functions:
* '''monitoring partner:''' Indicating different call-related states: Idle, Alerting, Busy.
* '''speed dial:''' Pressing the partner key while the partner is in idle state will initiate a call to the partner.
* '''call pickup:''' Pressing the partner key while the partner is in alerting state will initiate a call pickup of the alerting call.

==More Information==

===System Requirements===

===Configuration===

In order make partner keys work, the PBX must notify the device about current state of ongoing calls. 
To achieve that, the monitored user must share his Visibility information to the other users requesting his activity state. The option to be shared at least must be:

Calls (Call with number if you want also to share the number you are having a conversation with)

This can be configured globally by the administrator, or the user can also manually share Visibility information to single users, group/s or domain/s using the Profile app, in the Privacy settings

[[Image:privacymyAppsblf.PNG]]

The NOTIFY request is used to carry an XML formatted dialog info. 
Endpoints can, but need not to subscribe for the "Dialog Event Package" (RFC-4235). 

===Known Problems===
---

===Example===

The watched endpoint (207) receives a call from 211. 
The watcher gets a NOTIFY request with a dialog info about the call in "early" state:

NOTIFY sip:snom@172.16.16.34:1415;line=ojn9itpa SIP/2.0
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728BD;rport
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 18 NOTIFY
Contact: <sip:207@172.16.16.180;user=phone>
Content-Length: 343
Content-Type: application/dialog-info+xml
Max-Forwards: 70
Event: dialog
Subscription-State: active

<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" state="full" version="9">
<dialog id="1" direction="initiator" call-id="e1b50917e909d311824d0090330200d6">
'''<state>early</state>'''
<local>
<identity>sip:207@172.16.16.180</identity>
</local>
<remote>
<identity>sip:211@172.16.16.180</identity>
</remote>
</dialog>
</dialog-info>

SIP/2.0 200 Ok
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728BD;rport=5060
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 18 NOTIFY
Content-Length: 0

While in state "early" the watcher has the chance to pickup this "early" call. 
After the call has been accepted by the watched endpoint (207), the former dialog info is cleared and a new dialog info is send to the watcher about the call in state "proceeding":

NOTIFY sip:snom@172.16.16.34:1415;line=ojn9itpa SIP/2.0
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728BE;rport
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 19 NOTIFY
Contact: <sip:207@172.16.16.180;user=phone>
Content-Length: 349
Content-Type: application/dialog-info+xml
Max-Forwards: 70
Event: dialog
Subscription-State: active

<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" state="full" version="10">
<dialog id="1" direction="initiator" call-id="e1b50917e909d311824d0090330200d6">
'''<state>terminated</state>'''
<local>
<identity>sip:207@172.16.16.180</identity>
</local>
<remote>
<identity>sip:211@172.16.16.180</identity>
</remote>
</dialog>
</dialog-info>

NOTIFY sip:snom@172.16.16.34:1415;line=ojn9itpa SIP/2.0
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728BF;rport
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 20 NOTIFY
Contact: <sip:207@172.16.16.180;user=phone>
Content-Length: 349
Content-Type: application/dialog-info+xml
Max-Forwards: 70
Event: dialog
Subscription-State: active

<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" state="full" version="11">
<dialog id="1" direction="initiator" call-id="e1b50917e909d311824d0090330200d6">
'''<state>proceeding</state>'''
<local>
<identity>sip:207@172.16.16.180</identity>
</local>
<remote>
<identity>sip:211@172.16.16.180</identity>
</remote>
</dialog>
</dialog-info>

SIP/2.0 200 Ok
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728BE;rport=5060
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 19 NOTIFY
Content-Length: 0

SIP/2.0 200 Ok
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728BF;rport=5060
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 20 NOTIFY
Content-Length: 0

After the call has been terminated, the dialog info is cleared:

NOTIFY sip:snom@172.16.16.34:1415;line=ojn9itpa SIP/2.0
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728C1;rport
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 22 NOTIFY
Contact: <sip:207@172.16.16.180;user=phone>
Content-Length: 349
Content-Type: application/dialog-info+xml
Max-Forwards: 70
Event: dialog
Subscription-State: active

<?xml version="1.0"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info" state="full" version="12">
<dialog id="1" direction="initiator" call-id="e1b50917e909d311824d0090330200d6">
'''<state>terminated</state>'''
<local>
<identity>sip:207@172.16.16.180</identity>
</local>
<remote>
<identity>sip:211@172.16.16.180</identity>
</remote>
</dialog>
</dialog-info>

SIP/2.0 200 Ok
Via: SIP/2.0/UDP 172.16.16.180:5060;branch=z9hG4bK-311728C1;rport=5060
From: <sip:207@172.16.16.180;user=phone>;tag=2870350033
To: <sip:snom@172.16.16.180>;tag=bl4qd8azu6
Call-ID: 0ce2cb4794c2-9b374j1ddupd@snomSoft-000413FFFFFF
CSeq: 22 NOTIFY
Content-Length: 0



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

File:PrivacymyAppsblf.PNG

2023-03-24T10:24:32Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T12:31:06Z

Ani:

DRAFT -to do: create app with tel:vmnote to quickly call from myApps - load icon in zip file

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the content of the VNote.zip file in the customer folder.

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the number of the Voice Memo object.

When you hear the "beep", you can start recording your message. This message will be stored in your personal folder, and you can listen to it or download it using the Voicemail app.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T11:31:56Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the content of the VNote.zip file in the customer folder.

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the number of the Voice Memo object.

When you hear the "beep", you can start recording your message. This message will be stored in your personal folder, and you can listen to it or download it using the Voicemail app.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T11:21:38Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Download the Voicemail files from our download page: " http://download.innovaphone.com/ice/6.00 "

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode " and upload the Voicemail files and the VNote.xml file in the custom folder.

'''!!Be aware that you need to upload the files in the "custom" folder, and not the vm_files folder!!'''

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the number of the Voice Memo object.

When you hear the "beep", you can start recording your message. This message will be stored in your personal folder, and you can listen to it or download it using the Voicemail app.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T11:03:21Z

Ani:

DRAFT

==Summary==
Some customers like to save voice notes and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Download the Voicemail files from our download page: " http://download.innovaphone.com/ice/6.00 "

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files " and upload the Voicemail files and the VNote.xml file in the custom folder.

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the number of the Voice Memo object.

When you hear the "beep", you can start recording your message. This message will be stored in your personal folder, and you can listen to it or download it using the Voicemail app.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T11:03:11Z

Ani:

DRAFT

==Summary==
Some customers like to save voice memo and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Note directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r3 PBX (and later) with App Platform.



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This version is supported from v13r3 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Download the Voicemail files from our download page: " http://download.innovaphone.com/ice/6.00 "

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files " and upload the Voicemail files and the VNote.xml file in the custom folder.

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct Voicemail instance name there.

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the number of the Voice Memo object.

When you hear the "beep", you can start recording your message. This message will be stored in your personal folder, and you can listen to it or download it using the Voicemail app.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto:Voice Memo VoiceMail XML Script

2023-03-20T11:02:41Z

Ani: Howto:Voice Memo VoiceMail XML Script moved to Howto:Voice Note VoiceMail XML Script: bad name

#REDIRECT [[Howto:Voice Note VoiceMail XML Script]]

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T11:02:41Z

Ani: Howto:Voice Memo VoiceMail XML Script moved to Howto:Voice Note VoiceMail XML Script: bad name

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T11:00:37Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:31:13Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:30:47Z

Ani: /* Feature description for user */

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:30:06Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:28:50Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:28:37Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:26:24Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:25:56Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:19:32Z

Ani:

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:19:01Z

Ani:

DRAFT

==Summary==
Some customers like to save voice memo and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Memo directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r1 PBX (and later) with App Platform and Voicemail app configured



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This can work also on older firmware (v12 with LinuxAP) with the previous Voicemail concept
In this article, we want to focus on v13 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files " and upload the VNote.xml file in the custom folder.

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct language of your newly installed app ( voicemail_de , voicemail_fr , voicemail_en , ecc ecc)

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the number of the Voice Memo object.

When you hear the "beep", you can start recording your message. This message will be stored in your personal folder, and you can listen to it or download it using the Voicemail app (VNote in this example)

===Installation===
The installation is based on two steps, the first is to copy the right files and the second one is to set up the innovaphone PBX. Here is how:

Connect the CF as a network drive using the normal explorer option.

Make a new directory in your CF.

Copy the XML file and the sound files ([[Howto:Absence_Memo_with_VoiceMail_XML_Script#Download|Download]])in this directory (means: copy all the files of the innovaphone absence memo center in this directory).

Now open a new voicemail object in your PBX. Please note that you will not require a VM license or a registration license for this object (means: this feature is for free). Give a number to this object. This number will be the access code for the innovaphone absence memo center (the number for recording a memo and the number for the call forwarding). Insert the path of your previously created directory and the name of the XML File in the Script URL (AWM.XML).
Example: http://172.16.0.10/DRIVE/CF0/AWN/AWM.xml

In the example the created directory is AWN (like the XML file name).
Now your job is done and the feature is switched on.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:17:08Z

Ani:

DRAFT

==Summary==
Some customers like to save voice memo and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Memo directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r1 PBX (and later) with App Platform and Voicemail app configured



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This can work also on older firmware (v12 with LinuxAP) with the previous Voicemail concept
In this article, we want to focus on v13 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files " and upload the VNote.xml file in the custom folder.

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct language of your newly installed app ( voicemail_de , voicemail_fr , voicemail_en , ecc ecc)

Assign the new Voicemail object to the users you want to be able to use this feature. Doing so, they can see the badge count in myApps, listen and save the Voice Memo directly from the app.

===Feature description for user===
Call the innovaphone absence memo center in order to record an absence memo. You will hear the message “recording” followed by a “beep”; now your message will be recorded. You can modify and call your message box however many times you want. However please note that each new message will substitute (clear) the previous.

To check your recorded message, switch on a call forward unconditional to the innovaphone absence memo center and call your own number. You will hear your recorded message, at the end of the message you will hear the busy tone. Your absence memo is now switched on. A caller will hear your message and then your extension will ring normally and the caller hears the call control tone. You clear your call forward to the innovaphone absence memo center in order to switch off the feature.

Please note that the length of your message is limited to 10 seconds (but can be extended if required) and that this feature can be activated on all the phone sets in a PBX.

===Installation===
The installation is based on two steps, the first is to copy the right files and the second one is to set up the innovaphone PBX. Here is how:

Connect the CF as a network drive using the normal explorer option.

Make a new directory in your CF.

Copy the XML file and the sound files ([[Howto:Absence_Memo_with_VoiceMail_XML_Script#Download|Download]])in this directory (means: copy all the files of the innovaphone absence memo center in this directory).

Now open a new voicemail object in your PBX. Please note that you will not require a VM license or a registration license for this object (means: this feature is for free). Give a number to this object. This number will be the access code for the innovaphone absence memo center (the number for recording a memo and the number for the call forwarding). Insert the path of your previously created directory and the name of the XML File in the Script URL (AWM.XML).
Example: http://172.16.0.10/DRIVE/CF0/AWN/AWM.xml

In the example the created directory is AWN (like the XML file name).
Now your job is done and the feature is switched on.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:15:27Z

Ani:

DRAFT

==Summary==
Some customers like to save voice memo and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Memo directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r1 PBX (and later) with App Platform and Voicemail app configured



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This can work also on older firmware (v12 with LinuxAP) with the previous Voicemail concept
In this article, we want to focus on v13 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "

Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"

Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files " and upload the VNote.xml file in the custom folder.

Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.

Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files

to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.

Also, voicemail_it is used in this example, but you need to configure the correct language of your newly installed app ( voicemail_de , voicemail_fr , voicemail_en , ecc ecc)

===Feature description for user===
Call the innovaphone absence memo center in order to record an absence memo. You will hear the message “recording” followed by a “beep”; now your message will be recorded. You can modify and call your message box however many times you want. However please note that each new message will substitute (clear) the previous.

To check your recorded message, switch on a call forward unconditional to the innovaphone absence memo center and call your own number. You will hear your recorded message, at the end of the message you will hear the busy tone. Your absence memo is now switched on. A caller will hear your message and then your extension will ring normally and the caller hears the call control tone. You clear your call forward to the innovaphone absence memo center in order to switch off the feature.

Please note that the length of your message is limited to 10 seconds (but can be extended if required) and that this feature can be activated on all the phone sets in a PBX.

===Installation===
The installation is based on two steps, the first is to copy the right files and the second one is to set up the innovaphone PBX. Here is how:

Connect the CF as a network drive using the normal explorer option.

Make a new directory in your CF.

Copy the XML file and the sound files ([[Howto:Absence_Memo_with_VoiceMail_XML_Script#Download|Download]])in this directory (means: copy all the files of the innovaphone absence memo center in this directory).

Now open a new voicemail object in your PBX. Please note that you will not require a VM license or a registration license for this object (means: this feature is for free). Give a number to this object. This number will be the access code for the innovaphone absence memo center (the number for recording a memo and the number for the call forwarding). Insert the path of your previously created directory and the name of the XML File in the Script URL (AWM.XML).
Example: http://172.16.0.10/DRIVE/CF0/AWN/AWM.xml

In the example the created directory is AWN (like the XML file name).
Now your job is done and the feature is switched on.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Howto13r3:Voice Note Voicemail XML Script

2023-03-20T10:12:24Z

Ani: New page: DRAFT ==Summary== Some customers like to save voice memo and listen them using myApps/Voicemail app With this new .XML, you can call an internal number, and save a Voice Memo directly i...

DRAFT

==Summary==
Some customers like to save voice memo and listen them using myApps/Voicemail app

With this new .XML, you can call an internal number, and save a Voice Memo directly in myApps. You will be able, later, to listen to it and save it using the Voicemail app.
Here is how.

==Applies To==
This information applies to

* All V13r1 PBX (and later) with App Platform and Voicemail app configured



===System Requirements===
The feature is based on an XML script typically provided by the Voicemail app. This can work also on older firmware (v12 with LinuxAP) with the previous Voicemail concept
In this article, we want to focus on v13 and later.

===Installation===
Install and configure a second Voicemail app in your system: " https://wiki.innovaphone.com/index.php?title=Howto:V13_Create_a_second_Voicemail "
Open the PBX manager, your newly create Voicemail instance, open your new Voicemail app, and flag "custom"
Now connect to your Voicemail app files folder as described here " https://wiki.innovaphone.com/index.php?title=Howto:V13_Access_Voicemail_Files " and upload the VNote.xml file in the customer folder
Open the advanced configuration of your PBX (via the Devices app or directly via browser), and in PBX/Config/Objects, open your newly created Voicemail object.
Change, in the second tab, the URL, that now will point to VNote.xml instead of vm.xml, eg:

from: https://APdnsname/domain.tld/voicemail_it/custom/vm.xml?$app=on&$_pbxmwidir=vm_files
to: https://APdnsname/domain.tld/voicemail_it/custom/VNote.xml?$app=on&$_pbxmwidir=vm_files

be aware that URL is case sensitive, so please pay attention to that.
Also, voicemail_it is used in this example, but you need to configure the correct language of your newly installed app ( voicemail_de , voicemail_fr , voicemail_en , ecc ecc)

===Feature description for user===
Call the innovaphone absence memo center in order to record an absence memo. You will hear the message “recording” followed by a “beep”; now your message will be recorded. You can modify and call your message box however many times you want. However please note that each new message will substitute (clear) the previous.

To check your recorded message, switch on a call forward unconditional to the innovaphone absence memo center and call your own number. You will hear your recorded message, at the end of the message you will hear the busy tone. Your absence memo is now switched on. A caller will hear your message and then your extension will ring normally and the caller hears the call control tone. You clear your call forward to the innovaphone absence memo center in order to switch off the feature.

Please note that the length of your message is limited to 10 seconds (but can be extended if required) and that this feature can be activated on all the phone sets in a PBX.

===Installation===
The installation is based on two steps, the first is to copy the right files and the second one is to set up the innovaphone PBX. Here is how:

Connect the CF as a network drive using the normal explorer option.

Make a new directory in your CF.

Copy the XML file and the sound files ([[Howto:Absence_Memo_with_VoiceMail_XML_Script#Download|Download]])in this directory (means: copy all the files of the innovaphone absence memo center in this directory).

Now open a new voicemail object in your PBX. Please note that you will not require a VM license or a registration license for this object (means: this feature is for free). Give a number to this object. This number will be the access code for the innovaphone absence memo center (the number for recording a memo and the number for the call forwarding). Insert the path of your previously created directory and the name of the XML File in the Script URL (AWM.XML).
Example: http://172.16.0.10/DRIVE/CF0/AWN/AWM.xml

In the example the created directory is AWN (like the XML file name).
Now your job is done and the feature is switched on.

===Known Problems===

== Download ==
*[[Howto:Wiki_Sources#absencememo | download]] the complete file package of scripts and files described in this article.

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

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

Reference13r2:PBX/Objects/Gateway

2023-01-18T14:29:27Z

Ani: New page: The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls th...

The ''Gateway'' PBX object is used to register a gateway with the PBX. A Gateway object in contrast to a User object allows additional dialing digits to be sent. Also for incoming calls the incoming calling party number is passed on.

See [[{{NAMESPACE}}:PBX/Objects#General_Object_Properties]] for generic object properties.

== Gateway Object specific Configuration ==

;Enblock Count: If this number of digits is dialed after the number of the Gateway object itself, the call is sent out as enblock call. This is useful to connect to gateway which are not capable of overlap receiving.

;Enblock as Diverting No: If this checkmark is set, the called party number is transmitted as diverting leg2 information. As called party number the number of the gateway object is sent or no number if the Prefix checkmark is set. This is useful with Microsoft Exchange since this expects the number of the mailbox as diverting number.

;Prefix: If this checkmark is set, the number of the Gateway object itself is removed from the called party number for outgoing calls and added to the calling party number for incoming calls

;Domain: Route calls with matching domain part in the destination to this object.

;Loop Detect: If checked outgoing calls are blocked if a call with identical source and destination addresses already exists.

;International Match: If a call is received, the calling party number is compared to this number. If there is a match (head match) this number is removed from the calling party number, so that only additional digits remain. E.g. on an incoming call from a registration on this Gateway object the CGPN 00049703173009123 will be mapped to 123 (if the number is set to 00049703173009). Note that this comparison is done after the replacements configured in PBX/Config/General/Prefix for ... have been performed

;National Match: Same as 'International Match' only for national calling party number. This comparison is done if the comparison for the International Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 00703173009123 will be mapped to 123 (if the number is set to 00703173009)

;Subscriber Match: Same as 'International Match' only for subscriber calling party number. This comparison is done if the comparison for the National Match above is configured but failed. E.g. on an incoming call from a registration on this Gateway object the CGPN 073009123 will be mapped to 123 (if the number is set to 073009)

;Set incoming call UUI: If configured, this is set to each call coming in thru this gateway object as User User Information (UUI). The UUI can be used to set the identity header on a SIP call, when sending the call on a SIP interface in the gateway.

;Set outgoing call UUI: If configured, this is set to each call going out thru this gateway object as User User Information (UUI).

;Internal Destination: If this checkmark is set, all calls from devices registered at this object are marked as Internal (Numbering plan set to private). This is usefull if systems are registered to this object, which cannot send calls with the private numbering plan but should be regarded as internal (e.g. voicemail systems).

The device registering with a gateway object is normally expected to send local extension numbers as calling party number (i.e. extensions local to the PBX and 'behind' the gateways own number). However, if it sends these numbers as full numbers (that is, including the various prefixes such as county code, are code, trunk, etc.), these can be stripped using the next 3 fields:

;Outgoing Calls No Name: If set no calling Name is sent with outgoing calls

;Outgoing Calls No URL: If set no src-URL is sent with outgoing calls

;No Presence/Dialog Subscribe: If set no subscribe sessions are forwarded thru this gateway object

;No Inband Disconnect: If this checkmark is set, a call disconnect with inband information will not be forwarded to the endpoint registered to the user, but the call will be cleared immediatelly without the inband information beeing sent..

;Fax License: TBD.

;Obtain Channels lic on outgoing call: If this checkmark is set, a PBX Channels license will be acquired for calls to a Conference interface. PBX Channels licenses must be installed on the PBX for this to work.

;Filter: The filter configured here restricts the numbers which may be called by through this object. "Called by" means [[Course13:IT_Advanced_-_07_More_on_advanced_PBX_object_properties_and_behavior#Disallowing_incoming_external_Calls|restriction to incoming calls only]].

== Multiple Gateway Registrations ==

If multiple Gateways are registered to a Gateway object, Gateways registered to the same device config are used round-robin. The gateways registered to different devices are used in the sequence of the configured devices.

== Call Diversions ==
;CFU: If configured a CFU is executed, so calls to the Gateways object are diverted.
;CFB: A CFB is executed if a call is rejected with ''User Busy'' by remote destination
;CFNR: A CFNR is executed if a call is rejected because of a local problem (''no channel'', ''no gatway registered'', ...)

Howto13r1:Conferences, Resources and Licenses

2023-01-18T11:31:32Z

Ani:

==Applies To==
This information applies to

all innovaphone devices supporting a ''CONF'' or ''SCNF'' interface and hence ''Conference Channels'' (as shown in the devices home-page).



==More Information==
Performing conferencing on a [[Reference10:Gateway/Interfaces#Conferencing_interface_.28CONF.29 | ''CONF or SCNF'' interface]] consumes both resources and licenses. Here is an overview of which and how much.

=== Overview ===

First let us have a look at the overall scheme:

[[Image:Conferences,_Ressources_and_Licenses_-_Scheme2.png]]

==== Coder channels ====
Both the ''CONF'' and ''SCNF'' interface provides the mixing of 8KHz G711 PCM audio channels.

If a call is done towards a CONF interface, it will allocate a ''Coder channel'' from the DSP coder channel bank for processing of the audio from the VoIP codec (e.g. G.711, G.722, OPUS) to PCM audio.

The SCNF however supports G.711a/u coder only (which is basically PCM). For this reason, no ''Coder channel'' needs to be allocated for a call.

==== (Soft) Conference Channels ====
Each call to a CONF interface consumes one of the ''Conference Channels''.

Each call to an SCNF interface consumes one of the ''Soft Conference Channels''.

==== Channels license ====

In addition to that, a call to either the CONF or SCNF requires a ''Channel'' license. This license can be obtained from the PBX if the ''PBX Channels licenses'' switch in the PBX [[Reference13r1:PBX/Objects/Conference | ''Conference'' object ]] is activated (if the call comes through such an object). For this, ''PBX Channels licenses'' must be installed on the PBX.

This is the recommended configuration. However, the ''Channel'' license can also be obtained locally from the gateway where the CONF/SCNF is located on. All innovaphone gateways have a number of ''Channel'' licenses built-in. The number of licenses available is euql to the number of ''Coder'' channels the box supports. If no license is sent along with the call to the CONF or SCNF interface, the interface will try to obtain one from the pool of built-in licenses. This can save you some cost. However, be aware that these licenses (as well as the corresponding ''Channel'' coders) are also required for calls through the ISDN BRI/PRI interfaces or for audio fax calls. Calls to CONF/SCNF interfaces which consume local ''Channel'' licenses may inhibit such calls therefor.

The PBX-Channels License has order no. 02-00020-007 according to chapter "3.5 PBX Channels license" in the [https://www.innovaphone.com/content/downloads/innovaphone-Licensing%20Guidelines-V13r2-EN.pdf innovaphone license guide].

The [[Reference13r1:PBX/Config/General#License_Status|status of the PBX Licenses]] shows assigned PBX-Channel licenses:

[[Image:Conferences,_Ressources_and_Licenses_-_pbx-channel_license_01.png]]

==== Port license ====
The registration of the CONF and/or SCNF to the PBX Conference object does not require a Port license.

Although this is not directly related to the CONF or SCNF interface, please note that a single ''Port'' license is required if any of the rooms defined in a PBX ''Conference'' object is accessed using the conference web access (from 13r3).

===Example Scenarios===

====Conference on hardware gateway with local ISDN====
Let us assume we have a conference running on a CONF interface with one PSTN and 3 VoIP participants. In this case, we have

{| border=1
| ||Caller || DSP Coder Channel || Conference Channel || PBX Channel License
|-
| ||1 PSTN || 1 (CONF) + 1 (ISDN) **|| 1 || 1
|-
| ||3 VoIP || 3|| 3 || 3
|-
| Total || 4 || 5 || 4 || 4
|}
<nowiki>**</nowiki>: {{FIXME|reason=do we need only one or would this require ''enable PCM''?}}

Looking at an IP411, it supports the following resources:

[[Image:Conferences,_Ressources_and_Licenses_-_example_gateway_channels_IP411.png]]

We can see that our sample scenario will not work on an IP411 as there are no ''Conference Channels'' available. However, if we change the scenario so that an SCNF is used instead of a CONF, it would look as follows:

{| border=1
| ||Caller || DSP Coder Channel || Soft Conference Channel || PBX Channel License
|-
| ||1 PSTN || 1 (ISDN) **|| 1 || 1
|-
| ||3 VoIP || 3|| 3 || 3
|-
| Total || 4 || 4 || 4 || 4
|}

This will work on an IP411.

=== 3PTY Conferencing ===
3-way conferencing is special as it is usually implemented internally in the innovaphone IP phones. That is, each user of an innovaphone IP phone (except the IP61) has internal conferencing resources built-in to allow for a 3-way conference. No external ''CONF/SCNF'' interface is needed.

However, on innovaphone DECT phones, no internal conferencing resource is present and hence no internal 3PTY is possible. The DECT system can thus be [[Reference9:3pty conference on DECT phones|configured to use an external conferencing resource]] for 3PTY. In this case, the rules above apply.

== Related Articles ==
* [[Reference9:Concept myPBX]]
* [[Reference10:Concept Innovaphone Virtual Appliance]]
* [[Reference9:3pty conference on DECT phones]]
* [[Reference10:Gateway/Interfaces#Conferencing_interface_.28CONF.29]]
* [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported]], lists DSP and CONF resources for the different gateway platforms

[[Category:Howto|{{PAGENAME}}]]
[[Category:Concept_Conference]]

Howto13r2:Conferences, Resources and Licenses

2023-01-18T11:30:01Z

Ani: New page: ==Applies To== This information applies to all innovaphone devices supporting a ''CONF'' or ''SCNF'' interface and hence ''Conference Channels'' (as shown in the devices home-page). <!--...

==Applies To==
This information applies to

all innovaphone devices supporting a ''CONF'' or ''SCNF'' interface and hence ''Conference Channels'' (as shown in the devices home-page).



==More Information==
Performing conferencing on a [[Reference10:Gateway/Interfaces#Conferencing_interface_.28CONF.29 | ''CONF or SCNF'' interface]] consumes both resources and licenses. Here is an overview of which and how much.

=== Overview ===

First let us have a look at the overall scheme:

[[Image:Conferences,_Ressources_and_Licenses_-_Scheme2.png]]

==== Coder channels ====
Both the ''CONF'' and ''SCNF'' interface provides the mixing of 8KHz G711 PCM audio channels.

If a call is done towards a CONF interface, it will allocate a ''Coder channel'' from the DSP coder channel bank for processing of the audio from the VoIP codec (e.g. G.711, G.722, OPUS) to PCM audio.

The SCNF however supports G.711a/u coder only (which is basically PCM). For this reason, no ''Coder channel'' needs to be allocated for a call.

==== (Soft) Conference Channels ====
Each call to a CONF interface consumes one of the ''Conference Channels''.

Each call to an SCNF interface consumes one of the ''Soft Conference Channels''.

==== Channels license ====

In addition to that, a call to either the CONF or SCNF requires a ''Channel'' license. This license can be obtained from the PBX if the ''PBX Channels licenses'' switch in the PBX [[Reference13r1:PBX/Objects/Conference | ''Conference'' object ]] is activated (if the call comes through such an object) or the ''Obtain Channels lic on outgoing call'' check-mark is ticked in a [[Reference13r1:PBX/Objects/Gateway | PBX ''Gateway'' object ]] (if the call comes through such an object). For this, ''PBX Channels licenses'' must be installed on the PBX.

This is the recommended configuration. However, the ''Channel'' license can also be obtained locally from the gateway where the CONF/SCNF is located on. All innovaphone gateways have a number of ''Channel'' licenses built-in. The number of licenses available is euql to the number of ''Coder'' channels the box supports. If no license is sent along with the call to the CONF or SCNF interface, the interface will try to obtain one from the pool of built-in licenses. This can save you some cost. However, be aware that these licenses (as well as the corresponding ''Channel'' coders) are also required for calls through the ISDN BRI/PRI interfaces or for audio fax calls. Calls to CONF/SCNF interfaces which consume local ''Channel'' licenses may inhibit such calls therefor.

The PBX-Channels License has order no. 02-00020-007 according to chapter "3.5 PBX Channels license" in the [https://www.innovaphone.com/content/downloads/innovaphone-Licensing%20Guidelines-V13r2-EN.pdf innovaphone license guide].

The [[Reference13r1:PBX/Config/General#License_Status|status of the PBX Licenses]] shows assigned PBX-Channel licenses:

[[Image:Conferences,_Ressources_and_Licenses_-_pbx-channel_license_01.png]]

==== Port license ====
The registration of the CONF and/or SCNF to the PBX Conference object does not require a Port license.

Although this is not directly related to the CONF or SCNF interface, please note that a single ''Port'' license is required if any of the rooms defined in a PBX ''Conference'' object is accessed using the conference web access (from 13r3).

===Example Scenarios===

====Conference on hardware gateway with local ISDN====
Let us assume we have a conference running on a CONF interface with one PSTN and 3 VoIP participants. In this case, we have

{| border=1
| ||Caller || DSP Coder Channel || Conference Channel || PBX Channel License
|-
| ||1 PSTN || 1 (CONF) + 1 (ISDN) **|| 1 || 1
|-
| ||3 VoIP || 3|| 3 || 3
|-
| Total || 4 || 5 || 4 || 4
|}
<nowiki>**</nowiki>: {{FIXME|reason=do we need only one or would this require ''enable PCM''?}}

Looking at an IP411, it supports the following resources:

[[Image:Conferences,_Ressources_and_Licenses_-_example_gateway_channels_IP411.png]]

We can see that our sample scenario will not work on an IP411 as there are no ''Conference Channels'' available. However, if we change the scenario so that an SCNF is used instead of a CONF, it would look as follows:

{| border=1
| ||Caller || DSP Coder Channel || Soft Conference Channel || PBX Channel License
|-
| ||1 PSTN || 1 (ISDN) **|| 1 || 1
|-
| ||3 VoIP || 3|| 3 || 3
|-
| Total || 4 || 4 || 4 || 4
|}

This will work on an IP411.

=== 3PTY Conferencing ===
3-way conferencing is special as it is usually implemented internally in the innovaphone IP phones. That is, each user of an innovaphone IP phone (except the IP61) has internal conferencing resources built-in to allow for a 3-way conference. No external ''CONF/SCNF'' interface is needed.

However, on innovaphone DECT phones, no internal conferencing resource is present and hence no internal 3PTY is possible. The DECT system can thus be [[Reference9:3pty conference on DECT phones|configured to use an external conferencing resource]] for 3PTY. In this case, the rules above apply.

== Related Articles ==
* [[Reference9:Concept myPBX]]
* [[Reference10:Concept Innovaphone Virtual Appliance]]
* [[Reference9:3pty conference on DECT phones]]
* [[Reference10:Gateway/Interfaces#Conferencing_interface_.28CONF.29]]
* [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported]], lists DSP and CONF resources for the different gateway platforms

[[Category:Howto|{{PAGENAME}}]]
[[Category:Concept_Conference]]

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-11-24T12:25:10Z

Ani: /* Known issues */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

=== Limitations ===

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

In case you have a TURN Server already in use you can enable the TURN setting as well. In this case you would route RTP traffic to the TURN Server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Beta phase: at the moment only the PBX can be used for media relay, so port forwarding from external to internal must point directly to the PBX excluding TURN server test until further notice. Also, calling a Voicemail has no audio, while calling a conference there is no audio after the PIN is dialed.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Reference13r3:Concept Third Party Phones

2022-11-24T11:08:34Z

Ani:

innovaphone phones use ICE and DTLS-SRTP for direct media compatibility with WebRTC. This way media can be exchanged directly between the phones and a Browser, which offloads the PBX from media forwarding. Many third party phones do not support ICE or DTLS-SRTP, for this reason a configuration which includes media relay in the PBX for these phones is recommended. The configuration for third party phones consists of the following components:
* Media Relay set for the device
* Optionally a TURN Server within the private network
* Port forwarding from the NAT-Router to the internal TURN Server or to the PBX

== Phones within the same Network as the PBX ==

For phones within the same network as the PBX, it is sufficient to configure Media Relay at the device settings for the phones. This way normal media negotiation happens between the Phone and the PBX and the RTP data is exchanged between phone and PBX. The PBX forwards the RTP data to the other endpoint. This elimnates media negotiation compatibilty issues of theses phones with any other endpoint within the system.

On the other hand it create additional CPU load on the PBX for the forwarding. Esspecially decryption and encryption of the forwarded RTP data creates some load. This is needed, because WebRTC endpoints or innovaphone phones use DTLS-SRTP for encryption, which is in this case terminated within the PBX.

== Phones from outside the PBX network ==

For phones from outside the PBX network several issues have to be addressed: Registration to the PBX, RTP NAT traversal and security.

=== Registration ===

To forward the registration from the outside network to the PBX is done by the innovaphone reverse proxy. Just port forwarding from the firewall or the NAT router is not good enough, because the information that the registration is forwarded from outside is needed for the media mechanisms. SIP TCP or TLS has to be used for the registration, because UDP is not supported by the innovaphone reverse proxy.

To save public IP addresses, the reverse proxy can be placed within the PBX network. In this case port forwarding to the reverse proxy has to be configured on the firewall or NAT router. The port forwarding is needed for SIP(S), HTTP(S), H323(s) and LDAP(s).

On the PBX the reverse proxy or the reverse proxies must be configured, so that the PBX knows, that the registration is received from the outside and can adjust the media negotiation accordingly. If TLS authentication shall be used, the certificate names of the reverse proxies need to be configured as well. The reverse proxy checks that the certificate matches with the registration name and the PBX checks the certificate of the reverse proxy.

=== RTP NAT traversal ===

NAT traversal needs to be solved at two places: The firewall / NAT router of the PBX network and the firewall / NAT router of the phone.

==== PBX Network ====

RTP data has to be sent from the phone to the PBX or the internal TURN server. This can be achieved by providing the public IP address of the firewall or NAT router to the phone within the SDP. For this reason this address can be configured at the PBX. On the firewall / NAT router a UDP port forwarding to the PBX or the internal TURN server has to be configured for the RTP port range configured on the PBX or the TURN server.

==== Phone Network ====

The phone provides an internal IP address with the SDP to receive RTP. To this IP address no RTP can be sent from the outside. So to be able to send to the phone an algorithm called RTP latching is implemented on the PBX and on the TURN server. This algorithm simply changes the destination address for SDP to the address from which RTP data from the phone is received. This is the public IP address and NAT port of the NAT router of the phone network. The NAT on this router forwards the RTP to the phone.

=== Security ===

To avoid that data can be sent directly to the PBX a TURN server can be used internally. The security issue here is a potential denial of service attack by sending a lot of data to the PBX. To use a TURN server the TURN checkmark has to be set on the PBX config page. If the firewall of the PBX network has denial of service protection on these ports which are forwarded to the PBX, the TURN server is not needed for this purpose.

== Known Problems ==

[[:Category:Problem Third Party Phones|Known Problems]]
[[Category:Concept_Third party phones]]

Category:Problem Third Party Phones

2022-11-24T10:54:17Z

Ani: New page: Third Party Phones Known Problems

Third Party Phones Known Problems

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-11-11T14:22:33Z

Ani: /* Known issues */

{{FIXME|reason=This product is in the beta phase and is not yet finished}}

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

=== Limitations ===

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

In case you have a TURN Server already in use you can enable the TURN setting as well. In this case you would route RTP traffic to the TURN Server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==
Beta phase: at the moment only the PBX can be used for media relay, so port forwarding from external to internal must point directly to the PBX excluding TURN server test until further notice.

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Howto13r3:Step-by-Step Media Relay connection for third party phone

2022-11-11T13:09:35Z

Ani:

{{FIXME|reason=This product is in the beta phase and is not yet finished}}

[[Category:Step-by-Step]]

{{HOWTOMOD13r3 Translation Info}}

This article defines the recommended configuration to connect third party phones. The configuration ensures media connectivity and compatibility to WebRTC without relying on ICE and DTLS on the phone.

[[Image:Media-relay-endpoints-overview.png]]

== Purpose ==
A common problem is that third-party SIP phones do not support ICE or DTLS. As a result audio connections across NAT boundaries are often a challenge. To solve this problem, you can enable Media Relay, but the Media Relay endpoint address must be a public IP address so that the external SIP phone can send its audio to this address.

Furthermore, WebRTC endpoints require ICE and DTLS to establish an audio connection. Since not all SIP phones support these features, enabling Media Relay for these 3rd party phones solves this issue.

=== Features ===
*Send Audio traffic across NAT boundaries without using the ICE mechanism.

=== Limitations ===

== Requirements ==
*The firmware has to be at least 13r3
*innovaphone PBX
*3rd party SIP phone
*A reverse proxy for forwarding SIP messages (optional - only necessary if you connect an external 3rd party phone)
*TURN Server (optional - you can route RTP traffic to the PBX directly if you have no TURN server)

== Things to know before you begin ==
*The public IP address of the network (External IP of the Firewall or NAT Router)
*You must have access to the firewall or NAT router to be able to configure port forwardings

== Configuration ==
In this scenario, we are going to configure the above picture to allow an external third party SIP device to send its audio to an internal destination. This Wiki article does not explain how to register a SIP phone to an innovaphone PBX via a reverse proxy. If you need help to accomplish this, please read the instructions in our [[Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29|Advanced Training Part 2]] materials.

Please register your SIP device to your PBX via the reverse proxy.

=== Configuration on the User Object ===
Please set the option ''Media Relay'' on the hardware ID of the user object on which your SIP device is registered. Do not set the Media Relay option globally in the PBX (PBX/Config/General)! This option is no longer required as you can enable Media Relay for each hardware ID individually.

[[Image:Media-relay-endpoints-1.png]]

=== Configuration of the PBX ===
Under PBX/Config/General of your Advanced UI you will find a configuration option called ''Media Relay Endpoints''. You have to enter the public IP address of your firewall or NAT router here. The PBX sends this IP address as the "connection address" in the SDP for all devices that are registered via the reverse proxy and use Media Relay. (see first step)

In case you have a TURN Server already in use you can enable the TURN setting as well. In this case you would route RTP traffic to the TURN Server first.

[[Image:Media-relay-endpoints-2.png]]

===RTP Range Configuration===
You need to create an RTP port range on either the PBX or the TURN server, depending on whether the TURN flag is active or not. Please go to IP4/General/Settings on your device (PBX or TURN Server) and configure the ''First UDP-RTP Port'' and then the ''Number of Ports''.

[[Image:Media-relay-endpoints-3.png]]

===Firewall Configuration===
You need to create port forwardings on your firewall. Depending on whether the ''TURN'' flag is on or off, a port forwarding for the RTP/UDP ports must be configured towards the PBX (if no ''TURN'' flag is set) or the TURN server (if ''TURN'' flag is set). E.g If you configured a RTP port Range 16384 to 16583, a port forwarding for those exact ports have to be configured on your firewall.

== Verification ==

Please call any extension number in your PBX. You should be able to hear and talk to the other party on the call.

== Known issues ==

== Related Articles ==
*[[Reference13r3:Concept Third Party Phones]]

Reference13r3:Concept Third Party Phones

2022-10-28T06:21:21Z

Ani:

innovaphone phones use ICE and DTLS for direct media compatibility with WebRTC. This way media can be exchanged directly between the phones and a Browser, which offloads the PBX from media forwarding. Many third party phones do not support ICE or DTLS, for this reason a configuration which includes media relay in the PBX for these phones is recommended. The configuration for third party softphones consists of the following components:
* Media Relay set for the device
* Optionally a TURN Server within the private network
* Port forwarding from the NAT-Router to the internal TURN Server or to the PBX

== Phones within the same Network as the PBX ==

For phones within the same network as the PBX, it is sufficient to configure Media Relay at the device settings for the phones. This way normal media negotiation happens between the Phone and the PBX and the RTP data is exchanged between phone and PBX. The PBX forwards the RTP data to the other endpoint. This elimnates media negotiation compatibilty issues of theses phones with any other endpoint within the system.

On the other hand it create additional CPU load on the PBX for the forwarding. Esspecially decryption and encryption of the forwarded RTP data creates some load. This is needed, because WebRTC endpoints or innovaphone phones use DTLS for encryption, which is in this case terminated within the PBX.

== Phones from outside the PBX network ==

For phones from outside the PBX network several issues have to be addressed: Registration to the PBX RTP NAT traversal and security.

=== Registration ===

To forward the registration from the outside network to the PBX is done by the innovaphone reverse proxy. Just port forwarding from the firewall or the NAT router is not good enough, because the information that the registration is forwarded from outside is needed for the media mechanisms. SIP TCP or TLS has to be used for the registration, because UDP is not supported by the innovaphone reverse proxy.

To save public IP addresses, the reverse proxy can be placed within the PBX network. In this case port forwarding to the reverse proxy has to be configured on the firewall or NAT router. The port forwarding is needed for SIP(S), HTTP(S), H323(s) and LDAP(s).

On the PBX the reverse proxy or the reverse proxies must be configured, so that the PBX knows, that the registration is received from the outside and can adjust the media negotiation accordingly. If TLS authentication shall be used, the certificate names of the reverse proxies need to be configured as well. The reverse proxy checks that the certificate matches with the registration name and the PBX checks the certificate of the reverse proxy.

=== RTP NAT traversal ===

NAT traversal needs to be solved at two places: The firewall / NAT router of the PBX network and the firewall / NAT router of the phone.

==== PBX Network ====

RTP data has to be sent from the phone to the PBX or the internal TURN server. This can be achieved by providing the public IP address of the firewall or NAT router to the phone within the SDP. For this reason this address can be configured at the PBX. On the firewall / NAT router a UDP port forwarding to the PBX or the internal TURN server has to be configured for the RTP port range configured on the PBX or the TURN server.

==== Phone Network ====

The phone provides an internal IP address with the SDP to receive RTP. To this IP address no RTP can be sent from the outside. So to be able to send to the phone an algorithm called RTP latching is implemented on the PBX and on the TURN server. This algorithm simply changes the destination address for SDP to the address from which RTP data from the phone is received. This is the public IP address and NAT port of the NAT router of the phone network. The NAT on this router forwards the RTP to the phone.

=== Security ===

To avoid that data can be sent directly to the PBX a TURN server can be used internally. The security issue here is a potential denial of service attack by sending a lot of data to the PBX. To use a TURN server the TURN checkmark has to be set on the PBX config page. If the firewall of the PBX network has denial of service protection on these ports which are forwarded to the PBX, the TURN server is not needed for this purpose.

Howto:Use soft conference interface with bc conference object

2022-03-01T14:22:12Z

Ani:

==Applies To==
This information applies to
* PBX with firmware with at least 13r1 sr13 or 13r2

==More Information==
General information about [https://wiki.innovaphone.com/index.php?title=Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported]

===Details===
In the past, BC conference ( https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference ) were using the default conference interface or an external conference interface.

With the new v13, from 13r1 sr13, we can use soft conference channel together with the BC conference to make it works.

To do so, simply configure in the BC conference object, as hardware ID, macaddress-SCNF (for example, 0090330000-SCNF), where the mac address is the gateway were soft conference are available, and in the conference object, as hardware ID the same (for example, 0090330000-SCNF), and in the Devices tab, the same Hardware ID.

=== Conclusion ===
Now is possible to use soft conference also when configuring a BC conference object.

Howto:Use soft conference interface with bc conference object

2022-03-01T14:16:53Z

Ani: New page: ==Applies To== This information applies to * PBX with firmware with at least 13r1 sr13 or 13r2  ==More Information== General inf...

==Applies To==
This information applies to
* PBX with firmware with at least 13r1 sr13 or 13r2

==More Information==
General information about [https://wiki.innovaphone.com/index.php?title=Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported]

===Details===
In the past, BC conference ( https://wiki.innovaphone.com/index.php?title=Reference9:PBX/Objects/Call_Broadcast_Conference ) were using the default conference interface or an external conference interface.

With the new v13, from 13r1 sr13, we can use soft conference channel together with the BC conference to make it works.

To do so, simply configure in the BC conference object, as hardware ID, macaddress-SCNF (for example, 0090330000-SCNF), where the mac address is the gateway were soft conference are available.

=== Conclusion ===
Now is possible to use soft conference also when configuring a BC conference object.

Reference13r2:Concept App Platform

2021-12-22T08:58:27Z

Ani:

= 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:
** /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 AP (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 AP in a specific scenario, we see that in a real life environment an AP 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).

= 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:
** /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

= 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 [[Reference13r1:IP4/ETH/IP|ETH0]] or [[Reference13r1: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 [[Reference13r1:IP4/ETH/IP|ETH0]] or [[Reference13r1: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=Reference12r1: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 [[Reference13r1: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/11/auth-pg-hba-conf.html

== 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.

We recommend using instance names so that length(name) + length(domain) is less than 63 charcaters.

== 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 AP for one customer
* One AP for many customers
* Many APs for one customer
* Many APs for many customers

Attention: The V13 installer can only configure the scenario "''One AP 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 APs.

== 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.

= AP Manager settings =

== General ==
* ''Enable Developer mode'': in developer mode, apps can be manually uploaded without an App Store
* ''Disable App security'': each App has an own unix user and if this flag is set, the user can login with SSH for debugging
* ''App Store URL'': the URL to the App Store where Apps are searched and also an update of the AP image itself
* ''Devices app URL'': the URL to the Devices App to manage the AP through Devices
* ''Devices app URL 2'': don't use!
* ''App Platform DNS name'': currently not used
* ''NTP server 1/2'': NTP servers for this AP (in addition to NTP servers retrieved by DHCP)
* ''Timezone string'':
* ''DNS server 1/2'': DNS servers for this AP (in addition to DNS servers retrieved by DHCP)
* ''Command file'': obsolete, use the Devices App for backups!

== Security ==
* ''Webserver certificate'': upload a webserver certificate in PEM format
* ''AP Manager password'': the password to the web interface of the AP Manager (normally set through Devices)
* ''Linux root user'': password of the root user (normally set through Devices)
* ''Linux admin user'': password of the admin user (normally set through Devices)

== Alarms and events ==
* ''URL'': URL to the Events app
* ''Username/Password'': HTTP credentials of the Events app
* ''Email address'': an email address which will get emails on full disk alarms/warnings
* ''Threshold'': All Apps will be stopped and an hourly email sent on reaching this threshold. An alarm is generated 10% before reaching this threshold and an email is sent every 24 hours.

== SMTP ==
SMTP server settings for sending emails from within the AP Manager.

== Registered Access Domains ==

= Known Issues =

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

If it happens, that the AP 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 AP booted the ramdisk. 
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 AP should boot and run the already updated image.

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

If it happens, that the AP 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 AP and '''Stop''' it. 
* Set '''Kernel command line''' to '''/dev/ram0'''. 
* Set '''Initrd file''' to '''ramdisk.ext2.xz'''. 
* Set '''Ramdisk size''' to '''100000'''. 
* '''Start''' the AP now. 

The AP now either applies the image update or it reboots into the old image. Try the image update afterwards 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. 

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

= How-Tos =

== How to retrieve files from the AP ==
To retrieve files from the AP which can not be retrieved via the AP manager UI, you can connect to the AP using the SCP protocol on port 22.

For example, in WinSCP
* use ''SCP'' as protocol (NB: WebDAV is not supported on most of the directories on the AP)
* use the ''DNS'' name or IP address of your AP (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''/home/admin'' as start directory
* 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/...). 

Use the following command to generate a tar with all log files under /home/admin:
tar -cf /home/admin/logs.tar --exclude=/var/log/core_dumps/* /var/log/*

== App Platform disk space warning ==

If the configured threshold is reached, all Apps are stopped inside the AP. 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
* 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 AP ===
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 [[Reference13r1: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 AP Manager.

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

== Resizing the disk of a Virtual machine ==

* 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 databse 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.

'''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 AP Platform you must change records manually '''in the described order'''!
You have to know the Admin password to directly Login to the AP-Plattform.

=== 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 ...)
* [[Reference9:Gateway/CDR|CDRx]]
* [[Reference13r1:PBX/Config/General|IP address for App Platform]]
* [[Reference13r1:PBX/Config/myApps|Reset Password Page]]
* [[Reference13r1:PBX/Config/Authentication|Verification link]]

Depending on your change you have to activate/deactivate the Setting [[Reference13r1: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 AP.

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
** 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]]

Reference13r2:Concept App Platform

2021-12-22T08:45:16Z

Ani:

= 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:
** /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 AP (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 AP in a specific scenario, we see that in a real life environment an AP 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).

= 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:
** /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

= 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 [[Reference13r1:IP4/ETH/IP|ETH0]] or [[Reference13r1: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 [[Reference13r1:IP4/ETH/IP|ETH0]] or [[Reference13r1: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=Reference12r1: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 [[Reference13r1: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/11/auth-pg-hba-conf.html

== 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.

App instances combination of name + database can't exceed 63 characters.

== 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 AP for one customer
* One AP for many customers
* Many APs for one customer
* Many APs for many customers

Attention: The V13 installer can only configure the scenario "''One AP 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 APs.

== 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.

= AP Manager settings =

== General ==
* ''Enable Developer mode'': in developer mode, apps can be manually uploaded without an App Store
* ''Disable App security'': each App has an own unix user and if this flag is set, the user can login with SSH for debugging
* ''App Store URL'': the URL to the App Store where Apps are searched and also an update of the AP image itself
* ''Devices app URL'': the URL to the Devices App to manage the AP through Devices
* ''Devices app URL 2'': don't use!
* ''App Platform DNS name'': currently not used
* ''NTP server 1/2'': NTP servers for this AP (in addition to NTP servers retrieved by DHCP)
* ''Timezone string'':
* ''DNS server 1/2'': DNS servers for this AP (in addition to DNS servers retrieved by DHCP)
* ''Command file'': obsolete, use the Devices App for backups!

== Security ==
* ''Webserver certificate'': upload a webserver certificate in PEM format
* ''AP Manager password'': the password to the web interface of the AP Manager (normally set through Devices)
* ''Linux root user'': password of the root user (normally set through Devices)
* ''Linux admin user'': password of the admin user (normally set through Devices)

== Alarms and events ==
* ''URL'': URL to the Events app
* ''Username/Password'': HTTP credentials of the Events app
* ''Email address'': an email address which will get emails on full disk alarms/warnings
* ''Threshold'': All Apps will be stopped and an hourly email sent on reaching this threshold. An alarm is generated 10% before reaching this threshold and an email is sent every 24 hours.

== SMTP ==
SMTP server settings for sending emails from within the AP Manager.

== Registered Access Domains ==

= Known Issues =

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

If it happens, that the AP 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 AP booted the ramdisk. 
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 AP should boot and run the already updated image.

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

If it happens, that the AP 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 AP and '''Stop''' it. 
* Set '''Kernel command line''' to '''/dev/ram0'''. 
* Set '''Initrd file''' to '''ramdisk.ext2.xz'''. 
* Set '''Ramdisk size''' to '''100000'''. 
* '''Start''' the AP now. 

The AP now either applies the image update or it reboots into the old image. Try the image update afterwards 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. 

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

= How-Tos =

== How to retrieve files from the AP ==
To retrieve files from the AP which can not be retrieved via the AP manager UI, you can connect to the AP using the SCP protocol on port 22.

For example, in WinSCP
* use ''SCP'' as protocol (NB: WebDAV is not supported on most of the directories on the AP)
* use the ''DNS'' name or IP address of your AP (not the PBX)
* use user ''admin'' and the appropriate password (''ipapps'' by default)
* use ''/home/admin'' as start directory
* 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/...). 

Use the following command to generate a tar with all log files under /home/admin:
tar -cf /home/admin/logs.tar --exclude=/var/log/core_dumps/* /var/log/*

== App Platform disk space warning ==

If the configured threshold is reached, all Apps are stopped inside the AP. 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
* 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 AP ===
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 [[Reference13r1: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 AP Manager.

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

== Resizing the disk of a Virtual machine ==

* 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 databse 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.

'''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 AP Platform you must change records manually '''in the described order'''!
You have to know the Admin password to directly Login to the AP-Plattform.

=== 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 ...)
* [[Reference9:Gateway/CDR|CDRx]]
* [[Reference13r1:PBX/Config/General|IP address for App Platform]]
* [[Reference13r1:PBX/Config/myApps|Reset Password Page]]
* [[Reference13r1:PBX/Config/Authentication|Verification link]]

Depending on your change you have to activate/deactivate the Setting [[Reference13r1: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 AP.

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
** 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]]

Reference12r2:Concept Softwarephone

2021-09-28T09:14:54Z

Ani:

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

= General =

Innovaphone SoftwarePhone is the implementation of innovaphones HW phones software as a Windows process. So all the features native to the hardwarephones are present in SoftwarePhone as well. SoftwarePhone has no UI, it is operated via myPBX or 3rd Party CTI client (ex: Estos Procall).

=System Requirements=
The innovaphone SoftwarePhone requires:
*Windows 7 or higher
*innovaphone PBX with SoftwarePhones<v> License.
*innovaphone myPBX UC-Client as frontend with myPBX- or UC-license

= Installation =

Prior to installing the 10.00 Version of innovaphone SoftwarePhone an eventually installed 9.00 version must be manually deinstalled. From version 10.00 to 12r1 subsequent releases can be updated without first deinstalling the older version. From 12r2 on prior versions must be manually deinstalled.
When updating the installation, the previous configuration (if existing) is reused. Otherwise a default configuration is installed.
There are 2 ways to install Softwarephone:

* SetupSWPhone.exe. This is the preferred method if no installation parameters are required. It automatically installs all 3rd party SW to operate the headsets
* softwarephone.msi AND SpokesSDKNativeRuntime.msi. If the Softwarephone installation needs to be parametrized via Orca first install SpokesSDKNativeRuntime.msi, then
softwarephone.msi
* In our newest download packet, if you aren't using our exe file please install first HubSDKNativeRuntime.msi, Sennheiser_SDK_v7.5.9600.msi and than softwarephone.msi. Delete first the old pakets and install than the new ones.

The following items are installed:

* SoftwarePhone .exe and related files (dll) in Program files (x86)\innovaphone\SoftwarePhone
* Hid.tbl (the code definitoins of supported USB headsets) in Program files (x86) \innovaphone\SoftwarePhone
* The config files „swphone_config.cfg“ and „swphone_command.cfg” in the User Roaming directory (if no previous configuration is located there, otherwise the old configuration is used, Roaming Directory Location : <drive>:\Users\<User>\AppData\Roaming\innovaphone\SoftwarePhone\)

Installation Process:

* http port 80 ist checked to be available as the SoftwarePhone ’s web configuration port. If not free, a search starting at port 10006 is executed to find a free port. The URL file, containing the configuration servers web @ is adjusted to the determined free port
* SoftwarePhone is startet.

Resetting to defaults:

*Resetting to default configuration could be done by deleting the config files in the Roaming Directory.

Unattended Installation of softwarephone for ALLUSERS:

*It's possible to install softwarephone for ALLUSERS by using the command:
Msiexec /i softwarephone.msi ALLUSERS=1

= Configuration =

The configuration is opened by selecting “Configuration” from the start menu. A browser connection is opend to the server running as part of SoftwarePhone and the configuration menu is displayed.

Default login is admin/swphone.

The configuration options are the same as for the hardware phones with a few specifics referring to SoftwarePhone running as a Windows process:

* Application
The Applicatons run mode and priority can be set and whether to register with the computers name at the PBX.
* Audio
The desired audio devices can be selected.
* Audio
The Audio –Input, -Output and –Ringing device can be selected.
* USB
Legacy configuration for customers who use a previous installation with a headset other than Jabra, Sennheiser or Plantronics. Headsets from these vendors are handled automatically and need not be configured.

The default credentials are admin / swphone

== '''„Audio and USB Configuration"''' ==

This config GUI is unique in the way that it can only be accessed (right click on the softwarephone icon) from the computer SoftwarePhone is running on. Here the typical End User Configurations are set: Audio and USB-headset parameters.

[[Image:default-usercfg.png]]

Above image shows the default configuration without any headset from vendors Jabra, Plantronics or Sennheiser plugged in. "Headset" in this case means any headset of beforementioned vendors that is detected. Note: The FIRST detected headset will become the active one, if more than 1 headset is plugged in. In case you have more than 1 headset plugged in and want to use a specific for Softwarephone operation you must configure it in the "USB Configuration | USB device" droplist.
The column on the right shows the actual values

[[Image:usercfg-headset-plugged-no-preferred.png]]

Above image shows a default configuration "Headset" with currently a "Sennheiser SC260 .." being plugged in and detected

[[Image:usercfg-headset-plugged-preffered-active.png]]

Above image shows the "Sennheiser SC260 .." configured as the prefered (USB Device) and being active.

Note: If you have configured a specific headset and you don't plug it in but instead another one then this other is fully operational and it stays that way until the prefered one is plugged in, then it becomes the active one.

'''Microphone:'''

The microphone selection.

'''Speaker:'''

The speaker selection

'''Ringer:'''

The Ringing device selection

'''Handsfree:'''

The open listening device selection. The device that plays the incoming audio stream when the speaker button is pressed in myPBX.

'''USB Device:'''

The USB headset selction.

'''USB Map:'''

Legacy for non Jabra, Plantronics and Sennheiser headsets. The codepage selection for the selected usb device. Here one or two choices are presented. If a selection item that refers to the selected USB Device use this. If only “generic HID Telephonie Page” is available you can try to use the headsets button (some headsets support the generic codes)

'''NOTE:''' If the headsets buttons do not work for call control, then call control is solely available through myPbx. Nevertheless the USB headset can be used as the audio-in/output device.

== '''[Tab:„Application“]''' ==

Admin mode Application configuration.

[[Image:swphone_application.jpg]]

'''Application Run Mode:'''

* Manual: SoftwarePhone needs to be started manually
* Login: SoftwarePhone will be started when the user logs in (don't set this option if myPBX Launcher have option "Run Softwarephone" in the same PC).

'''Application Priority:'''
* Normal: As every standard Windows Process. Sufficient in almost all cases
* High: Elevated Priority.

'''Register Mode:'''
* Default: Registration modes like the HW phones.

'''NOTE:''' Anonymous registration might not work in all environments, especially those that prevent multicasts. For example, when using SoftwarePhone over a vpn connection ensure that multicast forwarding is guaranteed. Also, if a virtual machine is running on the same computer it might prevent
multicasts being sent on the LAN.

* Computername:
The best way for registering SoftwarePhone at the PBX. It uses the computername as it is visible on the LAN. The computername is determined by SoftwarePhone and the appropriate parameters are set for the “Phone” modul. This configuration appears in the field “Name” under the “Phone” tab (Example for computer„LBU-VOSTRO-W7“ ):

[[Image:swphone_registration.jpg]]

== '''[Tab:"Audio”]:''' ==

Admin mode Audio configuration. Items see „Audio and USB Configuration“

== '''[Tab:“USB”]:''' ==

Admin mode Audio configuration. Items see „Audio and USB Configuration“

= Rollout =

Especially in larger installations it is desirable to have a mechanism for automatic configuration of the SoftwarePhones. This can be accomplished in the following way:

SoftwarePhones installation package (softwarephone .msi)can be parametrized by creating an [https://docs.microsoft.com/en-us/windows/desktop/msi/orca-exe Orca MSI database editor] transform with the parameters:
URL and POLL. Theses parameters are entered in the “Property” table

[[Image:download_orca.jpg]]

Saving Embedded Streams

By default, when saving a database to a new file with File and Save As…, Orca does not copy streams that are embedded in the database but not a member of any table. Select Copy embedded streams during 'Save As' to save streams to the new file when saving a database using the File with the Save As… option.

[[Image:orca_openfile.jpg]]

[[Image:orca_addrows.jpg]]

[[Image:orca_rows_content.jpg]]

[[Image:orca_savefile.jpg]]

It is recommended that the “POLL” value be set to “1” (shortest time: 1minute).
When SoftwarePhone is installed with the transform it starts, waits 1 min (poll period) then accesses the script file specified in the “POLL” parameter and executes the commands therein.
To register SoftwarePhone with the computername at the PBX the script file should look as follows (example showing the PBX @ “192.168.178.22” with the identifier „IP800-06-25-6e” :

…
#set the PBX @ and Identifier
config change PHONE SIG /prot H323 /gk-addr 192.168.178.22 /gk-id IP800-06-25-6e

#register with computername
mod cmd APP0 app-set /op OK /reg_mode ComputerName

#reset the automatic configuration update
config add UP1 /url

#reset SoftwarePhone and apply config
reset

Another method to provide configurations to the installed SoftwarePhone s is preparing a configuration template by configuring one SoftwarePhone entity, then using the generated “swphone_commands.cfg” file in the <users roaming directory >\innovaphone\SoftwarePhone
as the template, copying it to the update location and using it in the script file:

#invoke configuration template
mod cmd UP0 cfg <update directory location>/swphone_commands.cfg

This method is particularly helpful when many USB headset of the same type are used.

= Setting QoS =
See [[Howto:Softphone recommended settings]].

= Supported USB headsets =

The following USB headsets are supported for onhook/offhook and mute (MyPBX) functionality:

All Jabra, Plantronics and Sennheiser headsets that are supported by these vendors SDKs. Please check their
sites for more information.

https://www.plantronics.com/us/en/support/downloads-apps/hub-desktop

https://developer.jabra.com/site/global/sdks/windows/documentation/core.gsp

https://en-us.sennheiser.com/headset-software-pc

= Troubleshooting Connectivity Problems =

If you experience problems with softwarephone attaching to the PBX or not being able to make calls please check the following:

* '''check in the “Phone” tab whether the state is “up”'''

* '''check in the “General” tab if License is “Valid”'''

* '''Start a command window as Administrator and issue a "netstat –a –b > swphone_netstat.txt"'''

In the “swphone_netstat.txt” file search for “1720”. There should be an entry like this:

'''''TCP 0.0.0.0:1720 LBU-VOSTRO-W7:0 LISTENING'''''
'''[softwarephone.exe].'''

Please search for other occurances of “'''1720'''” to ensure that no other processes listen to this port.

* '''Make a softwarephone trace to see if the packets are received by softwarephone'''

In the “Maintenance” tab “Tracing” enable “'''H.323 Signaling'''”, “'''Phone'''” and “'''All TCP/UDP Traffic'''”. Then try to make the call. In the resulting trace you should see the events like the following:

'''''0:0103:337:3 - RECV RESULT[](662 from pla(192.168.178.22:60003) type: 1)
0:0103:337:3 - PHONE_LISTEN.1 -> PHONE_REG.1 : SIG_SETUP faststart=3ac8bec cmd=PROPOSAL cdpn=400'''''

If these events are no present in the trace it could be that the firewall settings prevent some of softwarephone’s functions. This could be the Firewall.

* '''Check the firewall settings for softwarephone'''

Please open the “System Administration\Windows-Firewall\Allow Program.. Ensure that softwarephone is enabled on the required interfaces. If this doesn’t solve the problem then temporaryly disable the firewall completely and try again.
Now even with the firewall disabled there could be some other security software that causes the problem. To find out if packets to the “h323hostcall” port (1720) are filtered by the firewall you can use the commands “'''netsh wfp capture start'''” to start a trace of the test and “'''netsh wfp capture stop'''” to stop the trace. The trace is written into the file: “'''wfpdiag.cab'''” . Extract the file: “'''wfpdiag.xml'''”. In this file search for “1720”. If the packet is filtered by the firewall an entry like the following can be found:

<netEvent>
<header>
<timeStamp>2013-11-05T11:20:27.367Z</timeStamp>
<flags numItems="8">
<item>FWPM_NET_EVENT_FLAG_IP_PROTOCOL_SET</item>
<item>FWPM_NET_EVENT_FLAG_LOCAL_ADDR_SET</item>
<item>FWPM_NET_EVENT_FLAG_REMOTE_ADDR_SET</item>
<item>FWPM_NET_EVENT_FLAG_LOCAL_PORT_SET</item>
<item>FWPM_NET_EVENT_FLAG_REMOTE_PORT_SET</item>
<item>FWPM_NET_EVENT_FLAG_APP_ID_SET</item>
<item>FWPM_NET_EVENT_FLAG_USER_ID_SET</item>
<item>FWPM_NET_EVENT_FLAG_IP_VERSION_SET</item>
</flags>
<ipVersion>FWP_IP_VERSION_V4</ipVersion>
<ipProtocol>6</ipProtocol>
'''<localAddrV4>192.168.178.21</localAddrV4>'''
'''<remoteAddrV4>192.168.178.22</remoteAddrV4>'''
<localPort>'''1720'''</localPort>
<remotePort>60007</remotePort>
<scopeId>0</scopeId>
<appId>
<data> …</data>
<asString>...</asString>
</appId>
<userId>S-1-5-21-3364624427-3176291796-194291593-006</userId>
</header>
<type>FWPM_NET_EVENT_TYPE_CLASSIFY_DROP</type>
<classifyDrop>
<filterId>105267</filterId>
<layerId>44</layerId>
<reauthReason>0</reauthReason>
<originalProfile>2</originalProfile>
<currentProfile>2</currentProfile>
</classifyDrop>
</netEvent>

where the

<localAddrV4>192.168.178.21</localAddrV4>

and the

<remoteAddrV4>192.168.178.22</remoteAddrV4>

should be your computers and the PBX’s @.

* Check if the setup from the PBX is received at the local computer and what happens with it

Sometimes, Antivirus Packages can implement their own network access policy. This can result in a h323 release complete with cause “User Busy” to an incoming Setup from the PBX before any other softwarephone is reached. To see which process Sends/Receives the packets in a flow you can use the “netmon”, Microsofts free Packet tracer.

= How to obtain debug traces of softwarephone using icollect =

Included in the installation path (C:\Program Files (x86)\innovaphone\SoftwarePhone) there is a tool called '''icollect.exe'''(accessible via start menu entry). After we reproduce a problem we can run this tool to generate debug files that are saved in the roaming folder (C:\Users\<User>\AppData\Roaming\innovaphone) as "debug-info.zip".

Before you reproduce the problem, please set the appropriate trace flags. Some flags like the KEYS flag must be set at "http://localhost:10006/debug.xml"
Which flags for which problem:

; Softwarephone looses registration at PBX: H.323/RAS, H.323/H.225, H.323/H.245
; Call setup phase: Signalling, H.323/RAS, H.323/H.225, H.323/H.245
; Audio problems: Signalling, H.323/ICE, H.323/DTLS, DSP trace, DSP Audiochannel. Please enable "DSP Audiocapture" only if specifically asked by innovaphone since it captures the complete audio stream and thus can generates huge files on the HD
; Headset button problems: Signalling, KEYS

'''NOTE: Please when providing a crash dump captured by icollect always use the latest SR (service release) of the softwarephone. Don't send us crash dumps of older versions since this will just take more time/effort to be analysed by our developer team.'''

== Important files for support in the debug-info.zip==
* '''trace.txt''' -> Trace File, created when '''File Trace''' is activated in debug.xml. Also contains version number (to find it, search for Build: )
* '''swphone_config.cfg''' -> one part of the config, can be used to check trace-flags.
* '''swphone_commands.cfg''' -> second part of the config, can be used to check trace-flags. Also contains version number
* '''dmp'''-file: named innovaphone '''SoftwarePhone#[version]#[id].dmp''' contains crash dump
** if crash without dmp file, '''StartTrace.txt''' contains trace of swphone start
* '''Wave-in/Wave-out''': created when DSP & DSP Audiochannel & DSP Audiocapture are activated.

=Known Issue=

=== Things to do before starting ===
Before starting debugging softwarephone issues, is always the best thing to:

- check if audio drivers on the PC/Laptop are updated to the last version

- check if the headset drivers are updated to the last version

- check that the Headset SDK is updated to the latest version

- check that network drivers are updated to the last version

- change registration protocol of softwarephone from UDP (H323) to TCP or TLS (H323/TCP or H323 TLS) to avoid any signaling issue

After updating the driver, please reboot the PC even if not requested by the OS.

Most cases are solved after updating drivers/software, especially if softwarephone won't start or no ringtones/audio device is automatically selected.

Also, please check that the files " swphone_config.cfg " and " swphone_commands.cfg " in the C:\Users\%user%\AppData\Roaming\innovaphone\softwarephone\ are not 0 Kbyte.
In this case, best is to reinstall the softwarephone with the latest version, and, after configuring it, restart it and check that the file " swphone_commands.cfg " is bigger then 6 KB.
If something is overwriting it (Windows policy, Antivirus), do the following:

- uninstall softwarephone

- reinstall it with Administrator rights

- start softwarephone and configure it (saving the changes)

- without closing it, navigate to the " C:\Users\%user%\AppData\Roaming\innovaphone\softwarephone\ " folder and put " swphone_config.cfg " and " swphone_commands.cfg " in read-only. Doing this, softwarephone will save the changes. Remember that doing this, if you want to changes some settings on softwarephone, you need to remove the "read-only" flag on the files (and re-apply it after the changes)

=== G.711 only and G729 Optional===
The software phone does support G.711 and Opus codec only, no G.723 or G.722.
Optionally we can use G729 if G729 Channel licenses are present and available on the PBX.

===Another program is blocking the softphone===

Another program (e.g XCAPI) might be listening on tcp port 1720 as well. If you want to use both programs simultaneously you can change the signaling port of the softphone to another port like 1721.

<nowiki>http://localhost/!config add PHONE SIG /ep-addr 0.0.0.0:1721</nowiki>

If you want to find out which program is listening on which port we recommend using a little tool called TCP View. You’ll find it here:

http://technet.microsoft.com/en-us/sysinternals/bb897437.aspx

=== No license obtained from PBX if SIP Protocol is used===

When using Innovaphone softwarephone with SIP Protocol no license it's obtained from the PBX. It's necessary to use H.323 always.

=== Headset Basestation doesn't Ring ===

Often it's reported that the Basestation of Wireless Headsets doesn't Ring on incoming call, this is a feature that is missing and there exist already a Feature Request for it - [[Support:DVL-Feature_Requests#Alerting_on_Wireless_headset_base_also | Alerting on Wireless headset base also]] .

=== Windows Volume lowers automatically when receiving a call ===

The volume can be set for swphone exclusively by the Windows mixer. It appears in the mixer because it has a Audio stream Interface to the Windows Audio System, but no way adjust the volume by itself. When such an effect occurs it is best to check the Windows configuration: if it is set to Change volume for applications when certain Events occur:

[http://superuser.com/questions/74116/windows-7-lowers-applications-volume-automatically Windows 7 lowers applications' volume automatically]

=== H.323/TLS Connection not Trusted by Default ===

Please check the [[Reference11r1:Concept_H.323_over_TCP/TLS_(H.460.17)#Known_Issues|H.323/TLS Known Issues article]].

=== Softwarephone does not work on Terminal Server ===
The software phone can only run once on a single system. This also implies that it does not work for terminals server systems such as e.g. Citrix, as only the first client session running on a server would be able to start a software phone. Furthermore, multiple RTP streams would impose quit a bit of load on the server.

=== Softwarephone can't place calls (call setup disappear as I press the "call" button") ===

After windows major update, some windows systems had their microphone rights turned off for all the application using it. This prevent the softwarephone to properly use the microphone.
To check this, press "windows key + i", navigate in "Privacy" - "Microphone" - and check that "Allow apps to access you microphone" is turned on. Sometimes, even if turned on, there is the need to turn "Allow apps to access you microphone" completely off and the on to "refresh" the app rights (softwarephone included)

Also check that windows firewall is not blocking softwarephone communication.

Please check also this page: " http://wiki.innovaphone.com/index.php?title=Howto:Softwarephone_recommended_settings#Registration_Protocol ". With softwarephone, is recommended to not use H323/UDP as protocol.

=== When PC is not used for some time, softwarephone won't work anymore ===

We noticed this behaviour on some Windows PC. This was due to the power management settings of Windows, that was turning off the USB ports to save power (this happen most on laptops)
To avoid this, open "Control Panel" (with Category view) - "Hardware and sound" - "Power options" . Under "Preferred plan" click the "Change plan settings" for the plan you are currently using.
Click the "Change advanced power settings" link
Expand "USB selective suspend settings"
Select "Disabled" form the drop-down menu
Click "Apply" and the "ok"

If you're changing the settings on a laptop, you'll see two options: On Battery and Plugged in, so make sure to change those settings accordingly.
This will prevent Windows 10 to power off USB devices connected to your computer (so your usb bluetooth headset connector)

=== Softwarephone doesn't start after upgrade to new version ===

On windows 10 PC, can happen that after installing the new softwarephone version without manually uninstalling the old one, softwarephone won't start anymore, and in the Windows event viewer you will see the softwarephone app crash with relative ntdll.dll error.
To solve this, manually uninstall the softwarephone, reboot the PC and install the new version.

=== Softwarephone 12r2 keep crashing on Windows 10 ===

We noticed some issue between Softwarephone 12r2 and Windows 10. If your softwarephone after Windows 10 major update 1809, doesn't start or start and keep restarting, uninstall Softwarephone 12r2, delete the Softwarephone folder in the AppData/Roaming/Innovaphone/ path, restart the PC and install Softwarephone 12r1 with Administrator rights. This should solve the issue.

=== Issue with permission on Appdata folder ===

After major windows update, can happen that permission for the appdata/Roaming folder are reset. To restore them please do the following:

Open "Run" by pressing Windows + R keys together.
Type: as C:\Users\USERNAME\AppData
Note: Replace C: with the letter of the drive where Windows is installed. Also replace USERNAME with the username of the account you’re logged in.

Click OK

Right-click on the Roaming folder

Click Properties

Go to the Security tab

Click “Edit -> Add”

Type “Everyone”

Click “Check names -> Ok -> Full control”

Click OK to save the changes

Restart your computer

Now softwarephone should be able to access all necessary files again.

=== Not removed system tray icons ===
Sometimes if the softwarephone loose connection, wifi/copper/vpn will be switched or crashes the application in the system tray will not removed.

=== Headset not recognize by softwarephone on Windows 10 ===

After Major windows update, headset is not recognize anymore. This can happen in case authorization by the OS for softwarephone to bind the headset to the softphone is denied.
To restore the headset detection, uninstall softwarephone 12r2 version and install the latest 12r1 softwarephone release. Doing this, NET framework 3.5 will be reinstalled, authorization restored, and headset should be recognized again.
Once headset is recognize, you can reinstall softwarephone 12r2 (latest) version and headset will work with the 12r2 version of softwarephone again.

=== Softwarephone Mac address is 00000000000 ===

To be able to obtain a Mac address, on the PC network card, netbios must be enabled.

=== Kaspersky antivirus ===

We have reports that this antivirus can interfere with softwarephone if the client is not configured to allow softwarephone to work properly (softwarephone start but no calls are possible). Please disable it or configure an exception for the softwarephone so softwarephone can make calls.

=== Softwarephone doesn't ring, or does not receive call ===

According to this wiki page, http://wiki.innovaphone.com/index.php?title=DND if you press the mute button on the headset while softwarephone is in idle (no active calls) you activate the DND mode. This information won't be displayed in myApps/myPBX but is something between headset and softwarephone. You can check in this case if this line:

vars create PHONE/USER-DND/00000 p 1 <--------- 1 means DND is on, 0 is off.

is present in the softwarephone configuration file. If this is the case, pressing the mute button in the headset again when no calls are active, will set the value to 0 and DND will be disabled.

You can also lock the DND function on the softwarephone in PHONE/Protect/ Fine grained Function Locking and configure in the field:

0x00080000

Doing so the user won't be able to set the softwarephone in DND anymore.

Update: solved with the latest softwarephone release. Now is not possible to set the softwarephone in DND mode via the headset.

=== Crash if 4 or more network interfaces on PC ===

The Softwarephone will crash when started continuously or crash when a call is done (and the ICE candidates for the call are generated). As a workaround, don't activate more than 3 interfaces or use the v13 myApps-softphoneApp.

===Softwarephone doesn't start with myPBX===
After a Windows update, some PC requires to run myPBX as administrator in order to start softwarephone automatically. Please, run myPBX as administrator and softwarephone should start also.

Howto:Group Voicemail

2021-08-13T06:43:05Z

Ani:

==Applies To==
This information applies to
* IPXXX, V13r2
PBX-Build 135779 and later.
VM-Build 135xxx


==More Information==
A comma-separated list of MWI destinations/recipients can be configured by means of a variable ''$_m'' within the script URL's query string. This article outlines a configuration scheme for group voicemail functionality.

===Problem Details===
A group voicemail acts as single point of storage and multiple point of access for several PBX endpoints. MWI-updates are expected to be delivered to all group members.

===System Requirements===
A standard voicemail script vm.xml is expected to be installed underneath ''/drive/CF0/vm/vm.xml''.

'''A PBX-VoicemailUser13 license is required for each group voicemail.'''

===Installation===
Two PBX phone endpoints ''Atlantis'', ''Endeavour'' share a voicebox ''vm-group'' with number ''803''. The voicebox's directory on the mass-storage will be named ''vm-group''.
The phones may redirect towards the voicebox by means of a CFU 803803. The phones access the voicebox by the Message Center Account number 803803.

If Viking calls e.g. Endeavour, it's going to be redirected into ''vm-group'' and may leave a voicemail. On call-end the participants Atlantis, Endeavour are going to receive an MWI-Activate.

===Configuration===
*Add following objects
**'''User''' ''101:Endeavour''
**'''User''' ''102:Atlantis''
**'''User''' ''301:Viking''
**'''Voicemail''' ''803:vm-group''
***'''Script URL''' <code type="text">
http://127.0.0.1/drive/CF0/vm/vm.xml?$_m=101,102
</code>
***'''E-Mail''' if desired configure a destination email address serving as a group email address
****Note: The email is sent only once to the destination configured as PBX/Objects/"vm-group"/General/E-Mail. It is up to an admin of the receiving mail server for how to distribute the email towards all potential group members.
*Configure Function-Keys at phones Endeavour, Atlantis
**'''Type''' Message Waiting
**'''Message Center Account'''
***'''Number''' ''803803''
***'''Append Own Number''' inactive/not checked
*Configure source email address and mail server
**Edit the settings underneath '''PBX/Config/Authentication/Email Verification''' accordingly. Those are the settings being considered by the sub-script email.xml.

=== Configuration App Platform===
If using app platform the configuration can done by PBX Manager. There is a new button "add Voicemail group app". This configures the new variable "$_m" and a second one for the app "$_group" which is the name of the VM Object.
It is only necessary for the voicemail app.

The voicemail app works with sip names<ref>sip name: the dialable name, within a user's PBX-UI the edit field '''name'''</ref><ref>A comma within a sip name must be URL-escaped within the comma-separated list ''$_m..'' E.g. ''Doe, John'' => ''Doe%2C John''</ref> so that it is mandatory to configure the Message Waiting Keys and the $_m with names instead of numbers.

'''Script URL''' <code type="text">
http://127.0.0.1/drive/CF0/vm/vm.xml?$_m=endeavour,atlantis&$_group=vm_group&$app=on
</code>

The group voicemail app can be activated for every user by checkmark the group voicemail object in the tab "PBX/User/Apps"

==Known Problems==

==Related==
<references/>

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

Reference12r2:Concept Softwarephone

2021-07-16T10:31:45Z

Ani: