innovaphone wiki - User contributions [en]

Reference16r1:Concept Innovaphone Virtual Appliance (IPVA)

2026-05-11T17:06:16Z

Slu: /* Proxmox VE */

==Applies To==
This information applies to:
*V16r1
*innovaphone Virtual Appliance
*Intel/AMD CPUs
* Virtualization platforms
**VMware
*** Workstation
*** Player
*** vSphere 4 - 8
*** ESXi 6 - 8
**Microsoft Hyper-V ([[{{NAMESPACE}}:Concept IPVA On Hyper-V|Concept IPVA On Hyper-V]])
*** Windows 8.1
*** Windows 10
*** Windows Server 2012 R2
*** Windows Server 2016 CTP4
**Linux based Hypervisors with [https://en.wikipedia.org/wiki/Kernel-based_Virtual_Machine KVM] and [https://en.wikipedia.org/wiki/QEMU QEMU] support
*** Proxmox VE 8.0 / 8.1 / 9.1

''Disclaimer: Manufacturers/versions of VM platforms other than those specified here have not been tested, so use at your own risk.''

''Disclaimer 2: We occasionally encounter customers experiencing unusual issues related to OpenStack. OpenStack is not officially supported, and such issues are not analyzed.''

==More Information==
The innovaphone Virtual Appliance (IPVA) is a virtual machine to be run on a virtualization platform.

The IPVA is a software-only solution. It appears and behaves like an innovaphone "hard-box" without physical resources such as hardware DSP or ISDN interface.

==Package Overview==
We supply an OVF ('''O'''pen '''V'''irtualization '''F'''ormat) import or - depending on the virtualization platform - a suitable variant.
OVF is an open standard that contains several files in one package. The .ovf file is therefore an archive that contains all the necessary files.

=== Sample VMware ===
;ipva-ovf.zip:
The compressed archive ''ipva-ovf.zip'' contains the file ipva.ova. A deployment of ipva.ova will result in a set of 5 files - the file names may differ from the following list:
*ipva.vmx: The virtual machine configuration file
*hd-boot.vmdk: The virtual boot disk on IDE 0:0
*hd-cf.vmdk: The disk for emulation of a Compact Flash card on IDE 0:1
*hd-flash.vmdk: The disk for emulation of flash memory on IDE 1:0
*hd-dump.vmdk: The disk serving as a store for a crash dump on IDE 1:1

;ipva.bin:
The file ''ipva.bin'' is the firmware file, which is only needed for update purposes.

== Virtualization platforms ==

===VMware Player / VMware Workstation===
==== Import new Machine ====
*Copy the file ipva.ova to e.g. your desktop and Double-click on ipva.ova.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===VMware vSphere===
==== Import new Machine ====
*Import ipva.ova by means of '''File/Deploy OVF-Template...''' (de: '''Datei/OFV-Vorlage bereitstellen...''') and follow instructions.
*Edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

===Microsoft Hyper-V===
==== Import new Machine ====
* Use the UI Wizard to Import a new machine
* Browse to the directory where the downloaded package was extracted to. Browse to the subdirectory Virtual Machines and click Ok
* Select ''Copy the Virtual Machine'' as ''Import Type''

===Proxmox VE===
==== Settings ====
* Processors: 1 socket, 1 core
* Bios: SeaBIOS
* Machine: i440fx

==== Import new Machine ====
Import the "ova" file to your storage which is enabled for the type "import". After that you can select the created template an create new machines from it with the button "Import"

* Before you start up the VM in the UI you have to adjust the following configuration options:
** Hardware -> Processors: Adjust "Extra Cpu Flags" -> "aes" if required
** Hardware -> SCSI Controller: Change Model to "VirtIO SCSI Single"
** Hardware -> Network Device (net0 / net1): Change Model to "VirtIO (paravirtualized)"

==Configuration==

===Network Configuration===
The IPVA is preconfigured a DHCP client. You will see the current IP-Address in the console-screen of the VM. If there's in no case a DHCP server available for the 1st-time configuration, you can set your IP-Configuration in the console.

config change IP0 ETH0 /addr 192.168.0.10 /mask 255.255.255.0
config change IP0 RT0 /gateway 192.168.0.1
config change DHCP0 /mode off
config write
reset

====MAC/serial number====
Take care that you use a MAC address which is supported by my.innovaphone, see [[Reference:My_Innovaphone#IPVA_MAC_exists]].

===AES Hardware Acceleration===
It may be beneficial to activate hardware acceleration for AES operations.
Whether hardware acceleration is activated can be checked with the command <code>!mod cmd CPU cpu-info</code>.

* The "flags" attribute must contain "aesni"
* The "act-features" attribute must contain "has_aesni"

Example:
<info>
<cpu
vendor="GenuineIntel"
signature="0x906e9"
brand="Intel(R) Core(TM) i5-7400 CPU @ 3.00GHz"
...
flags="sse3 pclmulqdq ssse3 sse4_1 sse4_2 aesni xsave xsaveopt osxsave avx f16c rdrand fpu mmx fxsr sse sse2 avx2"
act-features="has_aesni has_avx has_vaesni has_vpclmulqdq" srtp-mips="5"/>
</info>

==Large IPVA with 512 MiB Flash==
In some scenarios the standard 64 MiB flash memory is not enough to store all user data. It is possible to manually enlarge the flash memory of an IPVA up to 512 MiB.

You have to change the settings of the virtual machine and format the flash. You cannot do it with an already configured machine, because you will lose all your configuration!

# shutdown the IPVA
# increase the RAM to 3.072 MiB
# increase the size of '''IDE1:0''' to 512 MiB or recreate it
# power up the IPVA
# format the flash: <code>!mod cmd FLASHMAN0 reset all</code>
# reboot the IPVA: <code>!reset</code>

You can check the free space with the command <code>!mod cmd FLASHMAN0 info</code>. You will see a big amount of available segments

segments=675, segment-size=0x10000 (64k)
LDAP - used 1k avail 63k owned 64k (segments 1) maximum 517056k (segments 8079, configured 8079)
VARS - used 23k avail 16k owned 192k (segments 3) maximum 640k (segments 10, configured 10)

But please keep in mind, the more data is saved, the longer it takes to reboot and load the UI in the [[{{NAMESPACE}}:PBX/Objects|PBX/Objects]] area.

==Troubleshooting==
Support procedures are commonly identical to the ones known from innovaphones' physical appliances. Except for:
*'''Post-Mortem Logs''' A post-mortem log must be retrieved by clicking on ''Maintenance/Diagnostics/Tracing/'''trace(crash-dump)''''' (alternatively: http://a.b.c.d/crash_dump.txt).

==Known Issues==

=== Maximal 3.072 MiB RAM ===
Because the IPVA has no [https://en.wikipedia.org/wiki/Virtual_memory virtual memory management], it will use only the first linear 3 GiB of RAM. But please keep in mind, that the flash content will be stored 3-times (Flashmanager, Flashdirectory, PBX) in RAM at startup.
=== Restored IPVA may not run ===
We have seen issues where an IPVA which had been backed up using one of the available backup tools for VMWare do not start up properly when they have been restored.

We strongly suggest to not rely on VMWare backup mechanism but instead to use the standard innovaphone backup scheme (that is, save the configuration on a regular basis).

==== How to run a restored backup that fails to start ====
Here is the procedure to run an IPVA from an IPVA if the restored virtual machine does not boot up properly:

* restore the backed up V10 IPVA
* create a new, empty V11r1 IPVA (you will need this merely to copy the boot disk from)
*replace the boot disk of the failing V10 IPVA by the boot disk of the fresh V11r1 IPVA (see [[#How To Replace The Boot Disk On vSphere.3F| How To Replace The Boot Disk On vSphere]] for details)
* start the restored and fixed V10 IPVA (it should run fine now)
* downgrade this V10 IPVA to desired V10 firmware
* remove the fresh V11r1 IPVA

Some Customer who are running Fw v12r1 (up to sr6) with ESXi 6.0 and VEEAM 9 reported that after a backup with VEEAM 9, the restored IPVA was not starting.
At this point, there is no possibility to solve this problem. The only workaround in that case is to delete the machine, reinstall a new one, and restore a configuration saved before.

If you did not run into the problem yet, for prevention, we recommend to replace the Boot disk of your working IPVA.vmx with one of the IPVA.ova. Please follow the steps below (be aware that this will upgrade the firmware on the IPVA to 12r2, due to the fact that actually, IPVA.ova is only available from version 12r2):

1. Remove the Boot disk of the virtual machine (vmx)(is normaly the first one). 
* Power off the VM
* Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Remove''.
* Click ''OK'' to save your changes.

2. Add the Boot disk of the ova virtual machine to the vmx one.
* Identify the size of the boot disk of the ova virtual machine (will be needed on the step when navigating to boot disk)
* On the powered off VM, Select the Virtual Machine > Settings.
* On the Hardware tab, select the virtual hard disk and click ''Add''.
* Select Use “an existing virtual disk” then click ''Next''.
* Navigate to the boot disk of the ova Virtual machine then click ''next''.
* Click ''Finish''.
Now the vmx virtual machine should have the Fw version 12r2.

The .ova version will be available also in V12r1 sr7

=== IPVA does not run on Citrix Cloud Platform ===
Reportedly, the Citrix cloud platform - although based on VMware - cannot run the IPVA. Amongst other issues, the platform does not allow 4 virtual disks, which are required for the IPVA.

=== IPVA does not run on VCloud Air ===
VCloud Air apparently does not support the timekeeping mechanism required by the IPVA.

[[User:Ckl|ckl]] 15:50, 30 November 2016 (CET) We have seen the IPVA v12r2 running on vCloud Air. Use the ova import.

=== IPVA on ESX 6.5 ===
We have reports that the IPVA does not run properly on ESX 6.5. The IPVA boots up properly but the clock does not run. Running the .ova based variation available in v12r2 fixed the issue or edit the file ipva.vmx according to [[#What Can I Do In Case Of Boot-Problem: perf-counter not enabled.21| What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!'']]

=== Administration: Avoid 'reboot' Command. Use 'reset' Command ===
Alwas use the 'reset' command to restart an IPVA.
The 'reboot' command makes sense only on physical applicances, where its purpose is to deploy a new bootcode by means of a forced watchdog trap. The resulting post-reboot state will be as if an unsolicited trap/crash had occurred.

=== Voice Quality Issues ===
When dealing with media streams (e.g. for announcements), the IPVA needs to fulfil real-time processing requirements, for example to process RTP packets in a timely fashion. To do so, the IPVA relies on the capabilities of the virtualization platform it runs on.

It is therefore important to configure the platform so that it supports real-time applications best. If you experience voice quality or latency issues, consider
* to make sure that all of the IPVAs memory is ''reserved'' to the IPVA (''Latency Sensitivity'' set to ''High'')
* to guarantee exclusive PCPU access
This helps to reduce CPU halt/wake-up states.

===Additional vCPUs may cause problems===
The Multi-Core functionality of version 13r2 is a beta functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==FAQ==
===Can The emulated compact-flash disk size be increased?===
Yes, from within the ''Edit Virtual Machine'' dialog. Doing so just increases the size of the virtual harddisk. The emulated compact-flash must be formatted afterwards and accordingly to benefit from the increased size. That step can be administrated from ''Administration/Compact Flash/Format''. Note: A recommendation for an upper size limit is not given. Please note: The compact-flash disk is not the flash which store LDAP and VARS.

'''vSphere / vSphere Client'''

1. At first backup all of your files from CF card 
2. Shutdown the corresponding IPVA 
3. Choose "Properties" of the IPVA 
4. Delete "Harddrive 2" (Hardrive file xxx/xxx_1.vmdk) 

hd-boot.vmdk > xxx.vmdk
hd-cf.vmdk > xxx_1.vmdk
hd-flash.vmdk > xxx_2.vmdk
hd-dump.vmdk > xxx_3.vmdk

5. Create new harddrive 
6. Configure the required size 
7. As "Node of virtual device" select "IDE(0:1)" 
8. Start the IPVA. 
9. "Format" the CF Card and "mount" it (General/Compact-Flash/General)
===What Is the minimum size of the emulated flash storage?===
The VMDK-File hd-flash.vmdk is allocated with 100 MB, because VMWare can not handle smaller virtual disks.

===What Is The Size Of the Flash Directory on the IPVA?===
As noted above, the virtual flash memory on the IPVA is defaulted to a size of 64MB. Most of the flash is used by the ''flash directory'' (FLASHDIR0) which amongst other things provides storage for PBX objects.

The size of the flash directory depends on the available RAM. The maximum of 900 segments á 64KB, i.e. ~56MB, is available if 192MB or more RAM is available. If less RAM is available, the size of the flash directory is decreased accordingly. For this reason, it is unsafe to reduce RAM size in a given IPVA, as the flash directory size may be decreased so that objects from the flash directory get lost.

The easiest method to see how much flash directory space is available is to investigate the boot trace. For the standard configuration of 64MB the respective trace output is going to look as follows and informs about a size of 14MB:

0:0000:081:4 - start flashdir FLASHDIR0
0:0000:081:4 - fdir: segments=901->224(14.0MB)

{{Limit_Virtual_IPVA_Flash}}

===How much RAM is required per IPVA instance?===
Since 12r2sr27/13r1sr5 the downloadable virtual appliance comes preconfigured with 256 MiB RAM. This amount is seen as a good trade-off for the majority of all installations. The IPVA need the amount of used flash 3-times at startup. The RAM-size can be administrated by VMware-means.

===What is the maximum amount of RAM?===
The maximum meaningful RAM setting is 3GB. Memory space beyond that limit will be left unused. Assigning more than 3GB to an IPVA instance doesn't provide any benefit.

===Why does ''General/Info/DRAM'' show less than the configured memory?===
Not all of the configured memory is available to the IPVA. E.g. a bit of memory is occupied by the VMM<ref>Virtual Machine Monitor: A component belonging to the virtualization platform</ref>. The indicator ''General/Info/DRAM'' displays the memory available to the IPVA and is truncated down to a whole number. A boot-trace reveals a bit more about IPVA-available memory as shown in the following excerpt:
<pre>
...
0:0000:030:4 - Intel(R) Core(TM)2 Duo CPU E8400 @ 3.00GHz
0:0000:030:4 - mem(64946176)=61.93MB ...
</pre>

===What about Open VM Tools / VMware Tools?===
Tools like this are not supported / integrated because it is not needed. The Virtual Appliance provides his own operating system, and we don't need any of the VM-Tools features in our guest.

===What Can I Do In Case Of A Checksum Boot Error?===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
checksum wrong! Loading failed for image=IPVA BIN
</pre>
[[Image:ipva-crc-wrong.jpg|center|thumb|200px|ipva-crc-wrong.jpg/|ipva-crc-wrong.jpg/]]

'''Solution'''
*Power-off the IPVA
*Replace the boot harddisk by a fresh one. The boot harddisk is the 1st hd(originally named ''hd-boot.vmdk'').

'''Remarks'''

This problem may occur on a system crash while a firmware update is taking place.

===What Can I Do In Case Of Boot-Problem: ''NIC unavailable!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
NIC unavailable!
</pre>
[[Image:ipva-nic-unavailable.jpg|center|thumb|200px|ipva-nic-unavailable.jpg/|ipva-nic-unavailable.jpg/]]

'''Solution'''
*Power-off the IPVA
*Administrate by VMware means: Ensure the correct/expected type of network interface controller(NIC) is going to be offered by the hypervisor.

The IPVA offers driver support for:
*AMD NIC: Am79C970A PCnet-PCI II Single-Chip Full-Duplex Ethernet Controller
**a.k.a ''PCNet32''
**a.k.a ''Vlance''

The AMD-NIC is kind of default. However, the NIC type may be overriden manually and accordingly within the configuration file ipva.vmx as follows
<pre>
ethernet0.virtualDev = "vlance"
</pre>

'''Remarks'''

This problem may occur after a VMware re-configuration of the network settings.

===What Can I Do In Case Of Boot-Problem: ''perf-counter not enabled!''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
perfcounter-not enabled!!!
</pre>
[[Image:screenshot-ipva-perfcounter-nok.jpg|center|thumb|200px|screenshot-ipva-perfcounter-nok.jpg/|screenshot-ipva-perfcounter-nok.jpg/]]

'''Solution''' 
This problem is likely caused by an OVA-import of the IPVA. The appliance's configuration file ''ipva.vmx'' requires a VMware proprietary configuration line that's not specifiable within an OVA-file.

The IPVA utilizes a VMware proprietary mechanism for its internal timekeeping<ref>Timekeeping in Virtual Machines http://www.vmware.com/pdf/vmware_timekeeping.pdf</ref>. That mechanism is only available after adding the following line to the configuration file ''ipva.vmx'':
<pre>
monitor_control.pseudo_perfctr = TRUE
</pre>
If that line is not present, the hypervisor is going to throw a CPU exception. Hint: In vSphere a VMX-file can be edited under '''Edit Settings/Options/Advanced/General/Configuration Parameters'''<ref>vmware Labs - How to edit vmx file in ESXi vSphere: https://www.youtube.com/watch?v=ICICoq-maB0</ref>

'''Remarks'''
*The vmx file should be edited after the installation of the IPVA.
*The vmx file should NOT be edited with Text editor (use vSphere as shown above)
*To our knowledge, a converter is always necessary for the installation with vmx.

===What Can I Do In Case Of Boot-Problem: ''Loading failed for image=IPVA BIN''===
This paragraph applies, if you experience the following start-up problem.

'''Symptom'''
*the IPVA doesn't start properly
*the console displays
<pre>
Loading failed for image=IPVA BIN
</pre>
[[Image:Ipva-fw-load-failed.png|center|thumb|200px|ipva-fw-load-failed.png/|ipva-fw-load-failed.png/]]

'''Solution''' 
This problem is likely caused by a calculation fault within the boot-code.
*The solution requires a replacement of the boot disk hd-boot.vmdk.
**Download an IPVA package from on 11r2 sr22.
**Replace the 1st disk with the one from the downloaded package

===Are Additional vCPUs useful?===
The Multi-Core functionality is an experimental functionality. Additional virtual CPUs(vCPUs) should not be utilized in production environments.

==Notes==
<references/>

==Related Articles==
* [[{{NAMESPACE}}:Licenses|Reference15r1:Licenses]]
* [[Howto15r1:Implement_PBX_with_zero_downtime_using_IPVA_and_VMWare_Fault_Tolerance]]
* [[Howto:A_rough_estimate_of_IPVA_Performance]]

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

Reference17:Concept App Service Translations

2026-05-05T12:59:33Z

Slu: /* Technical Concept */

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your credentials in the Settings App.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

==== Technical Concept ====

* The DeepL API is a synchronous HTTP flow. This means that we request a translation and get an instant response with the translation.
* Outgoing HTTP(S) request to the DeepL API
* If you not override the URL, it is used HTTPS only

=== EU - eTranslation ===
This interface uses the EU service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

==== Technical Concept ====
* The EU-eTranslation uses an asynchronous HTTP flow with webhooks to deliver processed translations
* Translation flow
*# On every app startup
*## a dynamic user / password combination is created, which will be used for later secure incoming webhooks
*### Example: <code>23bcf2fd / 19ccf70b-028c-e7a8-94eb-1ad7db91d4c8</code>
*## the own app url is generated from the current environment
*### Example: <code><nowiki>https://23bcf2fd:19ccf70b-028c-e7a8-94eb-1ad7db91d4c8@apps.slu.de/slu.de/translations/webhook-basicauth</nowiki></code>
*# Outgoing HTTPS request to the eTranslation Service. The translation job will be queued. As additional information in the job, a callback webhook URL with a username and password will be placed.
*# If the processing is finished, a webhook to the app is delivered via HTTPS
*# The job result will be processed and delivered back to the user that has requested the translation
==== Limitations ====
* 50 concurrent translation requests
* 5.000 characters per translation

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-05-05T06:13:58Z

Slu: /* Technical Concept */

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your credentials in the Settings App.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

==== Technical Concept ====

* The DeepL API is a synchronous HTTP flow. This means that we request a translation and get an instant response with the translation.
* Outgoing HTTP(S) request to the DeepL API
* If you not override the URL, it is used HTTPS only

=== EU - eTranslation ===
This interface uses the EU service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

==== Technical Concept ====

* The EU-eTranslation uses an asynchronous HTTP flow with webhooks to deliver processed translations
* Translation flow
*# On every app startup
*## a dynamic user / password combination is created, which will be used for later secure incoming webhooks
*### Example: <code>23bcf2fd / 19ccf70b-028c-e7a8-94eb-1ad7db91d4c8</code>
*## the own app url is generated from the current environment
*### Example: <code><nowiki>https://23bcf2fd:19ccf70b-028c-e7a8-94eb-1ad7db91d4c8@apps.slu.de/slu.de/translations/webhook-basicauth</nowiki></code>
*# Outgoing HTTPS request to the eTranslation Service. The translation job will be queued. As additional information in the job, a callback webhook URL with a username and password will be placed.
*# If the processing is finished, a webhook to the app is delivered via HTTPS
*# The job result will be processed and delivered back to the user that has requested the translation

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-05-05T06:13:00Z

Slu: /* Supported translation services */

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your credentials in the Settings App.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

==== Technical Concept ====

* The DeepL API is a synchronous HTTP flow. This means that we request a translation and get an instant response with the translation.
* Outgoing HTTP(S) request to the DeepL API
* If you not override the URL, it is used HTTPS only

=== EU - eTranslation ===
This interface uses the EU service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

==== Technical Concept ====

* The EU-eTranslation uses an asynchronous HTTP flow with webhooks to deliver processed translations
* Translation flow
*# On every app startup
*## a dynamic user / password combination is created, which will be used for later secure incoming webhooks
*### Example: <code>23bcf2fd / 19ccf70b-028c-e7a8-94eb-1ad7db91d4c8</code>
*## the own app url is generated from the current environment
*### Example: <code><nowiki>https://23bcf2fd:19ccf70b-028c-e7a8-94eb-1ad7db91d4c8@apps.slu.de/slu.de/translations/webhook-basicauth</nowiki></code>
*# Outgoing HTTPS request to the eTranslation Service. The translation job will be queued. As additional information in the job, a callback webhook URL with a username and password will be placed.
*# If the processing is finished, a webhook to the app is delivered via HTTPS
*# The job result will be processed and delivered back to the user that has requested the translation

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-05-05T05:52:51Z

Slu: /* Language recognition */

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your credentials in the Settings App.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

=== EU - eTranslation ===
This interface uses the EU-Service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en-gb, es, fr, it, nl, pl, pt-pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-05-05T05:51:20Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your credentials in the Settings App.

== Supported translation services ==
You can configure multiple translation backends and switch between them.

=== DeepL ===
This interface uses the https:///www.deepl.com translation API.

This interface is used as the default interface. you dont must provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. A custom API-URL is only for a local version with the same API interface.

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

=== EU - eTranslation ===
This interface uses the EU-Service eTranslation.

European Commission’s free and secure AI language tools: https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en

Technical Documentation: https://language-tools.ec.europa.eu/dev-corner/etranslation/rest-v2/text

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown.
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version and click on install
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as the display name ''(all characters allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps. In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which there are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings that are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: cs, de, en, es, fr, it, nl, pl, pt, ro, ru, sl, tr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend, and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-05-04T15:02:43Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Overview ==
The idea of the translations app is to provide an interface for other apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your credentials in the Settings App.

=== Supported translation services ===

==== deepl.com ====
This interface is used as default interface if you dont provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]].

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

=== Custom backends ===
You are able to provide your own translation backend by configuring an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. For this, it is important that your backend act in the same way as the deepl.com interface.

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version, for example '''"v15"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the install yellow button
* Wait until the install has been finished
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as display name ''(all character allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps.
In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. 
A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings in which are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: de, en-gb, fr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Concept App Service Translations

2026-05-04T13:26:19Z

Slu: Created page with "Apps Category:Concept App Service Translations == Applies To == * innovaphone from version 14r2 == Overview == The idea of the translations App is to provide an interface for other Apps to translate user content on-the-fly. So other apps can integrate the translation service via the [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user tran..."

[[Category:Concept|Apps]]
[[Category:Concept App Service Translations]]
== Applies To ==

* innovaphone from version 14r2

== Overview ==
The idea of the translations App is to provide an interface for other Apps to translate user content on-the-fly.
So other apps can integrate the translation service via the [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm local JavaScript API] in the client and thus offer the user translated texts.

The service serves as a proxy and integrates a corresponding backend. This means that you need your own account at the external translations service and can configure your API key in the PBX Manager for this app service.

=== deepl.com ===
This is interface is used as default interface if you dont provide an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]].

;Privacy
:API Free: https://www.deepl.com/de/privacy#section_12
:API Pro: https://www.deepl.com/de/privacy#section_5
;Cost model and Pricing
:Pay per character (To save costs, the app service offers a cache to avoid multiple translations)
:https://www.deepl.com/de/pro#developer

=== Custom backends ===
You are able to provide your own translation backend by configuring an ''API-URL'' in the [[Reference16r1:Apps/PbxManager/App Translations|Settings]]. For this, it is important that your backend act in the same way as the deepl.com interface.

== Licensing ==
No license needed

== Installation ==
Go to the PBX manager and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"Translations"''' and click on it
* Select the proper firmware version, for example '''"v15"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the install yellow button
* Wait until the install has been finished
* Close and open the PBX manager to refresh the list of the available colored AP plugin
* Click on the '''"AP Translations"''' and click on '''" + Add an App"'''
* Enter a '''"Name"''' that is used as display name ''(all character allowed)'' for it and the '''"SIP"''' name that is the administrative field ''(no space, no capital letters)''. ''e.g : Name: Translations, SIP: translations''
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the translation API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Translation - Client ==
There is no view/app that the user can explicitly open. The service runs in the background and has no UI and can be integrated by other apps.
In order for the user to have access to the translation service, their user object must have access to the app object of the translations app.

The client side of the app service receives requests from all other apps via the local JavaScript API and sends them to the service. The result of the request is returned to the original app via the local JavaScript API

== Translation - App Service ==
The App Service performs tasks in the following areas:
* Language recognition
* Caching
* Translations against the backend (deepl.com)

=== Language recognition ===
An offline API is offered to recognize the language used in a string. This recognition is also used for translations to avoid unnecessary translations (e.g. EN to EN translations are prevented). This payload will not be sent to any backend service, thus avoiding unnecessary costs. 
A few features exist which should make sure, a recognized language is only considered, if there is enough confidence:
* Strings shorter than 6 words are skipped, since the chance for false positives are relatively high
* Strings in which are not enough word matches to be confident for any language will be skipped, also because of high chances for false positives
* Strings in which are more than one language with a nearly similar amount of word matches will be skipped

Supported languages: de, en-gb, fr

=== Caching ===
To save costs, all translations are cached in the App Services database. If a string is translated multiple times, only the first translation is carried out by the backend and the translated version is saved in the cache. A second translation is therefore free of charge and performs better.

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend. After successful translation, the translated version is kept in the cache for future requests.

The list of supported languages depends on the supported languages of the used [https://developers.deepl.com/docs/resources/supported-languages#target-languages service provider]. It will be read from the service provider each time the Translations App Service starts.

== Troubleshooting ==

To troubleshoot this App Service, you need the traceflags ''App'', ''Database'', ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.translation/com.innovaphone.translation.htm SDK Documentation - Translation API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_Translations]]

Reference17:Apps/PbxManager/App Translations

2026-05-04T13:25:53Z

Slu: /* Add an app object */

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;Config Templates
:Enabled config templates where the App should be available.
:If config templates exist, they will be listed with a checkbox.
:The app object will be assigned to the config templates if a checkbox is checked. 
:'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

=== Translations Service ===
You have to configure the current active translations service.

=== DeepL ===
Specific https://www.deepl.com configuration

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwhise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key''

=== European eTranslation ===
Specific https://translation.ec.europa.eu/tools-and-resources/ai-translation-and-language-tools_en configuration

;Application Name
:The secret ''Application Name''

;Password
:The secret ''Password''

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]

Reference17:Apps/PbxManager/App Translations

2026-05-04T13:21:25Z

Slu: Created page with "With the translations PBX-Manager plugin, the needed app object can be created and configured. In addition, the app object can be assigned to specific config templates, if any exist. == Add an app object == ;Name :The ''name'' displayed for the app object which must be unique. ;SIP :The ''sip'' from the app object which must be unique. ;URL :The URL API Endpoint for the translation backend. : If the field is empty, which is the default, the API endpoint will be se..."

With the translations PBX-Manager plugin, the needed app object can be created and configured.
In addition, the app object can be assigned to specific config templates, if any exist.

== Add an app object ==

;Name
:The ''name'' displayed for the app object which must be unique.

;SIP
:The ''sip'' from the app object which must be unique.

;URL
:The URL API Endpoint for the translation backend.
: If the field is empty, which is the default, the API endpoint will be selected automatically depending on the type of the key. If key ends with ":fx" the URL <code>https://api-free.deepl.com</code> is used, otherwhise <code>https://api.deepl.com</code>

;API-Key
:The secret ''api-key'' for the translation backend (currently deepl.com).

If config templates exist, they will be listed with a checkbox.
The app object will be assigned to the config templates if a checkbox is checked. 
'''Be Aware:''' Every user who should be able to use the translation service needs to have it assigned (by using a config template, for example).

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Translations]]

[[Category:Concept App Service Translations]]

Reference17:Overview

2026-05-04T07:06:52Z

Slu: Created page with "__NOTOC__ = Overview = <div id="version_overview"></div>  We work continuously on our documentation. If you are missing something, please give us a short note to [mailto:presales@innovaphone.com presales@innovaphone.com] = Reference Articles = {{Special:Prefixindex/Reference17:}} = HowTo Articles = {{Special:Prefixindex/Howto17:}}..."

__NOTOC__
= Overview =
<div id="version_overview"></div>

We work continuously on our documentation. If you are missing something, please give us a short note to [mailto:presales@innovaphone.com presales@innovaphone.com]

= Reference Articles =
{{Special:Prefixindex/Reference17:}}

= HowTo Articles =
{{Special:Prefixindex/Howto17:}}

= HowTo MyApps Cloud Articles =
<categorytree mode="all" hideroot=on>MyApps_Cloud</categorytree>

= FAQ =
* [[Howto17:Firmware_Upgrade_V16r1_V17]]

Howto15r1:Install Contact Widget App

2026-04-29T07:52:12Z

Slu:

This article explains all the necessary steps to install the Contact Widget App and to configure a sidebar widget.

== General Consideration ==
The Contact Widgets App is new in firmware V14r1.
Also new in V14r1 is the “AP app installer” plugin in the PBX manager.
This guide is written for a 14r1 PBX and a 14r1 AP(App Platform) and the use of the app installer plugin. Installation is also possible from the AP itself, but is not covered in this wiki.
For all older versions, please upgrade first to V14r1 latest firmware.

== Installation ==
Go to the PBX manager and open the AP app installer plugin. In the right pane, the App Store will be shown.
* Choose All Apps
* Click in innovaphone AG
* Scroll down to the Contact Widgets App and click on it
* Select the proper firmware version
* Click on Install and accept the terms of use and continue with a click op install
* Wait until the install has been finished
* Refresh the view of the PBX manager to show the new installed AP widgets ''(Hint: close and open the PBX manager)''
* Click on the AP widget and click Add an App
* Enter the name of the Widget Object e.g. Widget and the SIP widget and enter the PBX name
* Tick in Licenses Video if you want to enable Video calls in the Widgets ''(Hint: A port license will also be consumed by the PBX app object used by the Contact Widget App)''
* You can enter the maximum amount of acquired Widget Licenses that this Object is allowed to consume. This License enables and advertisement free version of the widgets
* Tick the appropriate template for the User(s) that will use the Contact Widget App
[[image:WidgetObjectAdd.PNG]]

* Click OK to save the settings and a green checkmark will be shown
[[image:WidgetObjectAddOK.PNG]]

You have set the "Advanced Chat App" in "PBX/Config/General" to "old-chat-app".

==Add the Contact Widget App to your myApps homescreen ==

* Add the Contact Widget App to your myApps homescreen, by clicking on the All Apps icon at the right bottom, search for the Contact Widget App and click on the home symbol of the Contact Widget App.
[[image:ContactWidgetAppHome.PNG]]

* On your myApps homescreen open the Contact Widget App.
[[image:WidgetApp.PNG]]

==Configure a sidebar widget ==
In the Contact Widget App you have the option to add a widget from the type Sidebar and/or Cardset. In this wiki section, we will only show how to add the widget of type sidebar.

[[image:CWopenNEW.PNG]]

* Choose your preferred Website widget and add by clicking on the button “create new sidebar”

A new Sidebar widget has been created with the default name “New Sidebar Widget”
[[image:NewSideBarWidget.PNG]]

* Click on the pencil icon next to the name to change the name to an appropriate name.
* In the notes field, you can add some additional notes. It might make sense to add the URL of the website where this widget will be used.
[[image:SalesSideBarNotes.PNG]]

==Configure the general widget settings ==
* Configure the other settings in the section, Appearance (Position, Color, etc.)
* Configure a standard location address
* Click on the ? symbol for tooltips and consult the [https://wiki.innovaphone.com/index.php?title=Reference15r1:Concept_Contact_Widgets Concept_Contact_Widgets] for further details and options.

Once all desired fields are filled out, don’t forget to click on the SAVE button in the top right.

Every change/edit will show an orange rectangle around the save button.
The change(s) needs to be saved and will be immediately visible once the widget code is implemented on your website
[[image:SidebarSettingOK.PNG]]

==Add agents to the widget ==
Next step is to add one or more agents to the widget to handle the incoming calls and to be shown in the widget on your website.
* Click on the “Agents” button to the right from settings.
[[image:SidebarAgents.PNG]]

* Click on the “+ Add Agent” button
* Add the Agent's SIP-ID or click on the search icon to find and add an agent. Enter additional address and information if this differs from the settings field.
* Select how the agent can be contacted, Voice, Video, Chat and optional a link to a website with opening hours or calendar website etc.
* Select the type of status how the agents' availability should be shown.
[[image:SidebarAgentsNEW.PNG]]

Once all the details are filled out,
* click save again
[[image:SidebarAgentsOK.PNG]]

You can add multiple Agents to the Widget as you like.

==Copy source code to website ==
Next step, you can copy the website widget code from this widget and implement it on your website.
* Click on the “Code” button.
[[image:CodeButton.PNG]]

* Download or copy the code from the pop-up window.
[[image:CodeFile.PNG]]

For test purpose, you can save the code as HTML file on your local PC and open it.

A blank website including the widget will be shown and can be tested.

[[image:SidebarWidget.PNG]] [https://00094-apps.innovaphone.com/benelux.innovaphone.com/files/UI/Web/Sales_Sidebar_Widget.html&fileskey=T7N!7kRnXgirz_!t Widget-example]

Integrate this code on your website, and you are ready to go and use the widget on your website.

==Known Issues ==

==Related Articles==
[https://wiki.innovaphone.com/index.php?title=Reference15r1:Concept_Contact_Widgets Concept_Contact_Widgets]

[https://wiki.innovaphone.com/index.php?title=Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)&mobileaction=toggle_view_mobile Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)]

Howto16r1:Install Contact Widget App

2026-04-29T07:51:44Z

Slu:

This article explains all the necessary steps to install the Contact Widget App and to configure a sidebar widget.

== General Consideration ==
The Contact Widgets App is new in firmware V14r1.
Also new in V14r1 is the “AP app installer” plugin in the PBX manager.
This guide is written for a 14r1 PBX and a 14r1 AP(App Platform) and the use of the app installer plugin. Installation is also possible from the AP itself, but is not covered in this wiki.
For all older versions, please upgrade first to V14r1 latest firmware.

== Installation ==
Go to the PBX manager and open the AP app installer plugin. In the right pane, the App Store will be shown.
* Choose All Apps
* Click in innovaphone AG
* Scroll down to the Contact Widgets App and click on it
* Select the proper firmware version
* Click on Install and accept the terms of use and continue with a click op install
* Wait until the install has been finished
* Refresh the view of the PBX manager to show the new installed AP widgets ''(Hint: close and open the PBX manager)''
* Click on the AP widget and click Add an App
* Enter the name of the Widget Object e.g. Widget and the SIP widget and enter the PBX name
* Tick in Licenses Video if you want to enable Video calls in the Widgets ''(Hint: A port license will also be consumed by the PBX app object used by the Contact Widget App)''
* You can enter the maximum amount of acquired Widget Licenses that this Object is allowed to consume. This License enables and advertisement free version of the widgets
* Tick the appropriate template for the User(s) that will use the Contact Widget App
[[image:WidgetObjectAdd.PNG]]

* Click OK to save the settings and a green checkmark will be shown
[[image:WidgetObjectAddOK.PNG]]

==Add the Contact Widget App to your myApps homescreen ==

* Add the Contact Widget App to your myApps homescreen, by clicking on the All Apps icon at the right bottom, search for the Contact Widget App and click on the home symbol of the Contact Widget App.
[[image:ContactWidgetAppHome.PNG]]

* On your myApps homescreen open the Contact Widget App.
[[image:WidgetApp.PNG]]

==Configure a sidebar widget ==
In the Contact Widget App you have the option to add a widget from the type Sidebar and/or Cardset. In this wiki section, we will only show how to add the widget of type sidebar.

[[image:CWopenNEW.PNG]]

* Choose your preferred Website widget and add by clicking on the button “create new sidebar”

A new Sidebar widget has been created with the default name “New Sidebar Widget”
[[image:NewSideBarWidget.PNG]]

* Click on the pencil icon next to the name to change the name to an appropriate name.
* In the notes field, you can add some additional notes. It might make sense to add the URL of the website where this widget will be used.
[[image:SalesSideBarNotes.PNG]]

==Configure the general widget settings ==
* Configure the other settings in the section, Appearance (Position, Color, etc.)
* Configure a standard location address
* Click on the ? symbol for tooltips and consult the [https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_Contact_Widgets Concept_Contact_Widgets] for further details and options.

Once all desired fields are filled out, don’t forget to click on the SAVE button in the top right.

Every change/edit will show an orange rectangle around the save button.
The change(s) needs to be saved and will be immediately visible once the widget code is implemented on your website
[[image:SidebarSettingOK.PNG]]

==Add agents to the widget ==
Next step is to add one or more agents to the widget to handle the incoming calls and to be shown in the widget on your website.
* Click on the “Agents” button to the right from settings.
[[image:SidebarAgents.PNG]]

* Click on the “+ Add Agent” button
* Add the Agent's SIP-ID or click on the search icon to find and add an agent. Enter additional address and information if this differs from the settings field.
* Select how the agent can be contacted, Voice, Video, Chat and optional a link to a website with opening hours or calendar website etc.
* Select the type of status how the agents' availability should be shown.
[[image:SidebarAgentsNEW.PNG]]

Once all the details are filled out,
* click save again
[[image:SidebarAgentsOK.PNG]]

You can add multiple Agents to the Widget as you like.

==Copy source code to website ==
Next step, you can copy the website widget code from this widget and implement it on your website.
* Click on the “Code” button.
[[image:CodeButton.PNG]]

* Download or copy the code from the pop-up window.
[[image:CodeFile.PNG]]

For test purpose, you can save the code as HTML file on your local PC and open it.

A blank website including the widget will be shown and can be tested.

[[image:SidebarWidget.PNG]] [https://00094-apps.innovaphone.com/benelux.innovaphone.com/files/UI/Web/Sales_Sidebar_Widget.html&fileskey=T7N!7kRnXgirz_!t Widget-example]

Integrate this code on your website, and you are ready to go and use the widget on your website.

==Known Issues ==

==Related Articles==
[https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_Contact_Widgets Concept_Contact_Widgets]

[https://wiki.innovaphone.com/index.php?title=Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)&mobileaction=toggle_view_mobile Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)]

Reference16r1:Concept Contact Widgets

2026-04-29T07:51:21Z

Slu:

[[Category:Concept|Conference]]

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

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto16r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
<big>If an issue can be reproduced</big>

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference16r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

Go to the AP Manager and select the App instance from the Contact Widgets App.
Click on Diagnose and make sure that the box App is ticked.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
= Related Articles =
[[Howto16r1:Install_Contact_Widget_App|Howto16r1:Install_Contact_Widget_App]]

Reference15r1:Concept Contact Widgets

2026-04-29T07:50:53Z

Slu:

[[Category:Concept|Conference]]

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

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto15r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

You have set the "Advanced Chat App" in "PBX/Config/General" to "old-chat-app".

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
<big>If an issue can be reproduced</big>

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference15r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

Go to the AP Manager and select the App instance from the Contact Widgets App.
Click on Diagnose and make sure that the box App is ticked.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
= Related Articles =
[[Howto15r1:Install_Contact_Widget_App|Howto15r1:Install_Contact_Widget_App]]

Reference15r1:Concept Contact Widgets

2026-04-29T07:50:24Z

Slu: /* Related Articles */

[[Category:Concept|Conference]]

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

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto14r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

You have set the "Advanced Chat App" in "PBX/Config/General" to "old-chat-app".

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
<big>If an issue can be reproduced</big>

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference14r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

Go to the AP Manager and select the App instance from the Contact Widgets App.
Click on Diagnose and make sure that the box App is ticked.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
= Related Articles =
[[Howto15r1:Install_Contact_Widget_App|Howto14r1:Install_Contact_Widget_App]]

Howto15r1:Install Contact Widget App

2026-04-29T07:46:21Z

Slu: /* Installation */

This article explains all the necessary steps to install the Contact Widget App and to configure a sidebar widget.

== General Consideration ==
The Contact Widgets App is new in firmware V14r1.
Also new in V14r1 is the “AP app installer” plugin in the PBX manager.
This guide is written for a 14r1 PBX and a 14r1 AP(App Platform) and the use of the app installer plugin. Installation is also possible from the AP itself, but is not covered in this wiki.
For all older versions, please upgrade first to V14r1 latest firmware.

== Installation ==
Go to the PBX manager and open the AP app installer plugin. In the right pane, the App Store will be shown.
* Choose All Apps
* Click in innovaphone AG
* Scroll down to the Contact Widgets App and click on it
* Select the proper firmware version
* Click on Install and accept the terms of use and continue with a click op install
* Wait until the install has been finished
* Refresh the view of the PBX manager to show the new installed AP widgets ''(Hint: close and open the PBX manager)''
* Click on the AP widget and click Add an App
* Enter the name of the Widget Object e.g. Widget and the SIP widget and enter the PBX name
* Tick in Licenses Video if you want to enable Video calls in the Widgets ''(Hint: A port license will also be consumed by the PBX app object used by the Contact Widget App)''
* You can enter the maximum amount of acquired Widget Licenses that this Object is allowed to consume. This License enables and advertisement free version of the widgets
* Tick the appropriate template for the User(s) that will use the Contact Widget App
[[image:WidgetObjectAdd.PNG]]

* Click OK to save the settings and a green checkmark will be shown
[[image:WidgetObjectAddOK.PNG]]

You have set the "Advanced Chat App" in "PBX/Config/General" to "old-chat-app".

==Add the Contact Widget App to your myApps homescreen ==

* Add the Contact Widget App to your myApps homescreen, by clicking on the All Apps icon at the right bottom, search for the Contact Widget App and click on the home symbol of the Contact Widget App.
[[image:ContactWidgetAppHome.PNG]]

* On your myApps homescreen open the Contact Widget App.
[[image:WidgetApp.PNG]]

==Configure a sidebar widget ==
In the Contact Widget App you have the option to add a widget from the type Sidebar and/or Cardset. In this wiki section, we will only show how to add the widget of type sidebar.

[[image:CWopenNEW.PNG]]

* Choose your preferred Website widget and add by clicking on the button “create new sidebar”

A new Sidebar widget has been created with the default name “New Sidebar Widget”
[[image:NewSideBarWidget.PNG]]

* Click on the pencil icon next to the name to change the name to an appropriate name.
* In the notes field, you can add some additional notes. It might make sense to add the URL of the website where this widget will be used.
[[image:SalesSideBarNotes.PNG]]

==Configure the general widget settings ==
* Configure the other settings in the section, Appearance (Position, Color, etc.)
* Configure a standard location address
* Click on the ? symbol for tooltips and consult the [https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_Contact_Widgets Concept_Contact_Widgets] for further details and options.

Once all desired fields are filled out, don’t forget to click on the SAVE button in the top right.

Every change/edit will show an orange rectangle around the save button.
The change(s) needs to be saved and will be immediately visible once the widget code is implemented on your website
[[image:SidebarSettingOK.PNG]]

==Add agents to the widget ==
Next step is to add one or more agents to the widget to handle the incoming calls and to be shown in the widget on your website.
* Click on the “Agents” button to the right from settings.
[[image:SidebarAgents.PNG]]

* Click on the “+ Add Agent” button
* Add the Agent's SIP-ID or click on the search icon to find and add an agent. Enter additional address and information if this differs from the settings field.
* Select how the agent can be contacted, Voice, Video, Chat and optional a link to a website with opening hours or calendar website etc.
* Select the type of status how the agents' availability should be shown.
[[image:SidebarAgentsNEW.PNG]]

Once all the details are filled out,
* click save again
[[image:SidebarAgentsOK.PNG]]

You can add multiple Agents to the Widget as you like.

==Copy source code to website ==
Next step, you can copy the website widget code from this widget and implement it on your website.
* Click on the “Code” button.
[[image:CodeButton.PNG]]

* Download or copy the code from the pop-up window.
[[image:CodeFile.PNG]]

For test purpose, you can save the code as HTML file on your local PC and open it.

A blank website including the widget will be shown and can be tested.

[[image:SidebarWidget.PNG]] [https://00094-apps.innovaphone.com/benelux.innovaphone.com/files/UI/Web/Sales_Sidebar_Widget.html&fileskey=T7N!7kRnXgirz_!t Widget-example]

Integrate this code on your website, and you are ready to go and use the widget on your website.

==Known Issues ==

==Related Articles==
[https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_Contact_Widgets Concept_Contact_Widgets]

[https://wiki.innovaphone.com/index.php?title=Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)&mobileaction=toggle_view_mobile Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)]

Howto16r1:Install Contact Widget App

2026-04-29T07:45:44Z

Slu: Created page with " This article explains all the necessary steps to install the Contact Widget App and to configure a sidebar widget. == General Consideration == The Contact Widgets App is new in firmware V14r1. Also new in V14r1 is the “AP app installer” plugin in the PBX manager. This guide is written for a 14r1 PBX and a 14r1 AP(App Platform) and the use of the app installer plugin. Installation is also possible from the AP itself, but i..."

This article explains all the necessary steps to install the Contact Widget App and to configure a sidebar widget.

== General Consideration ==
The Contact Widgets App is new in firmware V14r1.
Also new in V14r1 is the “AP app installer” plugin in the PBX manager.
This guide is written for a 14r1 PBX and a 14r1 AP(App Platform) and the use of the app installer plugin. Installation is also possible from the AP itself, but is not covered in this wiki.
For all older versions, please upgrade first to V14r1 latest firmware.

== Installation ==
Go to the PBX manager and open the AP app installer plugin. In the right pane, the App Store will be shown.
* Choose All Apps
* Click in innovaphone AG
* Scroll down to the Contact Widgets App and click on it
* Select the proper firmware version
* Click on Install and accept the terms of use and continue with a click op install
* Wait until the install has been finished
* Refresh the view of the PBX manager to show the new installed AP widgets ''(Hint: close and open the PBX manager)''
* Click on the AP widget and click Add an App
* Enter the name of the Widget Object e.g. Widget and the SIP widget and enter the PBX name
* Tick in Licenses Video if you want to enable Video calls in the Widgets ''(Hint: A port license will also be consumed by the PBX app object used by the Contact Widget App)''
* You can enter the maximum amount of acquired Widget Licenses that this Object is allowed to consume. This License enables and advertisement free version of the widgets
* Tick the appropriate template for the User(s) that will use the Contact Widget App
[[image:WidgetObjectAdd.PNG]]

* Click OK to save the settings and a green checkmark will be shown
[[image:WidgetObjectAddOK.PNG]]

==Add the Contact Widget App to your myApps homescreen ==

* Add the Contact Widget App to your myApps homescreen, by clicking on the All Apps icon at the right bottom, search for the Contact Widget App and click on the home symbol of the Contact Widget App.
[[image:ContactWidgetAppHome.PNG]]

* On your myApps homescreen open the Contact Widget App.
[[image:WidgetApp.PNG]]

==Configure a sidebar widget ==
In the Contact Widget App you have the option to add a widget from the type Sidebar and/or Cardset. In this wiki section, we will only show how to add the widget of type sidebar.

[[image:CWopenNEW.PNG]]

* Choose your preferred Website widget and add by clicking on the button “create new sidebar”

A new Sidebar widget has been created with the default name “New Sidebar Widget”
[[image:NewSideBarWidget.PNG]]

* Click on the pencil icon next to the name to change the name to an appropriate name.
* In the notes field, you can add some additional notes. It might make sense to add the URL of the website where this widget will be used.
[[image:SalesSideBarNotes.PNG]]

==Configure the general widget settings ==
* Configure the other settings in the section, Appearance (Position, Color, etc.)
* Configure a standard location address
* Click on the ? symbol for tooltips and consult the [https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_Contact_Widgets Concept_Contact_Widgets] for further details and options.

Once all desired fields are filled out, don’t forget to click on the SAVE button in the top right.

Every change/edit will show an orange rectangle around the save button.
The change(s) needs to be saved and will be immediately visible once the widget code is implemented on your website
[[image:SidebarSettingOK.PNG]]

==Add agents to the widget ==
Next step is to add one or more agents to the widget to handle the incoming calls and to be shown in the widget on your website.
* Click on the “Agents” button to the right from settings.
[[image:SidebarAgents.PNG]]

* Click on the “+ Add Agent” button
* Add the Agent's SIP-ID or click on the search icon to find and add an agent. Enter additional address and information if this differs from the settings field.
* Select how the agent can be contacted, Voice, Video, Chat and optional a link to a website with opening hours or calendar website etc.
* Select the type of status how the agents' availability should be shown.
[[image:SidebarAgentsNEW.PNG]]

Once all the details are filled out,
* click save again
[[image:SidebarAgentsOK.PNG]]

You can add multiple Agents to the Widget as you like.

==Copy source code to website ==
Next step, you can copy the website widget code from this widget and implement it on your website.
* Click on the “Code” button.
[[image:CodeButton.PNG]]

* Download or copy the code from the pop-up window.
[[image:CodeFile.PNG]]

For test purpose, you can save the code as HTML file on your local PC and open it.

A blank website including the widget will be shown and can be tested.

[[image:SidebarWidget.PNG]] [https://00094-apps.innovaphone.com/benelux.innovaphone.com/files/UI/Web/Sales_Sidebar_Widget.html&fileskey=T7N!7kRnXgirz_!t Widget-example]

Integrate this code on your website, and you are ready to go and use the widget on your website.

==Known Issues ==

==Related Articles==
[https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_Contact_Widgets Concept_Contact_Widgets]

[https://wiki.innovaphone.com/index.php?title=Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)&mobileaction=toggle_view_mobile Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)]

Howto15r1:Install Contact Widget App

2026-04-29T07:45:30Z

This article explains all the necessary steps to install the Contact Widget App and to configure a sidebar widget.

== General Consideration ==
The Contact Widgets App is new in firmware V14r1.
Also new in V14r1 is the “AP app installer” plugin in the PBX manager.
This guide is written for a 14r1 PBX and a 14r1 AP(App Platform) and the use of the app installer plugin. Installation is also possible from the AP itself, but is not covered in this wiki.
For all older versions, please upgrade first to V14r1 latest firmware.

== Installation ==
Go to the PBX manager and open the AP app installer plugin. In the right pane, the App Store will be shown.
* Choose All Apps
* Click in innovaphone AG
* Scroll down to the Contact Widgets App and click on it
* Select the proper firmware version
* Click on Install and accept the terms of use and continue with a click op install
* Wait until the install has been finished
* Refresh the view of the PBX manager to show the new installed AP widgets ''(Hint: close and open the PBX manager)''
* Click on the AP widget and click Add an App
* Enter the name of the Widget Object e.g. Widget and the SIP widget and enter the PBX name
* Tick in Licenses Video if you want to enable Video calls in the Widgets ''(Hint: A port license will also be consumed by the PBX app object used by the Contact Widget App)''
* You can enter the maximum amount of acquired Widget Licenses that this Object is allowed to consume. This License enables and advertisement free version of the widgets
* Tick the appropriate template for the User(s) that will use the Contact Widget App
[[image:WidgetObjectAdd.PNG]]

* Click OK to save the settings and a green checkmark will be shown
[[image:WidgetObjectAddOK.PNG]]

==Add the Contact Widget App to your myApps homescreen ==

* Add the Contact Widget App to your myApps homescreen, by clicking on the All Apps icon at the right bottom, search for the Contact Widget App and click on the home symbol of the Contact Widget App.
[[image:ContactWidgetAppHome.PNG]]

* On your myApps homescreen open the Contact Widget App.
[[image:WidgetApp.PNG]]

==Configure a sidebar widget ==
In the Contact Widget App you have the option to add a widget from the type Sidebar and/or Cardset. In this wiki section, we will only show how to add the widget of type sidebar.

[[image:CWopenNEW.PNG]]

* Choose your preferred Website widget and add by clicking on the button “create new sidebar”

A new Sidebar widget has been created with the default name “New Sidebar Widget”
[[image:NewSideBarWidget.PNG]]

* Click on the pencil icon next to the name to change the name to an appropriate name.
* In the notes field, you can add some additional notes. It might make sense to add the URL of the website where this widget will be used.
[[image:SalesSideBarNotes.PNG]]

==Configure the general widget settings ==
* Configure the other settings in the section, Appearance (Position, Color, etc.)
* Configure a standard location address
* Click on the ? symbol for tooltips and consult the [https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_Contact_Widgets Concept_Contact_Widgets] for further details and options.

Once all desired fields are filled out, don’t forget to click on the SAVE button in the top right.

Every change/edit will show an orange rectangle around the save button.
The change(s) needs to be saved and will be immediately visible once the widget code is implemented on your website
[[image:SidebarSettingOK.PNG]]

==Add agents to the widget ==
Next step is to add one or more agents to the widget to handle the incoming calls and to be shown in the widget on your website.
* Click on the “Agents” button to the right from settings.
[[image:SidebarAgents.PNG]]

* Click on the “+ Add Agent” button
* Add the Agent's SIP-ID or click on the search icon to find and add an agent. Enter additional address and information if this differs from the settings field.
* Select how the agent can be contacted, Voice, Video, Chat and optional a link to a website with opening hours or calendar website etc.
* Select the type of status how the agents' availability should be shown.
[[image:SidebarAgentsNEW.PNG]]

Once all the details are filled out,
* click save again
[[image:SidebarAgentsOK.PNG]]

You can add multiple Agents to the Widget as you like.

==Copy source code to website ==
Next step, you can copy the website widget code from this widget and implement it on your website.
* Click on the “Code” button.
[[image:CodeButton.PNG]]

* Download or copy the code from the pop-up window.
[[image:CodeFile.PNG]]

For test purpose, you can save the code as HTML file on your local PC and open it.

A blank website including the widget will be shown and can be tested.

[[image:SidebarWidget.PNG]] [https://00094-apps.innovaphone.com/benelux.innovaphone.com/files/UI/Web/Sales_Sidebar_Widget.html&fileskey=T7N!7kRnXgirz_!t Widget-example]

Integrate this code on your website, and you are ready to go and use the widget on your website.

==Known Issues ==

==Related Articles==
[https://wiki.innovaphone.com/index.php?title=Reference14r1:Concept_Contact_Widgets Concept_Contact_Widgets]

[https://wiki.innovaphone.com/index.php?title=Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)&mobileaction=toggle_view_mobile Howto:Install_the_innovaphone_Call-Me-Button_Widgets_(en)]

Reference15r1:Concept Contact Widgets

2026-04-29T07:44:57Z

Slu: /* Configuration */

[[Category:Concept|Conference]]

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

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto14r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

You have set the "Advanced Chat App" in "PBX/Config/General" to "old-chat-app".

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
<big>If an issue can be reproduced</big>

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference14r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

Go to the AP Manager and select the App instance from the Contact Widgets App.
Click on Diagnose and make sure that the box App is ticked.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
= Related Articles =
[[Howto14r1:Install_Contact_Widget_App|Howto14r1:Install_Contact_Widget_App]]

Reference16r1:Concept Contact Widgets

2026-04-29T07:41:24Z

Slu: Created page with "Conference = Applies To = * innovaphone PBX from version 14r1 * innovaphone Application Platform = Requirements = * innovaphone PBX * innovaphone Application Platform * Firmware Version 14r1 * One '''Port License''' is used by the app service to establish a VoIP registration at the PBX * '''Video License''' (optional) is required to establish video connections [*] * '''Widget License''' (optional) is required to remove any 'innovaphone' branding fr..."

[[Category:Concept|Conference]]

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

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto14r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
<big>If an issue can be reproduced</big>

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference14r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

Go to the AP Manager and select the App instance from the Contact Widgets App.
Click on Diagnose and make sure that the box App is ticked.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
= Related Articles =
[[Howto14r1:Install_Contact_Widget_App|Howto14r1:Install_Contact_Widget_App]]

Reference15r1:Concept Contact Widgets

2026-04-29T07:41:10Z

[[Category:Concept|Conference]]

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

= Requirements =
* innovaphone PBX
* innovaphone Application Platform
* Firmware Version 14r1
* One '''Port License''' is used by the app service to establish a VoIP registration at the PBX
* '''Video License''' (optional) is required to establish video connections [*]
* '''Widget License''' (optional) is required to remove any 'innovaphone' branding from the Widget UI

[*] '''UC License''' can also be used since it includes a '''Video License'''

= What is a Contact Widget? =
A Contact Widget (or Website Widget) is an element that can be added to a website. It offers to website visitors a way to get in contact with agents (e.g. help-desk). Website visitors can start chat sessions (asking questions, getting answers) or can start voice or even video calls.

An nice example for a "Sidebar Widget" can be viewed [https://www.innovaphone.com/de/ip-telefonie/innovaphone-pbx.html here]. 
When you have opened this website the Sidebar Widget comes slowly into view on the right side.

Example of a Business-Cards-Widget:

[[File:Cardset-widget.png]]

Example of a Sidebar-Widget:

[[File:Sidebar-Widget.png]]

= Overview =
[[File:Concept-widgets-overview.png|thumb|Overview]]
The central part of the new Widgets-Concept is the '''Contact-Widgets-App'''.
The Contact Widgets App is installed on the innovaphone Application Platform and it allows a PBX user to define Contact Widgets.

Contact Widgets can be integrated in a Website to offer easy ways to website users to contact '''Agents'''. Agents are PBX users meant to communicate with external clients. 
There are 2 fundamental types of Contact Widgets:
* '''Sidebar Widgets'''
* '''Business Cards Widgets'''

A Sidebar Widget appears one side of the website trying to take as less space as possible. The website visitor can expand the Sidebar Widget if interested. 
A Business Cards Widget appears as integrated part of the website content, offering one (or more) contacts in form of ordinary business cards.

= Configuration =
For non experienced technicians have a look at [[Howto14r1:Install_Contact_Widget_App#Installation]] and follow the installation steps mentioned in the how-to article.

Others:
* Download the 'Contact Widgets App' via App Store.
* Install the App on the App Platform Manager.
* Create an instance for the Widgets App on the Manager. We recommend to use no capital letters and no special characters (also not such as space).
* Create a new PBX Object with the PBX Manager Plugin. (*)
* Assign App to authorized (admin) users, which will be allowed to create/change/delete Contact Widgets.

Experts:
(*) You can also create the PBX Object manually: 
* Create a new object of type "App".
* Give it a "Long Name" ("Contact Widgets") and a Name ("widgets") same as the instance-name.
* Give it a password, same as the instance password.
* On the "App" tab configure URL to App Service on App Platform ("http://<ipaddress-or-dnsname>/<instance-name>/innovaphone-widgets").
* Activate option "Websocket"
* Grant access to APIs: "PbxSignal" (mandatory), "Admin" (optional) and "PbxApi" (mandatory)

= Using the Contact Widgets App =
Click on one of the buttons (depending on what type of widget you want to create):
* [+ Add new sidebar widget]
* [+ Add new business cards widget]
A new (empty) widget is displayed. You can give the widget a name by clicking the pen-symbol. The widget name helps to identify widgets as soon the number of widgets starts to grow. 
You can expand and collaps widgets by clicking the header of each widget.
[[Image:Widget-code-new-widget.png|thumb|New Widget]]

== Creating a new Widget ==

New Widget features and options

*You can add the main contact details for this widget
*Select the default language
*Set your prefered font settings *
*Change the colour settings *
*Change the margin settings *
*z-index
*Options Require license (when this checkbox is ticked, this widget will consume 1 license of type: Service(innovaphone-widgets) and the widget will be shown without advertisement)
(* By default, the Widget will use the default website font, colour and margin settings. Change can be needed depending on the website settings)
[[Image:Widget-new-widget-features.png|thumb|Widget Features]]

== Adding Agent to Widget ==
You can add and remove Agents to a Widget. Agents can be contacted by external website visitors. 
New agents are added by clicking the [+] button inside the agents container.
[[File:Adding-new-agents.png|thumb|Adding agents]]
A dialog opens where you can define the agent. It all starts with the agent's 'SIP-ID'. That's the dialable PBX user address. You can use the search function to find a PBX user by name.

There are several (optional) attributes you can set for an agent, like 'Display name', 'Phone number', 'Email address' and 'Picture'. A picture can be placed by drag & drop or can be selected from local disk by clicking the placeholder rectangle.

Finally you can define the ways of communication the agent is available for:
* Voice-only calls
* Video calls (including voice)
* Chat
* Email

For a Business-Cards-Widget the order of agents could be relevant. You can change the order of agents in the Widgets-App by easy drag & drop using the mouse.

Each widget gets a unique ID (uuid) assigned on its initial creation. This uuid is used to identify the widget when it is integrated into a website.

In case of a sidebar widget, the agent's card will be displayed by default depending on its status(availability) unless you checked "Always show widget" under the sidebar settings.

In case of a business cards widget, the agent card will always be shown, but its availability is depending on its status.

The following settings are possible:
* Presence*: Display/availability of the card based on the presence status of the agent. Presence available (green), Presence unavailable, busy (red). Usage: Normal agent based on availability.
* Always online: Permanent display/availability of the card regardless of its presence or busy status. Usage: Multiple consecutive calls to the same destination, an agent with multiple line configuration, a group or waiting queue.
* Boolean*: Display of the card depending on the true status of a Boolean object. Usage: Agent, group or waiting queues based on boolean settings.
* Inactive: Agent card is permanently in the status unavailable (red). Usage: Showing the agent in a business cards widget, but limit the access to the agent for a longer period. (holiday, sick-leave or other reasons)
'''Important!''': Presence and boolean status are dependent on the visibility configured on all the monitored objects, eg. agent user objects and monitored boolean objects. The boolean object must have the visibility option "calls" checked before adding the boolean to the widget!

= Integrating Widgets into Website =
Now it is the website admin's turn to integrate the widget into the website. 
To do this, click the [Code] button in the Widgets App at that widget you want to include. A popup appears showing a handful of code lines (HTML and Javascript). 
[[File:Widget-code-popup.png|thumb|Code Popup]]
You can ''copy'' the code lines into clipboard by clicking the [Copy] button. 
You can ''paste'' the code lines from clipboard into your website code. 
There's also a [Download] button. When clicking this button a small HTML file is saved on your local computer. This HTML file can be opened in a browser to preview the widget and test the widget's functionality.

== Content-Security-Policy ==
If the website uses Content-Security-Policy (CSP) it could be necessary to add entries to config sections 'default-src' and 'img-src'.
* The Widget opens a secure websocket connection (wss:)
* The Widget loads images via Data-URL (data:).
* The Widget uses Mail-Links (mailto:).
* The Widget uses Tel-Links (tel:).
<meta
http-equiv="Content-Security-Policy" content="
default-src 'self' '''wss://*.innovaphone.com'''; child-src 'self' '''mailto:''' '''tel:'''; img-src '''data:'''"
/>

= After Integration =
Once your widget is live on the website you can still change and update the widget in the Widgets-App. You can update the list of agents or change any other attribute. As soon as you click the widget's [Save] button any open widget instance in a web browser will update immmediately. No need for the website administrator to update the code.

= Widget-API — Protocol between Website Widget and App Service =
Basically, this section does not matter. To create and use widgets, knowledge about the protocol is not required. 
All who are interested in technical details are welcome to read on.

== Loading the Widget ==

When a widget is loaded in the browser window of the website visitor, a websocket connection is opened to the app service on the innovaphone Application Platform. Once the websocket connection is established it goes like this:
<pre>
[1] {"mt":"Start","uuid":"fadc5da4cae94bfc9434d9957ea08ccb"}
[2] {"mt":"Session","name":"Visitenkarten","lang":"de","strings":{...}}
[3] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
[4] {"mt":"GetPicture","id":"atlantis"}
[5] {"mt":"Info","id":"columbia","dn":"Columbia","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":1}
[6] {"mt":"GetPicture","id":"columbia"}
[7] {"mt":"IceConfig","stun":"stun.innovaphone.com","turn":"turn.innovaphone.com"}
[8] {"mt":"Picture","id":"atlantis","url":"data:image/jpeg;base64..."}
[9] {"mt":"Picture","id":"columbia","url":"data:image/jpeg;base64..."}
[10] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"offline","media":["voice","video","email","chat"],"order":0}
[11] {"mt":"Info","id":"atlantis","dn":"Atlantis","department":"","phonenumber":"","email":"","company":{},"presence":"online","media":["voice","video","email","chat"],"order":0}
</pre>

[1] The "Start" request is sent with the unique id of the widget. 
[2] The app service sends the "Session" response providing the widget's display-name and other parameters. 
[3]-[6] The app service sends "Info" messages for all configured agents. Each "Info" message triggers a "GetPicture" request to get a picture of the agent. 
[7] The app service sends "IceConfig" providing the STUN and TURN config required for media calls. 
[8]-[9] The app service sends "Picture" messages for all agents. 
[10]-[11] The presence of an agent may change over time. Presence updates are provided with "Info" messages.

== Initiating a call ==

<pre>
[1] {"mt":"CreateCall","dest":"atlantis","dn":"Mein Name"}
[2] {"mt":"Channels","cmd":"PROPOSAL","sdp":"..."}
[3] {"mt":"CallInfo","state":"alerting"}
[4] {"mt":"CallInfo","state":"connected","cmd":"SELECT","sdp":"..."}
[5] {"mt":"ClearCall"}
[6] {"mt":"CallInfo","state":"terminated"}
</pre>

[1] "CreatCall" message sets the target of the call ('dest') and the own display name ('dn'). 
[2] "Channels" message provides the media offer for this call. Complete SDP offer is provided. 
[3] "CallInfo" is received giving information about the call's current state. 
[4] Next "CallInfo" is received telling the call was answered and deliviering the remote side's media answer. 
[5] Web site user terminates the call. 
[6] The final "CallInfo" message is received. 

= Known issues and limitations =
* The widgets are not multi-instance capable. Multiple widgets on one and the same website are not possible. Every subpage on the website can have its own widget.
* We have seen some cases where an existing web widget from other software did have a negative impact on our widget on the website. Rearranging the widget in the HTML code might help.
* The number of Agents in a single Sidebar or Business Cards is limited by the length of the sidebar/business card configuration. Just over 100 agents will normally not be a problem. From V15r1sr4 onwards a config check has been built in to prevent too lengthy configurations, so this version is recommended for sidebars and business cards with plenty of agents.

= Troubleshooting =
<big>If an issue can be reproduced</big>

'''*Web visitor in a browser.''' 
The myApps web uses the logging facilities provided by the browser it runs in (i.e. JavaScript function <code>console.log</code>). In most browser this is available as ''Console'' after pressing F12.

'''*The called agent working with myApps client.''' 
The myApps platform services provide more elaborate tracing mechanisms. See ''Troubleshooting'' in [[Reference14r1:Concept_myApps_platform_services#Troubleshooting|Concept myApps platform services]].

'''*Troubleshooting AP Services on the AP.''' 
Troubleshooting a specific App instance on the AP [[Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs|Courseware:IT_Plus_-_Tools_for_Troubleshooting#App_Service_Logs]]

Go to the AP Manager and select the App instance from the Contact Widgets App.
Click on Diagnose and make sure that the box App is ticked.
[[File:AP-Diagnostics.png|thumb|none|AP-Diagnostics]]
Make sure that the logging of the App instance has been activated.
[[File:AP-DiagnosticsLogging.png|thumb|none|AP-Diagnostics-Logging]]
= Related Articles =
[[Howto14r1:Install_Contact_Widget_App|Howto14r1:Install_Contact_Widget_App]]

Howto16r1:Configure OAuth2 E-Mail

2026-04-28T12:12:21Z

Slu:

The innovaphone PBX and apps can be configured to send E-Mails for various subjects and purposes. Major E-Mail providers intent to discontinue the username/password authentication schemes in favour of OAuth2. PBX and Apps version 16r1 does support OAuth2 authentication for SMTP. Here is a step by step guide how to set up OAuth2 support in Microsoft 365 through the Azure Portal and how to set it up on a Google Gmail account in the Google Cloud Console.

== General Information ==
Most of the large email providers offer the possibility to define an app that is allowed to gain access of a certain scope like SMTP. 
It assigns a Client ID / Client Secret. 
 
Authorization for sending from the mail account needs to be given one time either: 
* By providing resource owner username/password. Sending this to the token endpoint results in an access token and long term refresh token.
* By interactive authorization via a popup dialogue that is loaded from the authorization endpoint. After the credentials are verified, the dialogue redirects to the redirect URI with an authorization code that is traded to an access token and refresh token.
 
The access token is sent for authentication in SMTP. It needs regular refresh, which will be done automatically.

=== Modes ===

* '''Exchange''': Microsoft, with interactive authorization
* '''Microsoft 365''': Microsoft, without interactive authorization (Resource owner and password has to be filled)
* '''Gmail''': Google, with interactive authorization
* '''Google Service Account''': Google, without interactive authorization (Client e-mail, Private Key ID and Private Key of the service account must be provided)
* '''Client secret post''': Generic configuration where all parameters of the client secret post OAuth2 flow can be set.
* '''Private key jwt''': Generic configuration where all parameters of the private key jwt OAuth2 flow can be set.

=== Example Redirect URIs ===

* '''PBX''': <nowiki>https://example-pbx.domain.com/OAUTH2-CLIENT/auth.htm</nowiki>
* '''Reporting''': <nowiki>https://example-ap.domain.com/domain.com/reporting/auth.htm</nowiki>
* '''Fax''': <nowiki>https://example-ap.domain.com/domain.com/fax/auth.htm</nowiki>
* '''Users''': <nowiki>https://example-ap.domain.com/domain.com/usersapp/auth.htm</nowiki>
* '''Connect''': <nowiki>https://example-ap.domain.com/domain.com/messages/auth.htm</nowiki>
* '''AP Manager''': <nowiki>https://example-ap.domain.com/manager/auth.htm</nowiki>

== Microsoft 365 ==
=== Azure Portal ===
Log in to Microsoft Azure Portal (https://portal.azure.com) and go to Microsoft Entra ID.
[[File:AzureMicrosoftEntraID.png|none|thumb|600x600px|/AzureMicrosoftEntraID.png|/AzureMicrosoftEntraID.png]]
Add a new app registration to create client credentials.
[[File:AzureAddAppRegistration.png|none|thumb|600x600px|/AzureAddAppRegistration.png|/AzureAddAppRegistration.png]]
Register the application and maybe already fill in the redirect URI for Web based application type to path OAUTH2-CLIENT/auth.htm at the PBX.
[[File:AzureRegisterAnApplication.png|none|thumb|600x600px|/AzureRegisterAnApplication.png|/AzureRegisterAnApplication.png]]
App registration is complete. Client ID and tenant needs to be configured at the PBX and every app that will be sending e-mails.
[[File:AzureApp.png|none|thumb|600x600px|/AzureApp.png|/AzureApp.png]]
Create a client secret. Note that expiry is limited to no longer than 2 years. The client secret must be renewed before expiry and the new secret configured and interactive authorisation carried out again to ensure continuous operation.
[[File:AzureAddClientSecret.png|none|thumb|600x600px|/AzureAddClientSecret.png|/AzureAddClientSecret.png]]
Copy the client secret. It also needs to be configured at the PBX and every app that will be sending e-mails.
[[File:AzureCopyClientSecret.png|none|thumb|600x600px|/AzureCopyClientSecret.png|/AzureCopyClientSecret.png]]
Add permissions located in APIs my organization uses.
[[File:AzureAddApiPermissionMyOrganization.png|none|thumb|600x600px|/AzureAddApiPermissionMyOrganization.png|/AzureAddApiPermissionMyOrganization.png]]
More precisely located in Office 365 Exchange Online.
[[File:AzureAddApiPermissionExchange.png|none|thumb|600x600px|/AzureAddApiPermissionExchange.png|/AzureAddApiPermissionExchange.png]]
And there in the application permissions.
[[File:AzureAddApiExchangeApplication.png|none|thumb|600x600px|/AzureAddApiExchangeApplication.png|/AzureAddApiExchangeApplication.png]]
Namely SMTP Mail.Send.
[[File:AzureAddApiSendMailAsUser.png|none|thumb|600x600px|/AzureAddApiSendMailAsUser.png|/AzureAddApiSendMailAsUser.png]]
Grant admin permission for Mail.Send.
[[File:AzureGrantApiPermissions.png|none|thumb|600x600px|/AzureGrantApiPermissions.png|/AzureGrantApiPermissions.png]]
API permissions are now granted.
[[File:AzureApiPermissionsGranted.png|none|thumb|600x600px|/AzureApiPermissionsGranted.png|/AzureApiPermissionsGranted.png]]
Tell all redirect URIs that the PBX and the apps will be using during interactive authorization.
[[File:AzureRedirectUris.png|none|thumb|600x600px|/AzureRedirectUris.png|/AzureRedirectUris.png]]
Allow public client flows of OAuth2. Resource Owner Password Credentials Flow has the advantage that it doesn't need interactive authorization.
[[File:AzureAllowPublicClientFlows.png|none|thumb|600x600px|/AzureAllowPublicClientFlows.png|/AzureAllowPublicClientFlows.png]]

=== Microsoft 365 admin center ===
Log in to the Microsoft 365 admin center (https://admin.cloud.microsoft).
[[File:MS365AdminCenter.png|none|thumb|600x600px|/MS365AdminCenter.png|/MS365AdminCenter.png]]
Make sure that Microsoft 365 licenses are assigned to your user.
[[File:MS365UserLicenses.png|none|thumb|600x600px|/MS365UserLicenses.png|/MS365UserLicenses.png]]
Set your user active.
[[File:MS365ActiveUsers.png|none|thumb|600x600px|/MS365ActiveUsers.png|/MS365ActiveUsers.png]]
Locate the Mail tab of your user.
[[File:MS365UserEMail.png|none|thumb|600x600px|/MS365UserEMail.png|/MS365UserEMail.png]]
Allow authenticated SMTP.
[[File:MS365AuthenticatedSMTP.png|none|thumb|600x600px|/MS365AuthenticatedSMTP.png|/MS365AuthenticatedSMTP.png]]

=== Exchange admin center ===
Login to the Exchange admin center (https://admin.exchange.microsoft.com).
[[File:ExchangeAdminCenter.png|none|thumb|600x600px|/ExchangeAdminCenter.png|/ExchangeAdminCenter.png]]
Remove deactivation of the SMTP AUTH protocol.
[[File:ExchangeRemoveDeavtivatedOAuth2.png|none|thumb|600x600px|/ExchangeRemoveDeavtivatedOAuth2.png|/ExchangeRemoveDeavtivatedOAuth2.png]]

=== PBX Example configuration ===
With this Microsoft setup the OAuth2 configuration for the resource owner password credentials flow can be filled in as follows.
[[File:OAuth2ResourceOwnerPasswordCredentials.png|none|thumb|600x600px|/OAuth2ResourceOwnerPasswordCredentials.png|/OAuth2ResourceOwnerPasswordCredentials.png]]
For interactive authorization this is the OAuth2 configuration. Authorize e-mail access one time and send a test mail to verify everything went well.
[[File:OAuth2InteractiveAuthorization.png|none|thumb|600x600px|/OAuth2InteractiveAuthorization.png|/OAuth2InteractiveAuthorization.png]]

== Gmail ==
=== Preparations ===
Login to the Google Cloud Console (https://console.cloud.google.com), select a project, New project.
[[File:GoogleSelectProject.png|none|thumb|600x600px|/GoogleSelectProject.png|/GoogleSelectProject.png]]
Create the project.
[[File:GoogleCreateProject.png|none|thumb|600x600px|/GoogleCreateProject.png|/GoogleCreateProject.png]]
Client credentials will be created in this project.
[[File:GoogleProjectCreated.png|none|thumb|600x600px|/GoogleProjectCreated.png|/GoogleProjectCreated.png]]
From the library specify the APIs needed to access.
[[File:GoogleApisServicesFromLibrary.png|none|thumb|600x600px|/GoogleApisServicesFromLibrary.png|/GoogleApisServicesFromLibrary.png]]
These are in the Gmail API.
[[File:GoogleApisServicesApiLibrary.png|none|thumb|600x600px|/GoogleApisServicesApiLibrary.png|/GoogleApisServicesApiLibrary.png]]
Choose the Gmail API and enable it.
[[File:GoogleGmailApis.png|none|thumb|600x600px|/GoogleGmailApis.png|/GoogleGmailApis.png]]
Credentials need to be created.
[[File:GoogleGmailApiAdded.png|none|thumb|600x600px|/GoogleGmailApiAdded.png|/GoogleGmailApiAdded.png]]
Invoke the help me choose wizard.
[[File:GoogleCreateCredentialsHelpMeChoose.png|none|thumb|600x600px|/GoogleCreateCredentialsHelpMeChoose.png|/GoogleCreateCredentialsHelpMeChoose.png]]
User data access is needed.
[[File:GoogleCredentialsUserData.png|none|thumb|600x600px|/GoogleCredentialsUserData.png|/GoogleCredentialsUserData.png]]
Configure the consent screen of the interactive authorization.
[[File:GoogleOAuthConsentScreen.png|none|thumb|600x600px|/GoogleOAuthConsentScreen.png|/GoogleOAuthConsentScreen.png]]
Specify the permissions that need to be authorized by the user.
[[File:GoogleOAuthScopes.png|none|thumb|600x600px|/GoogleOAuthScopes.png|/GoogleOAuthScopes.png]]
Its mail.google.com in general.
[[File:GoogleScopeMailGoogleCom.png|none|thumb|600x600px|/GoogleScopeMailGoogleCom.png|/GoogleScopeMailGoogleCom.png]]
And its to send email on the users behalf.
[[File:GoogleScopeAuthGmailSend.png|none|thumb|600x600px|/GoogleScopeAuthGmailSend.png|/GoogleScopeAuthGmailSend.png]]
These are the scopes needed.
[[File:GoogleScopes.png|none|thumb|600x600px|/GoogleScopes.png|/GoogleScopes.png]]
Ask client credentials for Web type application.
[[File:GoogleOAuthClientID.png|none|thumb|600x600px|/GoogleOAuthClientID.png|/GoogleOAuthClientID.png]]
Tell all redirect URIs that the PBX and the apps will be using during interactive authorization.
[[File:GoogleRedirectURIs.png|none|thumb|600x600px|/GoogleRedirectURIs.png|/GoogleRedirectURIs.png]]
Download the credentials. This json file contains all information for OAuth2 configuration.
[[File:GoogleClientCredentialsDownload.png|none|thumb|600x600px|/GoogleClientCredentialsDownload.png|/GoogleClientCredentialsDownload.png]]
Customize the OAuth consent screen
[[File:GoogleOAuthConsentScreenSettings.png|none|thumb|600x600px|/GoogleOAuthConsentScreenSettings.png|/GoogleOAuthConsentScreenSettings.png]]
Start the customization wizard.
[[File:GoogleConsentScreenWizard.png|none|thumb|600x600px|/GoogleConsentScreenWizard.png|/GoogleConsentScreenWizard.png]]
Choose which users may authorize.
[[File:GoogleAudienceExternal.png|none|thumb|600x600px|/GoogleAudienceExternal.png|/GoogleAudienceExternal.png]]
Google workspace users may choose internal audience. Users not in Google workspace proceed with external.
[[File:GoogleContactInformation.png|none|thumb|600x600px|/GoogleContactInformation.png|/GoogleContactInformation.png]]
Add a test user.
[[File:GoogleTestUserAdded.png|none|thumb|600x600px|/GoogleTestUserAdded.png|/GoogleTestUserAdded.png]]

=== PBX Example configuration ===
The OAuth2 parameters can be filled in with the information from the json file downloaded above. Authorize e-mail access one time and send a test mail to verify everything went well.
[[File:OAuth2InteractiveGmail.png|none|thumb|600x600px|/OAuth2InteractiveGmail.png|/OAuth2InteractiveGmail.png]]

== Generic ==

For other e-mail providers the client secret post OAuth2 flow may be configured in a generic way. Details need to be supplied by the e-mail provider.

For the Microsoft 365 setup above it would be as follows with Token endpoint ''<nowiki>https://login.microsoftonline.com/af326a34-169c-469e-946b-1ef57925306b/oauth2/v2.0/token</nowiki>'' Authorization URL ''<nowiki>https://login.microsoftonline.com/af326a34-169c-469e-946b-1ef57925306b/oauth2/v2.0/authorize?scope=https://outlook.office.com/SMTP.Send</nowiki> offline_access'' The configuration appends ''&response_type=code&prompt=consent&login_hint=...&redirect_uri=...&client_id=...'' automatically.[[File:OAuth2ClientSecretPost.png|none|thumb|600x600px|/OAuth2ClientSecretPost.png|/OAuth2ClientSecretPost.png]]
For the Gmail example above the generic confguration would be like this with Token endpoint ''<nowiki>https://oauth2.googleapis.com/token</nowiki>'' Authorization URL ''<nowiki>https://accounts.google.com/o/oauth2/auth?access_type=offline&scope=https://mail.google.com/</nowiki>'' The configuration appends ''&response_type=code&prompt=consent&login_hint=...&redirect_uri=...&client_id=...'' automatically.
[[File:OAith2ClientSecretPostGmail.png|none|thumb|600x600px|/OAith2ClientSecretPostGmail.png|/OAith2ClientSecretPostGmail.png]]
The private key jwt OAuth2 flow can be configured generically as well.[[File:OAuth2PrivateKeyJWT.png|none|thumb|600x600px|/OAuth2PrivateKeyJWT.png|/OAuth2PrivateKeyJWT.png]]

== Related Articles ==
* [[Reference16r1:PBX/Config/Authentication]]
* [[Reference16r1:Apps/PbxManager/Email]]
* [[Reference16r1:Concept App Connect#E-Mail configuration]]
* [[Reference16r1:Concept App Service Fax#Mail Configuration (SMTP_Server)]]
* [[Reference16r1:Concept App Service Reports#Configuration]]
* [[Reference16r1:Concept App Service Users#Users Admin App (innovaphone-usersadmin)]]
* [[Reference16r1:Concept App Platform#SMTP]]

Howto16r1:Conferences, Resources and Licenses

2026-04-28T12:11:47Z

Slu:

==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_G722.png|conferences_ressources_and_licenses_-_scheme2_g722.png/|conferences_ressources_and_licenses_-_scheme2_g722.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 supports G.711a/u and G.722 coder. 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 equal 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|conferences,_ressources_and_licenses_-_pbx-channel_license_01.png/|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).

==== CPU usage ====
For a calculation of CPU usage see [[Howto:V13_Firmware_Upgrade_V13r2_V13r3#Conferences]].

===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|conferences,_ressources_and_licenses_-_example_gateway_channels_ip411.png/|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.

=== Conference Scaler ===
With 16r1 we introduce a new App "Conference Scaler", with the Conference Scaler it is possible to cluster multiple SCNF Interfaces into one registering Endpoint at a conference Object, for more please refer to [[Reference16r1:Concept App Service Conference Scaler| ''the concept article'']]

==== Ressource consideration ====
===== Conference Channels =====
If using the conference scaler and multiple interfaces you need to take into account to be sure how much conference channels are actually used, even if they are not be seen.
Let's have a look what happens for each room inside a Conference object that uses the conference scaler:

* As soon as a room has been opened on more than one interface (this will be the case when having at least 2 participants), the audio is only transmitted between the Interface and the locally connected participants
** To share audio between interfaces, the conference scaler will allocate a RTP Port on both interfaces
** This Socket will be exchanged between both interfaces, so that both interfaces know where to connect to
** Now, as both interfaces have the needed information, both interfaces will join to the other Interface as an "invisible" participant, taking up one more extra conference channel on both interfaces
* As we have learned in the concept article, the conference scaler will allocate one random interface as primary interface, this Primary interface will then be used to connect all used interfaces and mixing the audio. Let's go through this with our already existing scenario:
** Now we have two participants on two interfaces which are connected together ( and the conference scaler has already selected Interface 1 as the primary interface in the beginning of the conference call)
** Another participant joins the conference call, therefore this room will also be opened at interface 3
** As Interface 1 is the primary Interface, interface 3 will join the conference room ONLY at interface 1, taking up another conference channel as "invisible" participant (Interface 3 does not need to join interface 2 because the audio from interface 2 is already transmitted to interface 1, our primary interface)
** Interface 1 will also join interface 3 as "invisible" participant, taking up one conference channel on interface 3
* Now we have 2 Interfaces connected to interface 1 and interface 1 is connected to 2 interfaces as participant
* This is the flow for every conference room you are using at that conference object, for the next room the conference scaler might select Interface 3 as primary interface, in this case he will join both interfaces as participant and vice versa (also taking up conference channels here as well) - but only if this conference call has at least these 3 participants (as the interfaces will be used in a round robin manner)
* The primary inertface will now receive audio from both interfaces, which will be the mixed audio from both interfaces, and distributes it to the other interfaces + it's own audio mixed together 

For Room 1 it will look like this:
{| class="wikitable"
|+
!Interface 1 (Primary Interface)
!Interface 2
!Interface 3
|-
|Participant 1
|Participant 2
|Participant 3
|-
|Interface 2 ("invisbile participant")
|Interface 1 ("invisbile participant")
|Interface 1 ("invisbile participant")
|-
|Interface 3 ("invisbile participant")
|
|
|}

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

Reference16r1:PBX/Config/Authentication

2026-04-28T12:10:04Z

Slu:

[[Category:Concept_OAuth2]]
[[Category:Concept_myApps]]
The authentication for myApps and myPBX is configured on this page.

= Configuration =
== Authentication ==
* '''Two-factor authentication''' Requires users to additionally approve their logins using an existing session or by clicking a link sent via email. (myApps only)
* '''Authentication type''' (myApps and myPBX)
** '''PBX only''' Login is allowed with PBX user password only.
** '''Netlogon only''' Login is allowed with Windows password only.
** '''PBX and Netlogon''' Login is allowed with both PBX user password and Windows password.
** '''OAuth2 only''' Login is allowed with OpenID/OAuth2 only. (myApps only)
** '''PBX and OAuth2''' Login is allowed with both PBX user password and OpenId/OAuth2. (myApps only)
* '''OAuth2 provider name''' A user friendly name of the OAuth2 provider that shall be displayed on the login form, e.g. "Windows" or "Active Directory". (myApps only)
* '''OAuth2 domain''' This configuration is needed, if the OAuth2 user domain does not match the PBX domain. If a domain is configured, users of that domain will be treated like members of the PBX domain.
** Example: No domain configured. user@example.com -> user@example.com
** Example: example.com configured. user@example.com -> user

== Email verification ==
An email account that is used by the PBX for sending mails. It is used for:
* Sending verification emails for two-factor authentication.
* Emails from the voicemail object.
Configuration:
* '''SMTP server''' The IP address or DNS name of the SMTP server.
* '''Client host name''' The hostname or IP address for the EHLO message. Optional, defaulting to 127.0.0.1.
* '''Sender name''' A readable name that is used as the sender of the emails.
* '''Email address''' The email address for sending mails.
* '''Username''' The username of the email account.
* '''Password''' The password of the email account.
* '''OAuth2''' Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].
* '''Verification link''' The link that is used for accepting or rejecting sessions. Configure <code>https://PBX-IP-or-DNS-name/PBX0/session.xml</code>

* '''Test''' Here you can send a test mail using the configured account.

==Related Articles==
[[Reference16r1:Concept OAuth2 Windows Authentication]] 
[[Howto16r1:Configure_OAuth2_E-Mail]]

Reference16r1:Services/Logging

2026-04-28T12:09:46Z

Slu:

== Log Server ==
External '''logging''' is disabled by default (Off). You can still view log messages in real time (see [[Reference7:Administration/Diagnostics/Logging|Logging]]), but messages are not stored or sent to an external destination.

Available ''Type''s:

{|
|valign=top nowrap=true|'''Off:'''
| Logging is disabled.
|-
|valign=top nowrap=true|'''TCP:'''
| The device transmits the syslog entries using a TCP connection.
* In the '''Address''' field, the remote IP-address is entered.
* In the '''Port''' field, the remote port is specified.
|-
|valign=top nowrap=true|'''SYSLOG:'''
| The syslog entries are transmitted to a syslog recipient (also referred to as syslogd, syslog server or syslog daemon).
* In the '''Address''' field, the IP-address of the syslogd server is entered.
* In the '''Class''' field, the syslog message class for the syslog entries sent is entered. The class is a numeric value between 0 and 7, it will be used as ''Facility'' (0 => local0, ... 7 => local7). The ''Severity'' field will always be 6 (informational). See [http://de.wikipedia.org/wiki/Syslog wikipedia.org/wiki/Syslog] for details.
|-
|valign=top nowrap=true|'''HTTP:'''
| The syslog entries are transferred to a web server. Each individual syslog entry is transferred to the server as an individual request.
* In the '''Address''' field, the IP-address of remote server is entered.
* In the '''Path''' field, the relative URL to be used in the HTTP request is entered.
* The Method field selects the method used to send the request. There are 3 formats available:
{|
| Format || Request Type || URI || Description
|-
| Standard || POST || ''hardwired'' || This should be used to forward log messages to another innovaphone device, e.g. to store it on a central CF card
|-
| External(POST) || POST || as defined in the Path field || This is identical to the ''Standard'' method, except that you may specifiy the URI to be used
|-
| External(GET) || GET || as defined in the Path field || The log message will be coded into GET ''form data'' (a.k.a. ''query args''). This method is compatible to the method used in firmware versions 5.01 and 6.
|}
For more information on HTTP request formatting, see [[Reference7:HTTP Request Message Format]].

If the addressed Web server requires authentication, an ''Authenticated URL'' has to be configured on the [[Reference:Configuration/General/HTTP-Client|HTTP-Client]] Page. The ''URL'' constructed by the logger is shown right next to the ''Path'' field. It must be entered in exactly this format on the [[Reference:Configuration/General/HTTP-Client|HTTP-Client]] Page. The device has to be restarted after the ''Authenticated URL'' has been set.
|-
|valign=top nowrap=true|'''LOCAL:'''
| The syslog entries are saved to [[Reference:Administration/Diagnostics/CF|the local CF card]] into the '''/log''' directory, e.g. '''\\''ipaddr''\drive\CF0\log'''. Log files named '''LOG0.''n''''' are created, where '''''n''''' goes from 0 to 3. The next log file is created when either the '''Max File Size''' is reached or the '''Backup Time''' has passed. '''LOG0.0''' is the newest log file always.

To concentrate all syslog messages to a single CF card, you would use the '''HTTP Log Server Type''' in all but one boxes with '''Method''' set to '''Standard'''. '''Address''' must be set to the IP-address of the single box that has the CF card used for log message storage. '''Port''' must be set to the port configured for the [[Reference:Configuration/General/HTTP-Server|HTTP-Server]] of this box.

|-
|valign=top nowrap=true|'''LOCAL-AP:'''
|The logs are transmitted to the local Linux application platform. Logs are stored under \\AP-IP\webdav\log\ and alarms under \\AP-IP\webdav\alarm\
|-
|valign=top nowrap=true|'''REMOTE-AP:'''
|The logs are transmitted to a remote Linux application platform. Store path is the same as under LOCAL-AP.
* In the Address field, you enter the IP address of the remote Linux application platform.
* In the Port field, you specify the port to which the connection is set up.
Remark: Don't forget to enable access to \\AP-IP\ap\log.fcgi as [[Reference10:Concept_Linux_Application_Platform#Use_as_Log_or_Alarm_Server | required for use of LinAP as logserver]].
|-
|valign=top nowrap=true|'''REMOTE-AP-S:'''
|Same as REMOTE-AP, just a secure transmission is used.
|}

A second server may be configured as '''Log Server Shadow''' receiving the same records as the first server.

== Alarm and Event Handling ==
Alarm and event forwarding is configured independently from the handling of log messages.

If no '''Forward Server''' is configured in the '''Alarm and Event Forward Server''' area, alarms and events are stored locally as specified in the '''Local Alarm and Event Queues''' area below. Otherwise, alarms and events are additionally forwarded to the external server using HTTP requests. Each individual alarm or event entry is transferred to the server as an individual request. 
<code>SYSLOG</code> option is only available on Gateway devices. Phones should use HTTP to forward alarm/events to an innovaphone gateway which may forward the collected events to a syslog server.

* The '''Address''' is used to set the IP-address of an external HTTP server that will receive the forwarded alarms and events.
* The '''Port''' defines the TCP port the HTTP request is sent to.
* The '''Method''' selects the method used to send the the requests. The same methods as for the '''Log Server''' are available here. (only on gateways)

To collect all alarms and events in a single device card, you would use the '''Standard Method''' in all but one boxes. '''Address''' must be set to the IP-address of the central box. '''Port''' must be set to the port configured for the [[{{NAMESPACE}}:Configuration/General/HTTP-Server|HTTP-Server]] of this box. 
The collected alarms and events may further be forwarded to one or two SYSLOG server(s) as XML-encoded records.
This is achieved by configuring a '''Forward Server''' with '''Method''' SYSLOG, the server address under '''Address''' and the SYSLOG-Class under '''Class'''.

The '''Local Alarm and Event Queues''' area allows you to control the number of events and alarms that are kept in memory and stored in non-volatile memory during restarts.

== Alarms and Errors as Email ==
Definition of email target to send alarms and errors as email to.

* '''Sender Address''': email adress of sender
* '''Senders' Name''': alias of sender name
* '''Recipient Address''': email adress of recipient
* '''Recipients' Name''': alias of recipient name
* '''Email Server Address''': ip-adress or DNS name of smtp email server. TLS will be supported automatically, if demanded by the server.
* '''User''': user account at email server
* '''Password''': user password at email server
* '''OAuth2''': Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

== Handling of incoming Alarms/Events ==
{|
|valign=top nowrap=true|'''Authenticate:'''
| When enabled request HTTP Authentication for the incoming HTTP Alarms/Events messages. You must configure in the sender the HTTP credentials to be able to deliver the Alarms/Events.
|-
{|
== Local Alarm and Event Queues ==
{|
|valign=top nowrap=true|'''Memory Queue Entries:'''
| Maximum number of faults and alarms to hold in volatile memory (DRAM)(Default:100).
|-
|valign=top nowrap=true|'''Persistent Queue Entries:'''
| Maximum number of faults and alarms to keep in flash memory (Default:50).
|-
{|

== Catch trace on Event ==

Event codes (up to 4 different) may be configured, on which the tracing is stopped. The event codes can be copied from actual events displayed on Maintenance/Events. Hexadecimal values was converted and stored as Decimal values.

After the event has happend the trace was stopped, the trace can be read which hopefully contains what caused the event.

You can restart the logfile by emptying the [[{{NAMESPACE}}:Maintenance/Diagnostics/Tracing |buffer]].

Reference16r1:Concept IP270

2026-04-28T12:07:03Z

Slu: Blanked the page

Howto16r1:Firmware Upgrade V15r1 V16r1

2026-04-28T12:06:40Z

Slu:

== Applies To ==
This information applies to:

* All 16r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 16r1, see [[Howto:Firmware Upgrade]]
== Licenses ==
In case of cloud or rental model, don't worry about licenses.

If the system is licensed on premise, you'll need to regenerate the license file for v16 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. Create backups before you start and store them on an external location

=== AP Upgrade to Image 140037 or newer ===
* First, upgrade your application platform to at least image version 140037. After that you can go ahead.

=== Upgrade Sequence ===
In systems of multiple units, it is important to update the tree from top to bottom. In other words, update the master unit first, and then the machines at the lower levels. If you're using a DevicesApp update job that updates the entire system at once, you don't need to do anything here.

=== TechAssist Upgrade Helper ===
* Before you start, make sure that all TechAssist tests (you will receive the required tests in the last update in the previous major version) labelled <code>Pre Upgrade: xy</code> are positive, if available
* When you are finished, make sure that all TechAssist tests (you will receive new tests with the upgrade) are positive

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a upgrade, as the change will be visible/audible in the behaviour of the application/device.

* ''Nothing''

== Manual steps needed after upgrade ==
If the installer is not used for a new installation, some new default settings are not set. Please evaluate per app whether you want to configure the new default settings manually.

=== Connector for Microsoft 365 ===
If you plan to use the new '''Contact Search''' feature of the Connector for Microsoft 365, you need to perform two manual Steps:
# Create the '''microsoft365-api''' app object by using the Settings template
# Assign the '''microsoft365-api''' app object to every user who should be able to use the new Contact Search feature. (Of cause, you can use a template for that)
 
For a more detailed guide, please refer to the how-to article: [[Howto16r1:Configure Contact Search by Connector for Microsoft365#Creating the PBX app object using the PBX Manager Plugin]]

=== Remote Control ===
In order to use the Admin Configuration Panel of the Settings App – AP Remote Control, it is necessary to grant access to the '''admin''' API, available in the App tab of the Remote Control App object.

=== Working ===
For badge counts to work, the Working Manager app object must have '''Websocket''' and '''PbxSignal''' enabled.
For the Connect integration of the Working app, '''Websocket''', '''Services''' and '''connect'''(in the Apps tab) must be enabled in the Working User app.

=== Switchboard ===
For the Connect Integration (Call Notes) to work, the Switchboard App must have the '''Services''' (App-tab) and '''connect''' or '''messages''' (Apps-tab) enabled (the name depends when the PBX was installed).

=== Projects ===
* Projects requires '''App platform version 140029''' or higher, so updating the App Platform before Projects is recommended. The Store will prohibit the update if the App Plattform does not have the minimum required version.
* For some extra admin-functionalities the '''Projects App Object needs to have an admin mode''' (App-tab). Easiest way to set this new mode is to the open the Projects App via the Projects Plugin Settings App and to re-apply it (click the OK-button). The same plugin can also be used to distribute this mode via the Config Templates.
* The '''App Platform requires the correct Time and a Timezone''' set under AP Manager/Settings/General. This is needed for some automatic cleanup of deleted items and automatic task status updates (done around 00:00h on the due date).

=== For legacy support only: Change TLS Profile ===
The ''Normal'' profile has been updated to allow only TLS 1.3 and TLS 1.2. This setting is compatible with all supported firmware versions. So you don't need to do any changes.
However if you need older TLS versions for compatibility with legacy devices, consider changing the TLS profile to ''Legacy''. In that case please see [[Reference16r1:IP4/General/TLS]] for details.

== New Apps ==
New Apps will not be installed automatically by the upgrade. The installation description of new apps is usually in the concept article. Please rate per app whether you want to install/use the new app and configure it manually.

; App Charts: [[Reference16r1:Concept_App_Charts]]
; App Polls: [[Reference16r1:Concept App Polls]]
; App MQTT Broker: [[Reference16r1:Concept_App_MQTT_Broker]]
; App Conference Scaler: [[Reference16r1:Concept Conference Scaler App]]
; App Service Conference Transcriptions: [[Reference16r1:Concept_App_Service_Conference_Transcriptions]]
; App Service Transcriptions: [[Reference16r1:Concept_App_Service_Transcriptions]]
; App Service Documents: [[Reference16r1:Concept_App_Service_Documents]]
; App Service Connector for Whatsapp: [[Reference16r1:Concept_App_Service_Connector_for_Whatsapp]]
; App Service IP: [[Reference16r1:Concept App Service IP]]

== New environment for App Platform ==
The new [[Reference16r1:Concept_innovaphone_App_Platform_Container|App Platform Container]] provides an Docker container. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Removed ==
The following software is no longer included.

* IP110A (can still be used with 15r1 firmware on current PBX versions)
* IP240A (can still be used with 15r1 firmware on current PBX versions)
* CA on CF card feature

== Deprecated ==
The following software is based on legacy technology, with no further development and limited maintenance and support.

* ''Nothing''

== Previously deprecated and now no longer supported ==
The following software is based on legacy technology, with no further development and no more maintenance and support.

* ''Nothing''

==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto15r1:Firmware_Upgrade_V14r2_V15r1]]
[[Category:Howto|{{PAGENAME}}]]

Reference16r1:Concept App Service Projects

2026-04-28T12:05:41Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept App Service Projects]]

= Overview =
The App Service Projects provides useful functionality to manage projects. It is built-on an hierarchical structure of areas, projects, backlog, sprints and tasks.
Projects uses the Connect Api to post messages automatically at specified events, e.g. task status updates, and integrates the Connect App window to allow user posts.

== New V16r1 features ==

= General Information =
== Projects items ==
Projects items consist of description, status and responsible person like project owner, sprint manager or task handler.

=== Areas ===
The highest level items on the hierarchical structure of projects. E.g. to combine all projects of a department.
 User access rights to the whole area including all lower level items are defined during area definition. Three access levels are provided: public, user group specific or private areas.
 User groups are defined in the PBX. Protected areas and all their lower level items are invisible for unauthorized users.
 Areas may be defined as zones in Connect.

=== Projects ===
A project consists of its description, status, the owner information and the area it belongs too. Projects may be filtered on area, project owner and/or attribute.
Projects typically contain several sprints and backlog entries.
Project tiles provides information about their sprints, backlog entries and tasks and a progress bar estimated on the story points of closed tasks / the story points of all tasks.

=== Backlog ===
Container for any tasks and ideas to a project which are not in work yet. Backlog entries may be filtered on area, project, backlog entry handler and/or attribute.

=== Sprints ===

Sprints specify closed units of work which are subdivided typically in several tasks.
Sprint tiles provides information about their tasks and a progress bar estimated on the story points of closed tasks / the story points of all tasks.
A sprint consists of its description, status, the manager information and the project it belongs too. Sprints may be filtered on area, project, sprint manager and/or attribute.

=== Tasks ===

Tasks are small units of work which are mostly handled by one person.
A task consists of its description, status, the handler information and the sprint it belongs too. Tasks may be filtered on area, project, sprint, task handler and/or attribute.

== Other items and Projects users ==

=== Attributes ===
Attributes are free defined, area independent flags. They may be assigned to all item types except areas. Attributes may be used as filter criteria.

=== Templates ===
To define sprint and task templates for specific workflows.

=== Projects users ===
Users are added automatically to projects as soon as they are logged in the first time. Only registered users can be assigned to Projects items.

== Projects App UI concepts ==
The App Projects UI is subdivided into tabs that provide a structure that helps to organize projects, reflecting the Project Items: '''[[#Areas|Areas]]''', '''[[#Projects|Projects]]''', '''[[#Sprints|Sprints]] / [[#Backlog|Backlog]]''' and '''[[#Tasks|Tasks]]'''.

Other extra tabs provide additional functionalities: '''[[#Attributes|Attributes]]''', '''[[#Templates|Templates]]''' and '''[[#Users|Users]]'''.

The '''Home'''-tab gives a quick and useful overview of all Current tasks and pinned Users/Areas/Projects and Sprints.

Projects, Sprints and Tabs each consist of a board organising the '''Backlog''' or '''Planned''', '''Current''' and '''Closed''' items.

=== Filters ===
When selecting an item, it works as filter on lower level items. E.g. if an area is selected, only projects of that area are provided. All active filter definitions are shown in the corresponding tabs and may be removed there.

=== Item search ===
Item title / ID search is provided for projects, sprints, backlog entries and tasks in the corresponding tabs. The item search does not consider user filters.

== Synchronisation ==
Updates on Projects items are synchronized immediately.

== Using Projects App in combination with Connect App ==
When using Projects combined with Connect App new items defined in Projects or updates on items e.g. status changes are posted to Connect App. 
The Zone has to be defined in Projects area definition and is used in all lower level items of the area. 
Users are notified about item assignments and will be able to add comments / own posts on items. 
[[#Project cannot see the Connect-discussion|Checks when having issues]]

= Requirements =
* Connect App
* The Application Platform must be at least '''version 140029''' '''[new in V16r1]'''
* The Application Platform must have the '''correct time''' and a '''Timezone''' set '''[new in V16r1]'''
* License “App(innovaphone-projects)xx” (order no. 02-00050-014). '''Free version available'''.

= License =
* This is a user licence. This licence is debited if the function is configured on a user in the PBX - regardless of use.
* The Projects app licence version must be greater than or equal to the PBX software version and app software version in use (see: Licence version).
* The private area is available for every user and can also be used without a licence (free version).
* The Connect app (installation without licences) is required to use all the functions of Projects.
* Only a user licence is required for the Projects app. Further licences such as the port licence are not required!

== Free version ==
An unlicensed user can also use Projects, but is restricted to their own area and can only use Projects to manage their own tasks. 
However, an unlicensed user cannot see any cross-departmental areas, projects, sprints or tasks.

= Configuration =
== Settings App/App Installer ==
# Install the Projects App on the App Platform via the 'Settings App/App Installer'-plugin:
#* Open the Settings App
#* Open the app installer plugin
#* Read and accept the Terms and Conditions of the App Installer (if not done yet)
#* Search ''projects''
#* Select the Projects-App
#* Select the correct version and click Install
#* Read and accept the Terms and Conditions of the Projects App and click Install
# Add an App-Object via the Projects-plugin of the Settings App:
#* Close and Re-Open the Settings App
#* Open the Projects-plugin
#* Click on Add an app; Select 'Projects' and complete the form:
#** Name: ''Projects''
#** SIP: ''projects''
#** Connect App: select the correct Connect-App (default ''connect'')
#** Connect Admin App: should be updated automatically to the previous Connect App appended with ~admin-service (default ''connect~admin-service''). If nothing can be selected, see: [[#Projects-plugin_cannot_see_the_Connect_Admin_Service|Troubleshooting]].
#** (Optional) Assign the Projects-App to an existing Template
# Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s)
# Assign 'App(innovaphone-project)xx'-licenses to the authorized users (or try the free version)

== AP Manager/App Store ==
Installing the Project App via the 'Settings App/App Installer'-plugin is the preferred/easier method, but a complete manual install is also possible.
# Install the Projects App on the App Platform via the App Store:
#* Open the AP Manager
#* Open the App Store
#* Read and accept the Terms and Conditions of the App Installer (if not done yet)
#* Search ''projects''
#* Select the Projects-App
#* Select the correct version and click Install
#* Read and accept the Terms and Conditions of the Projects App and click Install
# Add an instance of the Projects App on the App Platform:
#* Close the App Store
#* Open the newly installed Projects App
#* Click on '+ Add' to add a new Projects Instances and complete the form:
#** Name: ''projects''
#** Domain: {System Name} (found under PBX/Config/General)
#** Password: {strong password}
#** Database password: {strong password}
# Select and Start the instance
# Create a PBX-object:
#* Via the Settings App Plugin (see above)
#* Via the PBX Advanced UI (see below for settings)
# Assign the Projects App to authorized users using a Config Template and/or directly on the User Object(s)
# Assign 'App(innovaphone-project)'-licenses to the authorized users (or try the free version)

== Apps ==
Only one well-configured PBX App Object needed is needed for the Projects-App. 
This App Object is best created/adjusted via that projects-plugin of the Settings App.

Parameters of the PBX App object:
<pre>URL: https://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-projects</pre>

=== "App"-tab ===
;Modes: admin ''(to allow an extra Admin-mode)'' '''[new in V16r1]'''
;WebSocket: needed ''(to allow Connect-postings)''
;Services: needed ''(to allow Connect-postings)''

=== "Apps"-tab ===
;connect: ticked ''(to allow Projects to maintain Projects zones in Connect)''
;connect~admin-service: ''ticked (to allow Projects to maintain Projects zones in Connect)''

= Upgrade =
===Prerequisites ===
The App Platform must have at least version 140029. So make sure the AP has been upgraded before trying to upgrade Projects, otherwise an upgrade of Projects will not be possible.==

=== Upgrade ===
An upgrade of the Projects App can be done via an '''Update via the App Store''' or via an '''Update Job of the Devices App'''.

=== Manual adjustments ===
* Add the admin-mode to the Projects App Object. This can be done manual via the Advanced UI of the PBX or easier via the Projects Plugin of the Settings App (open the Projects App Object + click OK).
* Add (if necesseary) a correct Timezone to the Application Platform. This can be done via the AP Manager (Settings/General/Timezone).

= Troubleshooting =
== Projects-plugin cannot see the Connect Admin Service ==
* Check that the Connect App has an ''''admin-service''''-mode configured (modes-field can be found in the 'App'-tab of the object). See: https://wiki.innovaphone.com/index.php?title=Howto15r1:Firmware_Upgrade_V14r2_V15r1#Connect

== Project cannot see the Connect-discussion ==
Both the Project App and the User using the Project App must be checked for the necessary settings:

'''Project''' App object:
* Check that the Project App has ''''WebSocket'''' and ''''Services'''' ticked ('App'-tab).
* Check that the Project App has ''''connect'''' and ''''connect~admin-service'''' ticked ('Apps'-tab)
* Open the Project App/Areas + edit an Area. Check the 'Connect zone setup state':
** Green: connection OK
** Orange: connection not yet established
** Red: connection NOK

'''User''' Object using the Project App:
* Check if the User using Projects has ''''connect'''' ticked in the 'Apps'-tab (best deployed via a global Template; e.g. the default 'Config User').

== Area Not Connected (Orange/Red) ==
Check the previous Troubleshoot-item (''Project cannot see the Connect-discussion'') and edit the Area (via the Pencil-icon).
 
By editing the area the connection establishment will be restarted.

== Projects cannot be upgraded ==
The V16r1-version of Projects requires an '''App Platform of at least version 140029'''. 
See: [[Howto16r1:Firmware_Upgrade_V15r1_V16r1#AP_Upgrade_to_Image_140029_or_newer|'Upgrade to Image 140029 or newer']] or [[Howto16r1:Firmware_Upgrade_V15r1_V16r1#Projects|'Manual Steps needed after upgarde -> Projects']].

== Extra Admin Features are not available ==
Check if the Project App Object in the PBX does have an '''"admin"-mode''' and that the user does have the '''"projects~admin"-app''' selected.

== Auto Cleanup or automatic Task Status Updates do not work ==
Check the settings of the '''App Platform''' (AP Manager/Settings/General); the '''correct time''' together with a '''Timezone''' must be available.

= Related Articles =
* [[Reference15r1:Apps/PbxManager/App Projects]]
* [[Reference15r1:Concept App Connect]]

Reference16r1:Concept App Service Conference Invitation Management

2026-04-28T12:05:00Z

Slu:

[[Category:Concept|Apps]]

== Applies To ==

== Overview ==

== Features ==

== Requirements ==

== Apps ==

== Licensing ==

== Technical Overview ==

== Technical Concept ==

==== Additional Information ====

== Configuration ==

==== PBX Manager Plugin ====

== Troubleshooting ==

== Known Issues ==

== Related Articles ==

Reference16r1:Concept App Remote Control

2026-04-28T12:04:53Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]

== Applies to ==
* innovaphone PBX from version 16r1
== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 130015)
* V16r1
* Windows 10 and up
* Windows Server 2016 and later versions
* myApps launcher for Windows.
* Remote Control Client (portable .EXE) for external participants or Remote Control Client (installable .MSI) '''Note : in v16r1 the Remote Control Client is only available for Windows'''
* Additionally it is possible to join a session also via myApps opened in a web Browser

== Overview ==
Remote Control is an application to access a remote PC.
 The application can be used by the IT department to provide remote support or it could also be used as a collaborative tool for remote work.

== Licensing ==
* For the [[Reference16r1:Concept_App_Remote_Control#Features|licensed features]] you will need to order the '''Service(innovaphone-remotecontrol)''' license, order number : ''02-00050-015''
* '''The application includes one session by default'''

== Installation ==
=== For new v16r1 installation ===
The Remote Control App is automatically installed by the installer and will be deployed in the '''Config User''' template. The service ID is activated and the address pre-configured
=== With the Settings App - AP app installer plug-in ===
[[File:Ap_app_installer.png]]

Go to the Settings App and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"remote control"''' and click on it
* Select the proper firmware version, here '''"v16"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the install yellow button
* Wait until the install has been finished
* Close and open the Settings App to refresh the list of the available coloured AP plugin
* Click on the '''"AP remotecontrol"''' and click on '''" + Add an App"'''
* The '''"Name"''' display name field ''(all characters allowed)'' and the '''"SIP"''' administration field ''(no spaces, no capital letters)'' need to be filled. You can enter for example ''Remote Control/remotecontrol'' .
* Tick the appropriate template to distribute the App
* Enter the amount of purchased licenses
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good
* Additionally you can enter the users that are allowed to start a remote session in the '''"configuration"''' menu of the plug-in, enter name comma separated and allow the usage of IDs with the Remote Control Client (external application available in our store)

== Apps ==
=== Remote Control (remotecontrol) ===
This is the standard App within myApps for Remote Control.
Parameters of the App object:
;Websocket: Connection between the PBX and the App Platform. the App Platform receives the number of licences via this connection.
;PbxSignal: Protocol to register to the PBX and do signalling with the JSON signalling protocol (necessary to retrieve the TURN server data from the PBX)
;Admin: Used for the administration configuration available in the AP remotecontrol plugin
;PbxApi: App notification and presence monitoring of in-app user list

== Concept ==
[[Image: Rcrounded.png]]

A user (viewer) sends a request to another user (sharer) to access the sharer's PC.
 The sharer accepts the session and begins to share their desktop with the viewer.
 The viewer is also automatically given control of the mouse and keyboard.

=== Features ===
Here are the features available in the Remote Control App
==== Included features ====
* One session between Remote control App opened within myApps
* Start a session with myApps started in a browser (no control possible of the PC that have myApps opened in a web browser)
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
''Note: if the viewer use myApps Remote Control App in a browser, the direction of control will not work since the browser has no interaction with the local operating system''
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support in both directions
* Support for same keyboard layouts (e.g. QWERTY to QWERTY).
* Multi-viewer support: several viewer can join a sharer session

==== Licensed features ====
* Support of external participants via the [[Reference16r1:Concept_App_Remote_Control#The_Remote_Control_Client|Remote Control Client]]
* Administration configuration (available in the Settings App - AP remotecontrol plugin) such as : users that can start a session, usage of IDs code.
* Launch the Remote Control App and start a session with an URL.
* Share a session from the Remote Control App opened in myApps
* Multiple sessions: If you need more than one session (e.g. many viewers for one sharer, more than one parallel session)

=== Technical overview ===
[[Image:Remote-control_technical-overview.png]]
 ''Note: SCTP packets are routed through the TURN server and therefore the transmission is not peer-to-peer if the TURN server is selected from the ICE candidate.''

=== Technical data ===
*The maximum bitrate can reach '''8 Mbps''' if there is no packet loss. In case of packet loss, the bitrate is reduced, with a minimum of '''1 Mbps''' for the user who is sharing their desktop UI(sharer). The viewer only sends mouse and keyboard events.
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature
*The Remote Control Client uses the same port range.
*In order to communicate with the Central ID Service, port '''443''' is used. The Remote Control client and the myApps Remote Control app must be able to communicate externally via port 443.

=== Central ID service server ===
innovaphone provides a centrally hosted ID service that simplifies the establishment of sessions between the myApps Remote Control App and the Remote Control Client but also between myApps Remote Control Apps. The service is pre-configured in the Settings App, under the AP remotecontrol configuration menu, with the address '''remotecontrol.innovaphone.com'''.
It is possible to enable or disable this feature.

In few steps it is explained how does the flow works:
#The myApps Remote Control App or the Remote Control Client automatically generates an ID ''(ID is user based)''
#The sharer sends the ID to the viewer or the viewer send its ID to the sharer
#The viewer enters the ID into their myApps Remote Control App or the sharer enter the code in the Remote Control Client
#The viewer’s myApps Remote Control App or the sharer's Remote Control Client communicates with the ID service to transmit a session hash link
#The ID service forwards the session hash link to the sharer/viewer in order to establish the session
#The sharer receives a connection request notification that must be accepted
#Once the session request is accepted, the viewer can access the sharer’s PC
''Note: For the Remote Control Client, it is possible to enable auto-connect to bypass manual acceptance of the session, see the notes in the [[Reference16r1:Concept_App_Remote_Control#The_Remote_Control_Client| General information]] section of the respective clients'' 
''Note: For the Remote Control Client, the STUN/TURN server information stored in your Remote Control App service (running in your App Platform) is also transmitted within the hashlink.''

== The Remote Control Client ==
=== Portable version ===
==== General information====
The portable Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. E.g. external participants such as your customers. External participants share their screen to the the myApps users. In order to use IDs to start a session, the Remote Control Client and the myApps Remote Control App has a default connection to the central ID service hosted by innovaphone.
* Compatible with Windows only
* Users are notified via an in-app notification when a new version is available. The new version is downloaded from the client and need to be started afterwards
* No installation needed, simple light .exe file that can be started without admin right
* You can download the Remote Control Windows .EXE file by a given link from the person that want to take the control from his myApps client or directly in our [https://store.innovaphone.com/beta/download.htm store] under the section software, item name is '''Remote Control Windows Portable'''
#Open the shared session link in a web browser to download the ''remoteControl.exe''
#Launch the app and enter your name (and any additional information, if desired)
#Provide the code to the viewer
#Accept the Remote session
''Note: Optionally enable or disable the admin session and auto-connect features, works with ID code only'' 
''Note: If you have entered the provided link or a code in the "Link or ID" field, click on "Join Session"'' 
'''Important:''' For the automatic connection, you will need to enter one or several codes separated by commas. This allows the Remote Control Client to be accessed automatically from different viewers, in that case, you will need to request one or several codes from the viewer and you do not need to click on the "Join Session" button.

==== Parameters available in the UI ====
;Your ID: ''Can be copied and given to the person that want to start a session with the portable client''
;Display Name: ''You can enter a name that will be used to notify the myApps Remote Control App''
;Additional information: ''Such as company name''
;Link or ID: ''If you start a session via link or a code, link or code is provided by the viewer that want to take the control''
;Join session: ''To establish a remote session when the link/ID code is previously entered''
;Admin Session on/off: ''Allow to start a session without having the administration right from the Windows user''
;Autoconnect on/off: ''Allow to start a session without being accepted by the Windows user, works only with ID codes''
''Note: When you activate auto connect, a new field is displayed. There, you can enter the codes used for the auto-connect feature. Multiple codes can be entered, separated by commas.''

=== Installable version ===
==== General information====
The installable Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. E.g. external participants such as your customers. External participants share their screen to the the myApps users. In order to use IDs to start a session, the Remote Control Client and the myApps Remote Control App has a default connection to the central ID service hosted by innovaphone.
*Compatible with Windows only
*Pop-up notification when a new version is available
*Silent update installation
*Auto start
*Fast installation (require the admin right), you can download the Remote Control Windows .MSI file in our [https://store.innovaphone.com/beta/download.htm store] under the section software, item name is '''Remote Control Windows'''
#Get the version of ''remoteControlSetup.msi'' on our store and install it
#Launch the app and enter your name (and any additional information, if desired)
#Provide the code to the viewer
#Accept the Remote session

==== Parameters available in the UI ====
;Your ID: ''Can be copied and given to the person that want to start a session with the installed client''
;Display Name: ''You can enter a name that will be used to notify the myApps Remote Control App''
;Additional information: ''Such as company name''
;Link or ID: ''If you start a session via link or a code, link or code is provided by the viewer that want to take the control''
;Autoconnect on/off: ''Allow to start a session without being accepted by the Windows user, works only with ID codes''
''Note: When you activate it, a new field is displayed. There, you can enter the codes used for the auto-connect feature. Multiple codes can be entered, separated by commas.''
;Join session: ''To establish a remote session when the link/ID code is previously entered''

==== Parameters available in the tray icon menu ====
When you do a right click on the tray icon it offers you the following possibilities
;Open trace folder: ''Fast access to the folder where the debug files are stored''
;Show in task bar: ''Pin the application to your Windows taskbar''
;Autostart: ''The application starts when you log in''
;Exit Remote Control: ''Close the application''

== Use Case scenario==
The table below presents the different options for starting a session, depending on the environment. it indicates also if a licence is required or not
 ''Description'':
*myApps launcher: Remote Control App used within the myApps launcher for Windows
*myApps browser: Remote Control App used within myApps running in a web browser
''Note: myApps can be used within the Microsoft Teams client and is therefore considered as a myApps browser''
*Remote Control Client: Windows portable or installable client that does not require myApps launcher to be running

{| class="wikitable"
|-
! Viewer !! Sharer !! License needed
|-
| myApps launcher || Remote Control client || yes
|-
| myApps browser || Remote Control client|| yes
|-
| myApps browser|| myApps launcher|| not for the 1st session
|-
| myApps launcher|| myApps launcher || not for the 1st session
|-
|}

== Troubleshooting ==
When you open a support ticket, you will be asked to provide us with debugging data of your issue. You can also send us screenshots/videos of the behaviour you are reporting. Do not forget to send us also the PBX default configuration file.

=== Trace flags of the App instance on the App Platform ===
Select the corresponding App instance of the Remote Control App service and click on the '''Diagnostics button'''. Tick the following trace flags:
*App
*Database

=== Trace flags of the myAPPS Client ===
Go to the myApps '''Burger menu''', click on '''more''', and then click the '''magnifying glass'''. Tick the following trace flag:
*AppSharing

=== Trace of the myAPPS opened in a browser ===
Open the dev console ''(F12)'' and get the generated logs, you can copy them in a txt file

=== Trace of the Remote Control Windows Client (portable) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the chromium log file, chromium + remoteControl txt files and zip them before sending to our support.

=== Trace of the Remote Control Windows Client (installable) ===
Do a right click on the app tray icon and click on open trace folder, get the chromium log file, chromium + remoteControl txt files and zip them before sending to our support.

== Known issues ==
*Push notifications on sharer's smartphone : if a viewer wants to start a remote session with a sharer who does not have the Remote Control App open on their PC, a push notification is triggered on the sharer's myApps mobile phone (if installed).

== Known limitations ==
*The language of the Remote Control Windows client is based on your operating system's language.
*Keyboards with different layouts are not supported yet (e.g. QWERTZ to QWERTY).

==Related Articles==
* [[{{NAMESPACE}}:Apps/PbxManager/App RemoteControl]]
[[Category:Apps/PbxManager/App RemoteControl]]
*[[Howto:Innovaphones_public_services#Remote_Control_Central_ID_service]]

Reference16r1:Concept App Polls

2026-04-28T12:04:45Z

Slu:

[[Category:Concept|Apps]]


== Applies to ==
* Polls App

== Requirements ==
* innovaphone PBX
* innovaphone Application Platform
* v16r1
* com.innovaphone.includes consumer / '''Connect'''

''As polls does not provide a standalone app, an app in which the poll is displayed is required (e.g. Connect).''

== Overviews ==
The Polls App provides polling functionality, which can be implemented by an app via the "Include API". Currently only connect implements "Includes", where they can be attached to any form of connect post.

== Licensing ==
Polls has a free license, as it is regarded as a base connect feature.

== Features ==
* Create Polls
** Multiple Choice
** Single Choice
** Anonymous Voting
** Poll Expiry-Date
* Viewing Polls
** Voting
** Change Vote
** See current standing
** Seeing who voted for what
** Live Updates

== Installation ==
=== With the Settings AP app installer plug-in ===

Go to the PBX manager/Settings and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint: if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"Polls"''' and click it
* Select the proper firmware version, here '''"v16"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the yellow install button
* Wait until the install has been finished
* Close and open the PBX Manager/Settings to refresh the list of the available colored AP plugin
* Click on the '''"AP Polls"''' and click on '''" + Add an App"'''
* The '''"Name"''' display name field ''(all characters allowed)'' and the '''"SIP"''' administration field ''(no spaces, no capital letters)'' are prefilled, you can leave them as they are.
* Tick the appropriate template to distribute the App
* Click OK to save the settings and a green checkmark will be shown to inform you that the configuration is good

== Usage ==
As polls has no standalone app the usage can be a bit unintuitiv. In general an app, that consumes the '''com.innovaphone.includes''' API, is needed. As the implementation could vary, how the users interacts with the App could as well. But, as Polls was implement for the '''Connect App''', below is a description on how a user would interact (create/vote) with the Polls App.

=== Creation ===

# The User Opens Connect and clicks on "Create a new post"
# The User Selects the "Include Icon" (3 squares and a plus)
# The Create UI pops-up (Anatomy explained in the User Interface section)
# Upon sending/creating the connect post the poll is created aswell (given the poll is valid)

=== Viewing ===

# The User opens a post, containing a poll include
# The poll loads in
# User can interact with the poll as long as the connect post is open

== User Interface ==

=== Create ===
[[File:Create Poll.png|thumb|300x300px|UI when creating a poll]]
The UI for creating a poll has two sections.
# Options, which can later be voted on
# Toggles, which change how the poll behaves

Inputs for options will appear and disappear, as needed. Meaning, if every field would be full, a new field will appear. If more than 1 field would be empty, an empty field will be removed.

Toggles are ''null'' or ''value'' fields. Meaning empty fields are equal to ''unchecked'' (toggle is considered off).

=== View ===
[[File:View options.png|thumb|249x249px|UI when viewing a poll]]
[[File:View results.png|thumb|384x384px|UI when viewing the results of a poll]]
The UI for viewing a poll, which is the one used to actually vote, is divided into two views.
# Options, which can be voted for
# Results for the corresponding options

Both options and results display
* Option title
* Current votes/percentage
* Winner (poll expiration date)

The options further display
* Multiple (square) or Single (circle) Choice
* What the viewer voted by
** checked input
** higlighted outline
* Up to the last 5 voters per option (non anonymous)

The results further display
* All the voters (non anonymous)

== Libraries used ==

== Troubleshooting ==
When you open a support ticket, you will be asked to provide us with debugging data of your issue. You can also send us screenshots/videos of the behaviour you are reporting. Do not forget to send us also the PBX default configuration file.
=== Trace flags of the myAPPS Client ===
Go to the myApps '''Burger menu''', click on '''more''', and then click the '''magnifying glass'''. Tick the following trace flag:
*Browser console
*App
''Hint: If you are using myApps in a browser, press F12 to open the browser console.''

== Restrictions / Known issues ==

== Related Articles ==
https://wiki.innovaphone.com/index.php?title=Reference16r1:Concept_App_Connect

Reference16r1:Concept App MQTT Broker

2026-04-28T12:04:38Z

Slu:

== Applies To ==
<ul><li>innovaphone System (PBX/AP) from version 16r1 upwards</li>
</li></ul>

== Requirements ==
<ul><li> innovaphone PBX
</li><li> innovaphone AppPlatform
</li><li> innovaphone myApps
</li><li> MQTT-capable client devices or applications
</li></ul>

== Licensing ==
This product requires no licensing.

== Concept ==
The MQTT Broker app provides a standards-compliant MQTT-message-broker running as an App Service on the innovaphone App Platform. It allows MQTT-clients such as IoT devices, sensors, or custom applications to exchange messages using the publish/subscribe pattern. Supported MQTT versions include 3.1.1 and 5.0.

== How it works ==
MQTT clients connect to the broker using the standard MQTT protocol over TCP (port 1883) or encrypted via TLS (port 8883). Clients can publish messages to topics and subscribe to topics to receive messages from other clients. The broker routes published messages to all subscribers of the respective topic.

Authentication is handled via username and password credentials configured in the broker settings. Access control lists (ACLs) can be used to restrict which clients are allowed to publish or subscribe to specific topics.

The broker supports persistent sessions and retained messages. Quality of Service (QoS) levels 0, 1, and 2 are supported, allowing clients to choose between fire-and-forget, at-least-once, and exactly-once message delivery semantics.

Connection to third-party MQTT-brokers is also supported via the Bridge functionality, which allows the innovaphone broker to connect as a client.


== Apps ==
=== App (innovaphone-mqtt) ===
[[File:Innovaphone-mqtt-logo.png]]

The app provides the following configuration and monitoring capabilities:

==== Overview ====
Real-time monitoring of incoming messages and currently connected MQTT clients.

[[File:MQTT_Overview_Section.png|512px]]

==== Security ====
Authentication via JWT or username/password can be configured. Specific MQTT clients and topics can be restricted or granted access via Access Control List (ACL).

[[File:MQTT_Security_Section.png|512px]]

==== Configuration ====
The protocol and port used for MQTT packet transport can be configured here. To connect to an external MQTT broker (innovaphone or 3rd-party), the required connection details can be entered via ''Add Bridge''.

[[File:MQTT_Configuration_Section.png|512px]]

== Install ==
* Install the MQTT Broker via the ''App Installer'' Settings plugin.
* Create a new PBX Object for the MQTT Broker with the Settings Plugin of the MQTT Broker app.
** Configure a name and SIPid.

== Set up ==
After the initial installation, the broker listens to AppPlatform-IP:1883
If any changes are needed, they should be done in the Configuration and Security sections of the app.

== Troubleshooting ==
If problems occur, please send a log of the app service. Before reproducing the issue, delete the current contents of the log. The following trace flags should be enabled:

<ul><li>App
</li><li>TCP/TLS
</li><li>DB
</li></ul>

== Known issues ==

== Related Articles ==

Reference16r1:Concept App Charts

2026-04-28T12:04:25Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept App Charts]]


== Applies to ==
* Charts App

== Requirements ==
* innovaphone PBX
* innovaphone Application Platform 1300xx
* v16r1

== Overview ==
The Charts App allows the centralised display of decentralised data — that is, data provided through the Statistics API and implemented by other apps. In other words, if another application has implemented the Statistics API, it can use this API to make some of its locally stored data available to the Charts App. The Charts App can then request and display that data. 
The availability of data in the Charts App is determined by how other App services integrate with and use the API to share their data. 
''e.g : Connect App can return / create data from its database (like amount of posts, sql queries, etc)''

== Licensing ==
Currently no license is required to use the Charts App. But this is subject to change.

== Features ==
* Display data in graph form
** Using different graph types
** Using different time spans
** Using different granularity
** Real time graph
* Save displayed graphs as collections
** For quick access in the future
** Sharing with other users

== Installation ==
=== With the Settings AP app installer plug-in ===
[[File:Ap_app_installer.png]]

Go to the Settings App and open the '''"AP app installer"''' plugin. On the right panel, the App Store will be shown. ''Hint : if you access it for the first time, you will need to accept the "Terms of Use of the innovaphone App Store"''
* In the search field located on the top right corner of the store, search for '''"charts"''' and click on it
* Select the proper firmware version, here '''"v16"''' and click on install
* Tick "I accept the terms of use" and continue by clicking on the install yellow button
* Wait until the install has been finished
* Close and open the Settings App to refresh the list of the available coloured AP plugin
* Click on the '''"AP Charts"''' and click on '''" + Add an App"'''
* The '''"Name"''' display name field ''(all characters allowed)'' and the '''"SIP"''' administration field ''(no spaces, no capital letters)'' need to be filled. You can enter for example Charts/charts.
* Tick the appropriate template to distribute the App
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

==Apps==
=== Charts (charts) ===
This is the standard App within myApps for Charts App.
Parameters of the App object:
;Websocket: Connection between the PBX and the App Platform.

== User Interface ==
The UI is divided into 3 main parts, which in part are divided into smaller parts:
*Charts Area: Main component displaying the data in chart form.
*Sidebar Area: Used to select the data to be displayed.
*Top Area: Toggles certain display functions.
[[File:ChartsUI.png|thumb|Charts interface]]
=== Charts Area ===
Here the charts are displayed. The user can hover over data points see the plain number being displayed. Furthermore, when enabled, the component can be scrolled
if the displayed timespan is long enough.
=== Sidebar ===
The Sidebar has two "modes", "Charts" and "Collections". "Charts" directly displays source apps, categories and charts they provide. "Collections" on the other hand
lets the user select saved collections. These in turn are also divided into groups, subgroups and corresponding collections.
Below the sidebar is the Timespan /-granularity selector, which lets the user change the corresponding values.
=== Top ===
The top mainly houses two components in the toolbar and the legend.
The toolbar has toggles for certain functionality like "What chart type should be used" or "Should the chart be compressed to the max visible width". Besides that,
it also houses the entry point for the "Save as Collection" functionality.
The legend provides the user with an indicator as to what graph is currently displaying what data. And also serves as a toggle for visibility on a graph by graph basis,
without having to fully deselect it.

== Implemented API in other Apps ==
Here is a list of the apps that have implemented the Statistics API and the data they return.

''Note: This list may change over time.''
=== App Platform Manager ===
* ''chart_manager_uptime'': Manager uptime
* ''chart_system_cpu_perc'': CPU load
* ''chart_system_disk_total'': Storage size
* ''chart_system_disk_used'': Used storage
* ''chart_system_memory_total'': RAM size
* ''chart_system_meory_used'': Used RAM
=== Connect ===
* ''Posts'': Number of posts
* ''SQL'': Number SQL queries
* ''Sessions'': Amount of sessions
=== Contact Widget ===
* ''Chats'': Number of text chats
* ''VoiceCalls'': Number of voice calls
* ''VideoCalls'': Number of video calls
* ''All'': Combined chats, voice calls and video calls
=== Recordings ===
* ''CurrentRecordings'': Number of currently running recordings
* ''LicenseType'': internal usage, not relevant
* ''NumRecordings'': Number of recordings in the database that have not been deleted
* ''OldestRecording'': Oldest recording in the database not deleted
* ''ReportingLink'': Indicates whether the link between recordings and reports is up or down
* ''SizeDB'': Size of the Database

== Libraries used ==
The following libraries are used to display charts.
* Chart.Js
** License: [https://github.com/chartjs/Chart.js/blob/master/LICENSE.md MIT License]
** Further Information: [https://www.chartjs.org/ Library]

== Troubleshooting ==
When you open a support ticket, you will be asked to provide us with debugging data of your issue. You can also send us screenshots/videos of the behaviour you are reporting. Do not forget to send us also the PBX default configuration file.
=== Trace flags of the myAPPS Client ===
Go to the myApps '''Burger menu''', click on '''more''', and then click the '''magnifying glass'''. Tick the following trace flag:
*Browser console
*App
''Hint: If you are using myApps in a browser, press F12 to open the browser console.''

== Restrictions / Known issues ==
* Due to restrictions on the canvas element on iOS the mobile version is limited to a max width of 4096px

== Related Articles ==
* [[{{NAMESPACE}}:Apps/PbxManager/App Charts]]
* [https://sdk.innovaphone.com/16r1/service/statistics/statistics.htm SDK documentation]
[[Category:Apps/PbxManager/App Charts]]

Reference16r1:Apps/PbxManager/MQTT Broker

2026-04-28T12:04:11Z

Slu:

The MQTT Broker Settings plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. 

== Add an App ==
;Name
:The ''name'' displayed for the App object which must be unique.

;SIP
:The ''sip'' of the App object which must be unique.

;Config templates
:If config templates exist, they will be listed with a checkbox. Tick the template of your choice to deploy the application.

==Related Articles==
* [[{{NAMESPACE}}:Concept App MQTT Broker|Reference16r1:Concept App MQTT Broker]]

Reference16r1:Apps/PbxManager/Email

2026-04-28T12:03:59Z

Slu:

This PBX Manager Plugin configures the E-Mail Account of all PBXes in the system. The same configuration can be found in the advanced UI of the individual PBXes at [[{{NAMESPACE}}:PBX/Config/Authentication|PBX/Config/Authentication]].

== Add Email Account ==
; SMTP Server
: Your SMTP Server

; Email Address
: The used From Address

; Username
: The username for the authorization

; Password
: The password for the authorization

; Sender's name
: The used Name in the From field

; OAuth2
: Alternatively OAuth2 credentials to authenticate for e-mail sending. See [[Howto16r1:Configure_OAuth2_E-Mail]].

Reference16r1:Apps/PbxManager/Documents

2026-04-28T12:03:51Z

Slu:

== Add an app object ==

==Related Articles==

Reference16r1:Apps/PbxManager/App Working

2026-04-28T12:03:36Z

Slu:

This PBX Manager Plugin contains 2 section:
* Add, edit or delete Working App on the PBX.
* Configuration: Setting target Master PBX .

== Configuration ==
; PBX Name
: This field specifies the master PBX to ensure that searches and data replication are performed on the correct PBX
; Connect Name
: The H323 name (SIPid) of the Connect app must be configured here. This is usually ''connect'', but it depends on the individual setup of the system.
; Connect Groups
: Here you can define a comma-separated list of PBX group names that can be used for Connect integration in private posts. This allows separate PBX groups, such as the Human Resources department, to be included in private posts alongside department heads.
; Language for connectsposts
: Integration with the Connect app and thus the creation of “posts” is carried out from a central location. The language can be set for these posts. Currently, there is ‘de’ for German and “en” for English.

== Add an App ==
; <nowiki>Name: </nowiki>
: The name displayed for the App Object.

'''SIP:'''

: The sip from the App Object, which must be unique

'''Config templates:'''

: Select which config templates will allow to access the App Object.

== App objects ==
; Working User
: This is an app, where the user can enter the working hours, holidays, sick and vacation days

; Working Manager

:This is an app that allows you to monitor working times, there are two types of rights:

: - The Human Resources view where all working times can be viewed
: - The Manager view, where managers only see the working times of the associated group
; Working API
: This is a hidden app, where the myApps session is been monitorized when the autostart/stop of the working times is enabled on the Working User App.

;Working Service API
: This is an app needed to provide the Working Client API, so that other apps can start/stop working times.

;Public Holidays API
: This API provides public holiday data for other apps. It allows them to check whether a specific date is a public holiday in a given country or region.

Reference16r1:Apps/PbxManager/App Documents

2026-04-28T12:03:15Z

Slu:

This page describes the PBX Settings Plugin of the Documents App.

The app is only available as a plugin app and is not visible to users as a standalone app.

This app must be allowed for both users and other app services.

== Individual Documents App Configuration ==
Following items can be configured in a PBX App object:

* '''Name''': Object long name
* '''SIP''': Object name. Allowed characters according to the [[Reference15r1:PBX/Objects#General_Object_Properties | general object properties]]. Using unallowed characters, e.g. spaces, can result in an unexpected behavior of the app, e.g. the badge counts do not work.

=== App permissions ===
Allowed apps for the Documents service which provides the com.innovaphone.tagging API for checking user permissions.

=== Configuration Templates ===
Select configuration templates to be applied for the Documents app object.

Howto:Supported innovaphone versions

2026-04-28T11:52:56Z

Slu:

As of today (April 2026) we support firmware versions 16r1, 15r1 and 14r2.

This article explains the rule behind this.

==Applies To==
This information applies to all innovaphone products and firmware

== What it means ==
The firmware described here is being supported by us generally (that is, support tickets may be opened, and we provide new service releases). However, on specific devices, firmware support may end earlier due to technical restrictions. See [[Howto:Firmware Upgrade]] for details.

== Basic explanation of the supported versions ==

=== Structure of version numbers ===
Version numbers are composed as followed: (Major Version)r(Minor Version)sr(Service Release) 
This means for example for <code>15r1sr10</code>:
* Major Version: 15
* Minor Version: r1
* Service Release: sr10

=== General rule for supported versions ===

We support the <code>2 latest minor versions in the latest major version</code> '''and''' the <code>latest minor version in the 3 latest major versions</code>

;Examples
:If the latest version is 14r2, we support 14r2 and 14r1 as the <code>2 latest minor versions in the latest major version</code> and 14r2, 13r3, 12r2 as the <code>latest minor version in the 3 latest major versions</code>.
:If the latest version is 15r1, we support 15r1 as the <code>2 latest minor versions in the latest major version</code> and 15r1, 14r2, 13r3 as the <code>latest minor version in the 3 latest major versions</code>.
:If the latest version is 16r1, we support 16r1 as the <code>2 latest minor versions in the latest major version</code> and 16r1, 15r1, 14r2 as the <code>latest minor version in the 3 latest major versions</code>.

==== Special exceptions ====
As is often the case, there are of course exceptions to every rule. In this case, the exceptions to the above rules are as follows.

* V6 firmware on an IP21 in order to take advantage of the AUX or door interface will continue to be supported. (Support will end at latest once a replacement product featuring a door and AUX interface is released.)
* TAPI V8.00, latest release
* log2pcap V6.00, latest release
* Wireshark DLLs V6.00, latest release

===Problems with old versions===
If you have issues which can not be fixed by changing the configuration, you need to upgrade to a more recent version.

== Related Articles ==
* [[Howto:Firmware Upgrade]]
* [[Support:End of Life for Linux Application Platform V9.00]]

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

Howto16r1:Firmware Upgrade V15r1 V16r1

2026-04-28T10:23:39Z

Slu: /* AP Upgrade to Image 140029 or newer */

== Applies To ==
This information applies to:

* All 16r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 16r1, see [[Howto:Firmware Upgrade]]
== Licenses ==
In case of cloud or rental model, don't worry about licenses.

If the system is licensed on premise, you'll need to regenerate the license file for v16 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. Create backups before you start and store them on an external location

=== AP Upgrade to Image 140037 or newer ===
* First, upgrade your application platform to at least image version 140037. After that you can go ahead.

=== Upgrade Sequence ===
In systems of multiple units, it is important to update the tree from top to bottom. In other words, update the master unit first, and then the machines at the lower levels. If you're using a DevicesApp update job that updates the entire system at once, you don't need to do anything here.

=== TechAssist Upgrade Helper ===
* Before you start, make sure that all TechAssist tests (you will receive the required tests in the last update in the previous major version) labelled <code>Pre Upgrade: xy</code> are positive, if available
* When you are finished, make sure that all TechAssist tests (you will receive new tests with the upgrade) are positive

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a upgrade, as the change will be visible/audible in the behaviour of the application/device.

* ''Nothing''

== Manual steps needed after upgrade ==
If the installer is not used for a new installation, some new default settings are not set. Please evaluate per app whether you want to configure the new default settings manually.

=== Connector for Microsoft 365 ===
If you plan to use the new '''Contact Search''' feature of the Connector for Microsoft 365, you need to perform two manual Steps:
# Create the '''microsoft365-api''' app object by using the Settings template
# Assign the '''microsoft365-api''' app object to every user who should be able to use the new Contact Search feature. (Of cause, you can use a template for that)
 
For a more detailed guide, please refer to the how-to article: [[Howto16r1:Configure Contact Search by Connector for Microsoft365#Creating the PBX app object using the PBX Manager Plugin]]

=== Remote Control ===
In order to use the Admin Configuration Panel of the Settings App – AP Remote Control, it is necessary to grant access to the '''admin''' API, available in the App tab of the Remote Control App object.

=== Working ===
For badge counts to work, the Working Manager app object must have '''Websocket''' and '''PbxSignal''' enabled.
For the Connect integration of the Working app, '''Websocket''', '''Services''' and '''connect'''(in the Apps tab) must be enabled in the Working User app.

=== Switchboard ===
For the Connect Integration (Call Notes) to work, the Switchboard App must have the '''Services''' (App-tab) and '''connect''' or '''messages''' (Apps-tab) enabled (the name depends when the PBX was installed).

=== Projects ===
* Projects requires '''App platform version 140029''' or higher, so updating the App Platform before Projects is recommended. The Store will prohibit the update if the App Plattform does not have the minimum required version.
* For some extra admin-functionalities the '''Projects App Object needs to have an admin mode''' (App-tab). Easiest way to set this new mode is to the open the Projects App via the Projects Plugin Settings App and to re-apply it (click the OK-button). The same plugin can also be used to distribute this mode via the Config Templates.
* The '''App Platform requires the correct Time and a Timezone''' set under AP Manager/Settings/General. This is needed for some automatic cleanup of deleted items and automatic task status updates (done around 00:00h on the due date).

=== For legacy support only: Change TLS Profile ===
The ''Normal'' profile has been updated to allow only TLS 1.3 and TLS 1.2. This setting is compatible with all supported firmware versions. So you don't need to do any changes.
However if you need older TLS versions for compatibility with legacy devices, consider changing the TLS profile to ''Legacy''. In that case please see [[Reference16r1:IP4/General/TLS]] for details.

== New Apps ==
New Apps will not be installed automatically by the upgrade. The installation description of new apps is usually in the concept article. Please rate per app whether you want to install/use the new app and configure it manually.

; App Charts: [[Reference16r1:Concept_App_Charts]]
; App Polls: [[Reference16r1:Concept App Polls]]
; App MQTT Broker: [[Reference16r1:Concept_App_MQTT_Broker]]
; App Conference Scaler: [[Reference16r1:Concept_Conference_Scaler_App]]
; App Service Conference Transcriptions: [[Reference16r1:Concept_App_Service_Conference_Transcriptions]]
; App Service Transcriptions: [[Reference16r1:Concept_App_Service_Transcriptions]]
; App Service Documents: [[Reference16r1:Concept_App_Service_Documents]]
; App Service Connector for Whatsapp: [[Reference16r1:Concept_App_Service_Connector_for_Whatsapp]]
; App Service IP: [[Reference16r1:Concept App Service IP]]

== New environment for App Platform ==
The new [[Reference16r1:Concept_innovaphone_App_Platform_Container|App Platform Container]] provides an Docker container. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Removed ==
The following software is no longer included.

* IP110A (can still be used with 15r1 firmware on current PBX versions)
* IP240A (can still be used with 15r1 firmware on current PBX versions)
* CA on CF card feature

== Deprecated ==
The following software is based on legacy technology, with no further development and limited maintenance and support.

* ''Nothing''

== Previously deprecated and now no longer supported ==
The following software is based on legacy technology, with no further development and no more maintenance and support.

* ''Nothing''

==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto15r1:Firmware_Upgrade_V14r2_V15r1]]
[[Category:Howto|{{PAGENAME}}]]

Howto16r1:Firmware Upgrade V15r1 V16r1

2026-04-28T10:22:26Z

Slu: /* New Apps */

== Applies To ==
This information applies to:

* All 16r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 16r1, see [[Howto:Firmware Upgrade]]
== Licenses ==
In case of cloud or rental model, don't worry about licenses.

If the system is licensed on premise, you'll need to regenerate the license file for v16 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. Create backups before you start and store them on an external location

=== AP Upgrade to Image 140029 or newer ===
* First, upgrade your application platform to at least image version 140029. After that you can go ahead.

=== Upgrade Sequence ===
In systems of multiple units, it is important to update the tree from top to bottom. In other words, update the master unit first, and then the machines at the lower levels. If you're using a DevicesApp update job that updates the entire system at once, you don't need to do anything here.

=== TechAssist Upgrade Helper ===
* Before you start, make sure that all TechAssist tests (you will receive the required tests in the last update in the previous major version) labelled <code>Pre Upgrade: xy</code> are positive, if available
* When you are finished, make sure that all TechAssist tests (you will receive new tests with the upgrade) are positive

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a upgrade, as the change will be visible/audible in the behaviour of the application/device.

* ''Nothing''

== Manual steps needed after upgrade ==
If the installer is not used for a new installation, some new default settings are not set. Please evaluate per app whether you want to configure the new default settings manually.

=== Connector for Microsoft 365 ===
If you plan to use the new '''Contact Search''' feature of the Connector for Microsoft 365, you need to perform two manual Steps:
# Create the '''microsoft365-api''' app object by using the Settings template
# Assign the '''microsoft365-api''' app object to every user who should be able to use the new Contact Search feature. (Of cause, you can use a template for that)
 
For a more detailed guide, please refer to the how-to article: [[Howto16r1:Configure Contact Search by Connector for Microsoft365#Creating the PBX app object using the PBX Manager Plugin]]

=== Remote Control ===
In order to use the Admin Configuration Panel of the Settings App – AP Remote Control, it is necessary to grant access to the '''admin''' API, available in the App tab of the Remote Control App object.

=== Working ===
For badge counts to work, the Working Manager app object must have '''Websocket''' and '''PbxSignal''' enabled.
For the Connect integration of the Working app, '''Websocket''', '''Services''' and '''connect'''(in the Apps tab) must be enabled in the Working User app.

=== Switchboard ===
For the Connect Integration (Call Notes) to work, the Switchboard App must have the '''Services''' (App-tab) and '''connect''' or '''messages''' (Apps-tab) enabled (the name depends when the PBX was installed).

=== Projects ===
* Projects requires '''App platform version 140029''' or higher, so updating the App Platform before Projects is recommended. The Store will prohibit the update if the App Plattform does not have the minimum required version.
* For some extra admin-functionalities the '''Projects App Object needs to have an admin mode''' (App-tab). Easiest way to set this new mode is to the open the Projects App via the Projects Plugin Settings App and to re-apply it (click the OK-button). The same plugin can also be used to distribute this mode via the Config Templates.
* The '''App Platform requires the correct Time and a Timezone''' set under AP Manager/Settings/General. This is needed for some automatic cleanup of deleted items and automatic task status updates (done around 00:00h on the due date).

=== For legacy support only: Change TLS Profile ===
The ''Normal'' profile has been updated to allow only TLS 1.3 and TLS 1.2. This setting is compatible with all supported firmware versions. So you don't need to do any changes.
However if you need older TLS versions for compatibility with legacy devices, consider changing the TLS profile to ''Legacy''. In that case please see [[Reference16r1:IP4/General/TLS]] for details.

== New Apps ==
New Apps will not be installed automatically by the upgrade. The installation description of new apps is usually in the concept article. Please rate per app whether you want to install/use the new app and configure it manually.

; App Charts: [[Reference16r1:Concept_App_Charts]]
; App Polls: [[Reference16r1:Concept App Polls]]
; App MQTT Broker: [[Reference16r1:Concept_App_MQTT_Broker]]
; App Conference Scaler: [[Reference16r1:Concept_Conference_Scaler_App]]
; App Service Conference Transcriptions: [[Reference16r1:Concept_App_Service_Conference_Transcriptions]]
; App Service Transcriptions: [[Reference16r1:Concept_App_Service_Transcriptions]]
; App Service Documents: [[Reference16r1:Concept_App_Service_Documents]]
; App Service Connector for Whatsapp: [[Reference16r1:Concept_App_Service_Connector_for_Whatsapp]]
; App Service IP: [[Reference16r1:Concept App Service IP]]

== New environment for App Platform ==
The new [[Reference16r1:Concept_innovaphone_App_Platform_Container|App Platform Container]] provides an Docker container. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

== Removed ==
The following software is no longer included.

* IP110A (can still be used with 15r1 firmware on current PBX versions)
* IP240A (can still be used with 15r1 firmware on current PBX versions)
* CA on CF card feature

== Deprecated ==
The following software is based on legacy technology, with no further development and limited maintenance and support.

* ''Nothing''

== Previously deprecated and now no longer supported ==
The following software is based on legacy technology, with no further development and no more maintenance and support.

* ''Nothing''

==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto15r1:Firmware_Upgrade_V14r2_V15r1]]
[[Category:Howto|{{PAGENAME}}]]

Reference16r1:Concept App Service IP

2026-04-28T10:18:13Z

Slu:

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX) 
'''Password''' = The password must be set to "pwd" for Install and will be changed during the process.

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: https://domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==

The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Container]]