innovaphone wiki - User contributions [en]

Reference16r1:Concept App Service Connector for Microsoft 365

2026-10-16T13:43:44Z

Sga: EWS retirement dates, link to support article - Co-Authored-By: AI

[[Category:Concept|Apps]]
== Applies To ==

* Connector for Microsoft 365 from Version 16r1

= Overview =

Connector for Microsoft 365 synchronizes Microsoft Teams presences with the innovaphone PBX and back, and optionally additionally Calendar presence from Exchange Online (part of the Microsoft 365 Cloud Services).
It is also possible to search for your own contacts.

== Requirements ==

* innovaphone PBX
* innovaphone Application Platform (minimum version 120004)
* V16r1
* App(Connector for Microsoft 365)
* PBX-App(innovaphone-microsoft365) license per user - order no. 02-00050-009

== Concept ==

=== User Presence ===

==== Configuration ====
Please have a look into our [[Howto16r1:Configure User Presence Sync by Connector for Microsoft365|Howto guide for basic configuration aid on user presence synchronisation]].

==== Technical Overview ====
If the Connector for Microsoft 365 app is fully configured, the app connects to Microsoft to obtain a token. With the token, the app gets the teams users (with a Teams license) through the Microsoft Graph API.
A presence subscription to Microsoft is started with the licensed users of the PBX to get presence changes in Microsoft Teams for these users. A user subscription is also started to get changes of the users (adding, deleting or update). If a user has changed, the Teams users are retrieved again. If the presence has changed, it is forwarded to the PBX. The presences of Teams are mapped to the presences of the PBX.

* User subscriptions are renewed every 60 minutes.
* Presence subscriptions are renewed every 10 minutes.
* License Check is made periodically.

The app synchronises the PBX presence with Teams through the Graph Api. The on-the-phone presence will be renewed every 5 minutes. The other presences have a lifetime of 1 day but the away has a lifetime of 7 days.
The lifetimes are described [https://learn.microsoft.com/en-us/graph/api/presence-setuserpreferredpresence?view=graph-rest-1.0&tabs=http here]

'''Please be aware:''' The actual change of presence or line state will be live, the above-mentioned subscriptions are needed to register against the Microsoft API for changes.
After successful subscription Microsoft will trigger the Connector for Microsoft 365 App every time a presence or line state for a user has changed.
The subscription will then be renewed in the above-mentioned time interval to receive further live updates.

===== User Matching =====
You now can choose the fields used for user matching on either side from the following options:
* PBX
** CN (Long Name property from the PBX user object)
** h323 (Name property from the PBX user object)
* Azure Portal
** displayName
** mail
** mailNickname
** onPremisesDistinguishedName
** onPremisesSamAccountName
** onPremisesUserPrincipalName
** userPrincipalName

Additionally, you have the possibility to remove a possibly contained domain from the Azure fields content. 
Example: 'user@domain.tld' is transformed to 'user', if this option is checked.

===== Mapping Table =====

{| class="wikitable"
|-
! Teams Presence
! PBX Presence
|-
| Away
| away
|-
| BeRightBack
| away
|-
| Busy
| busy
|-
| DoNotDisturb
| dnd
|-
| InACall
| on-the-phone
|-
| InAMeeting
| meeting
|-
| Inactive
| online
|-
| PresenceUnknown
| online
|-
| Available
| online
|-
| Offline
| online
|-
| Offwork
| online
|-
| OutOfOffice
| away
|-
| UrgentInterruptionsOnly
| dnd
|-
| Presenting
| on-the-phone
|-
| InAConferenceCall
| on-the-phone
|}

The value "online" unsets the Teams presence in the PBX.

===== Master/Slave =====

For Master/Slave combination the "Connector for Microsoft 365" App has to be added to the slave (if no full replication is on). The slave websocket connection is needed to display "on-the-phone" presence.

=== Calendar Presence ===

==== Configuration ====
Please have a look into our [[Howto16r1:Configure Calendar Presence Sync by Connector for Microsoft365|Howto guide for basic configuration aid on calendar presence synchronisation]].

==== Technical Overview ====
Introduced in 15r1 the Connector for Microsoft 365 will offer a possibility to sync Azure Portal calendar events (Teams, Exchange online) via the Graph API with the PBX presence. 
For now the [https://wiki.innovaphone.com/index.php?title=Reference13r3:Concept_App_Service_Calendar Calendar App] is (along with other functions) also capable of syncing calendar events, but using the old EWS mechanism. Microsoft disables EWS in Exchange Online by default starting October 1, 2026 and shuts it down permanently on April 1, 2027, see [[Support:Calendar App - Exchange Online EWS Retirement]]. 
'''Warning:''' Please make sure to not use both apps for syncing calendar events in parallel, this is not supported and will most likely lead to conflicts and unexpected behaviours. 
 
When the configuration of the connector for Microsoft 365 Calendar Presence Sync is complete, the app connects to Microsoft to receive a token with the calendar app registered in the Azure portal. 
With the token, the app can pick up the users from the Azure portal. 
These are matched against the users in the PBX, based on the configured "User Assignment" settings. 
For each matched user with a valid Connector for Microsoft 365 licence applied, a subscription for calendar events is created at Microsoft to receive event changes in Microsoft Calendar for these users. 
 
A user subscription is also started to receive user changes (add, delete or update). 
If a user has changed, the users are retrieved again. 
 
If a calendar event has been started or ended, it is forwarded to the PBX. 

* User subscriptions are renewed every 60 minutes.
* Event subscriptions are renewed every day.
* License Check is made every hour.

=== Contact Search ===

==== Configuration ====
Please have a look into our [[Howto16r1:Configure_Contact_Search_by_Connector_for_Microsoft365|Howto guide for basic configuration aid on contact search]].

==== Technical Overview ====
Introduced in 16r1 the Connector for Microsoft 365 will offer a possibility to search for your own contacts (Teams, Exchange online) via the Graph API.

When the configuration of the connector for Microsoft 365 Contact Search is complete, the app connects to Microsoft to receive a token with the contact search app registered in the Azure portal. 
With the token, the app can pick up the users from the Azure portal. 
These are matched against the users in the PBX, based on the configured "User Assignment" settings. 
For each matched user with a valid Connector for Microsoft 365 licence applied, the user can search with the Phone App, for example (a myApps search provider will be provided for all apps looking using search providers looking up contacts). The search string is made available to the Connector for Microsoft 365 via the microsoft365-api. The results are sent to the consumer, e.g. the Phone App and presented there. 
 
A user subscription is started to receive user changes (add, delete or update). 
If a user has changed, the users are retrieved again. 
 

* User subscriptions are renewed every 60 minutes.
* License Check is made every hour.

'''Be aware:''' Since the Connector for Microsoft 365 is an app in the Scope of myApps App Platform, IP Phones and other services not using Apps cannot benefit from this search service.

== Related Articles ==

=Known Limitation=

== General ==
''Applies to the User Presence and the Calendar Presence''

=== Synchronization Delay ===
In the official Graph-API documentation, Microsoft is providing an overview about expected latencies for change notifications. 
You can find a whole overview table here: 
https://learn.microsoft.com/en-us/graph/change-notifications-overview#latency 
 
For the user presences the resource "presence" is used and an average latency of 10 seconds but a maximum up to 1 minute is provided. 
Such a delay in syncing changed presences from Teams down to the PBX are considered normal and are caused by the Microsoft Graph-API. 
 
In case of calendar events the average is provided as "less than 1 minute" and the maximum to 3 minutes. 

== User Presence ==
=== Line states set by the PBX does not block calls in Teams ===
Line states set by a 3rd party application (like the Connector for Microsoft 365) through the graph API are currently '''only for display purpose and do not block new calls''' in Teams. 
 
https://techcommunity.microsoft.com/t5/teams-developer/ms-graph-setpresence-problems/m-p/2798805/highlight/true#M3957 
As you can see in the above linked discussion, there once existed a feature request on Microsoft Voice, which is no longer available since it was not voted.
=== Maximum number of supported users ===
The connector now supports multiple Microsoft Teams communication users, which is the prerequisite to subscribe for more than 650 users. There is a new ribbon (Manage Teams Accounts) that allows you to configure as many communication users as you need. Every configured communication user can be used to subscribe 650 users, for example:

*3 configured communication users x 650 licensed users = 1950 users can be subscribed
'''Please be aware''': Each communication user must have a Teams license applied.

This limitation is caused by Microsoft. 
In the documentation of the Graph-API you will find a hint to this limitation: 
https://learn.microsoft.com/en-us/graph/changenotifications-for-presence#subscribe-to-multiple-users-presence 
Trying to subscribe more than 650 users (with one communication user) by using the presence subscription API will be declined by the graph API with an error message, that too many users are requested. 

=== Communication User (UserSynctoPbx) ===
Users with multi-factor authentication (MFA) are not supported as technical communication users for the Connector.

''We recommend creating a dedicated user account for this purpose rather than using an existing user account.'' 
''This limitation applies only to technical users used for the Connector for Microsoft 365, not standard user accounts. MFA can be used for real users.''

=== Multiple sites / instances require multiple communication users ===
Each instance or each site must have separate communication users, as Microsoft only allows one concurrent subscription per communication user. (otherwise an HTTP 409 conflict will occur)

This means that if you want to subscribe to the same Azure Portal backend from two different sites (or instances), you will need to have multiple communication users (each with an applied Teams licence) in order to be able to subscribe from all endpoints.

=== Subscription Timeout ===

==== Situation ====
Due to a current limitation in the Graph API it is not possible to cancel or delete an active presence subscription. 
As you can see in the [https://learn.microsoft.com/en-us/graph/api/subscription-delete?view=graph-rest-1.0&tabs=http|documentation of the current Graph API (1.0)] the “Delete subscription” chapter does not include presence subscriptions. 
It is also not possible to have multiple subscription in parallel. 

To make sure to only request a new presence subscription when the old one is not valid anymore, the app will store the state of the presence subscription and the time until it is valid in the database. 
As mentioned in the chapter “Technical Overview” we are creating presence subscriptions with a validity of 10 minutes. 
The presence subscription will be renewed as soon as it is no longer valid which will be 10 minutes after initial subscription. 

==== Impact ====
If settings are changed or the app instance is restarted it will check the corresponding database entry on startup. 
In case the last presence subscription was completed less than 10 minutes ago, there is still an active presence subscription and the app has to wait for it to become invalid. 
Some Changes (e.g., to the “Notification-URL”) will only take effect after a new created subscription. 

The current Beta Version of the Graph API is already providing a function to delete presence subscriptions, so we hope we can improve this behavior in the future. 

== Contact Search ==
=== Limited scope of searchable contacts ===
The contact search only queries the default Contacts folder of the searching user's mailbox via the Microsoft Graph API ('''/users/{id}/contacts'''). The following are currently '''not''' included in the search results:

* Custom/subordinate contact folders
* Contact folders of other mailboxes shared with the user
* The organizational Global Address List (GAL)

Creating and managing custom contact folders is no longer available in Microsoft's own cloud-based Outlook (Outlook on the web / new Outlook). Contacts in folders created earlier are still displayed there, listed under a different category - but the standard Microsoft Graph API contact search used by the Connector does not find these contacts.

Search of the organizational Global Address List (GAL) is currently not supported by the Connector.

=Troubleshooting=
== General ==

===Creating an app trace===
For further analysis and creating a support ticket it will be useful to have a suitable app trace. 
Before creating the trace please make sure the following trace flags are activated for the app instance:
* App
* App WebSocket
* Config
* Database
* HTTP client
* TCP
* TLS
* Webserver

After setting the config flags, please make sure to
* stop the instance
* deleting the current instance log
* start the instance
'''Now please wait at least 12 Minutes before you save the log''', otherwise we could not have the whole picture in the trace.

The restart and deletion of the the old log is useful the see the complete initialization process right away.

===SSL Certificate for notification URL===
It also is useful to make sure the notification URL has a valid and public signed certificate. 
You can do that, using an SSL-Checker, for example: https://www.sslshopper.com/ssl-checker.html 
Without a valid, public signed certificate, Microsoft will decline the connection since it will not be possible to establish a trust relationship for the SSL/TLS secure channel.

===Correctness of notification URL===
You can try to open the notification URL in your Browser 
Most likely you will see a HTTP 404 (Not Found) error message, which is the expected behavior since we are not providing an HTML website, the HTTP GET request from the browser will not be answered with content. 
This is perfectly fine since Microsoft will send presence updates with HTTP POST and will not try to request content from our app. 
 
What you can find out by trying to open the URL in your browser are the two following things: 
* If you receive a HTTP 404 error message you are most likely connected to an App Platform, if not you need to check your DNS (and maybe also reverse proxy) settings.
* If the URL is modified and the used build number is added, an app has answered your request
** Example: <code>https://public.dns/your.domain/microsoft365/subscriptions</code> is modified to <code>https://public.dns/your.domain/microsoft365/1510411/subscriptions</code>
** If this is not the case, your URL is wrong. (Be aware: The URL depends on the settings of the web server path of your app instance)

'''Be aware:''' The URL-Recognition in the Application Platform is '''case sensitive'''.

=== Activation of "Public client flow" for the registered app in Azure Portal===
If the subscription is not working at all, please make sure "Public client flow" is activated for the registered app in the Azure portal (as described in our [[Howto16r1:Configure User Presence Sync by Connector for Microsoft365#Create an App for syncing Teams to PBX|HowTo article]]). 
 
The App Service trace will contain the following message if this is not the case: 
<code>AADSTS7000218: The request body must contain the following parameter: 'client_assertion' or 'client_secret'.</code>

== User Presence ==
===GUI Feedback===
The app itself shows required states with green and red as connections to the Master PBX, Authentication and Presence Subscription to identify if there are problems. 
Sometimes it needs a little bit time until the states are changed. 
If the states remain, it is mandatory to enable logs on the app platform and check for more information. 
([[Howto13r3:Configure Connector for Microsoft365#Creating an app trace|Concept App Service Connector for Microsoft 365: Creating an app trace]])

====No connection to Master PBX====
Check the MasterPBX name. 
The field must only contain the name [pbx], '''not the full domain''' [pbx.domain.tld]. ([[Howto13r3:Configure Connector for Microsoft365#Synchronization from Teams to the PBX|Synchronization from Teams to the PBX - Master PBX field]])

====Presence subscription failed====
There are many reasons why the "Presence subscription failed" message could be displayed. 
We try to list the most common reasons:
* The permission for the registered app in the Azure portal are not correctly set ([[Howto13r3:Configure Connector for Microsoft365#Create an App for syncing Teams to PBX|Howto: Create an App for syncing Teams to PBX]])
* The Notification URL is wrong ([[Reference13r3:Concept App Service Connector for Microsoft 365#Correctness of notification URL|Concept App Service Connector for Microsoft 365: Correctness of notification URL]] )
* The App service is not reachable from the internet ([[Reference13r3:Concept App Service Connector for Microsoft 365#Correctness of notification URL|Concept App Service Connector for Microsoft 365: Correctness of notification URL]] )
* The certificate for the public endpoint (e.g. reverse proxy) is not valid, or not publicly signed ([[Reference13r3:Concept App Service Connector for Microsoft 365#SSL Certificate for notification URL|Concept App Service Connector for Microsoft 365: SSL Certificate for notification URL]])
* The user from PBX and the Azure Portal cannot be matched ([[Reference13r3:Concept App Service Connector for Microsoft 365#User Matching|Concept App Service Connector for Microsoft 365: User Matching]])
* The App Platforms clock time is wrong ([[Reference13r3:Concept App Service Connector for Microsoft 365#App Platform clock time is wrong|Concept App Service Connector for Microsoft 365: App Platform clock time is wrong]])
* No user has a valid Connector for Microsoft 365 App license ([[Reference13r3:Concept App Service Connector for Microsoft 365#Requirements|Concept App Service Connector for Microsoft 365: Requirements]])

===Teams License for communication user===
If presence subscription does not work, please check if all of the configured communication users have a Microsoft Teams license applied and no multifactor authentication is in use for this particular user. 
Also please make sure you can login with the configured credentials. (If you have set a password as an Administration, the user needs to change the password during the first login, therefore the given password will be invalid for API access). 
''Sometimes, after changing setting or after the instance has restarted it can take up to 12 minutes until the presence subscription is working correctly. (Due to the subscription timeout)''

= Known Issues =
== Special Characters In Password ==
If you are using special characters (*, &, (, ), etc.) in your password you could run into a problem with the authentication of the communication user. 
The authentication failed status is being displayed. 
For the moment the only workaround is to eliminate special characters from your password.

==App Platform clock time is wrong==
If the clock time at the App Platform is not correct, this will lead to an unstable behaviour of the Connector for Microsoft 365. 
Since the Connector for Microsoft 365 is using the Microsoft Graph APIs presence subscription function, it needs to provide in its request a precise time until the subscription validity will be expired. 
The app service is handling subscription and will automatically recreate a new subscription each time the previous one has expired. 

A wrong clock time will lead to false expiration times and thus
* the subscription will be expired earlier than expected (synchronisation is not working because there is no valid subscription)
* the subscription will be valid longer than expected (the app service is trying to create a new subscription because it is expecting the previous one to be expired - will lead to a 409 conflict error, because only one subscription can be valid at a time)

If you are not sure about the current time of the App Platform, you can login via SSH into the App Platform and execute the <code>date</code> command to check the current time. 
You will receive an output like:
Tue Mar 12 13:38:57 UTC 2024
Please be aware: The time is displayed in UTC, so please make sure to convert to your local time zone.

==Geoblocking==
Since there might be no reliable country assignment for Microsoft addresses, all Microsoft addresses must be enabled on the upstream firewall in the event of geoblocking in order to ensure functionality of the Office365 Connector. 
As an alternative you might be able to configure your firewall to bypass the geoblocking for the configured notification URL.

= Related Articles =
[[Howto16r1:Configure User Presence Sync by Connector for Microsoft365]] 
[[Howto16r1:Configure Calendar Presence Sync by Connector for Microsoft365]] 
[[Howto16r1:Configure Contact Search by Connector for Microsoft365]]

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

Reference14r2:MyApps Plugin for Virtual Desktops

2026-10-15T09:33:11Z

Sga:

[[Category:Concept|Apps]]
== Description ==
A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.
Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
Video suffers from the same limitations.

The myApps Virtual Desktop Plugin enables media data to be transferred to the local client in terminal server environments.
== Applies To ==
* innovaphone PBX from version 14r2
* Client OS: Windows, Linux<ref>VDI Plugin for Linux only connects to Citrix or VMWare Horizon, RDP still not supported</ref>(Ubuntu 22 or 23, RangeeOS<ref>RangeeOS is listed due to a customer testimonial. No tests have been conducted by innovaphone. Tests were done using myapps 14r2sr3, RangeeOS Firmware 12.00 build 203 ff and Citrix Workspace 2311. (Workspace version 2402 & 2405 have a bug with USB redirection and 2408 is not starting reliably)</ref>, IGEL OS<ref>IGEL OS: available at [https://app.igel.com/myAppsPlugin/15.1.455+1 IGEL App Portal]</ref>) or MacOS operating systems
* Hypervisor OS: Citrix, Windows Terminal Server environments and VMWare Horizon<ref>VMWare Horizon OS is listed due to a customer testimonial. No tests have been conducted by innovaphone.</ref> 
<references/>

== Requirements ==
* innovaphone PBX
* innovaphone myApps native Client
* innovaphone myApps Plugin
* Citrix Workspace app for Windows: '''32-bit version only'''. The 64-bit version of Citrix Workspace app is currently not supported (see [[#Known issues|Known issues]]).

Minimum required firmware version for all products mentioned is at least 14r2final – we recommend using the latest version.
== Concept ==
The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:
* start or stop an audio/video device
* gathering of the ICE candidates
* connect to a remote peer with the ICE protocol
* start a ringing device
* rendering of video

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

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

* [https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/technical-overview/virtual-channels Citrix technical overview]
* [https://support.citrix.com/support-home/kbsearch/article?articleNumber=CTX691230 Citrix support article summary]
* [https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels Microsoft Remote Desktop Services virtual channels]

=== Call signaling ===
The VDI Plugin has no connection to the PBX. Signaling is still done at the terminal server by the myApps client.

=== Audio transmission ===
The plugin connects Audio, ICE and DTLS directly to the other endpoint. Since Audio itself does not use virtual channels, the plugin on the client must be able [[Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#ICE_STUN_TURN|to reach the TURN/STUN server via port 3478]].

== Configuration ==
'''Citrix Workspace app must first be installed on all platforms. This is necessary because the myApps plugin must copy a .dll (Windows) / .so (MacOS/Linux) into the Citrix installation directory. '''
For this to work, the Citrix installation directory must be in the %ProgramFiles(x86)% or %ProgramFiles% directory.

=== Windows ===
The myApps Plugin .msi must be installed or deployed at the Thin-Client and does not require any configuration.

=== MacOS ===
Install the myAppsPlugin.dmg or .pkg at the Thin-Client and does not require any configuration.

=== Linux ===
Update your Linux PC first:

'''sudo apt-get update'''

Download latest Citrix Workspace App (Mar 7, 2024) for Debian and x86_64 platform:

'''https://www.citrix.com/downloads/workspace-app/linux/workspace-app-for-linux-latest.html'''

Citrix Workspace app needs '''libwebkit2gtk-4.0-37''' packet and this packet is not available in Ubuntu-24.04 version.

Install it at your Linux PC:

https://docs.citrix.com/en-us/citrix-workspace-app-for-linux/install.html

'''sudo apt install -f ./icaclient_<version>._amd64.deb'''

Install (or update) now the myApps Plugin:

'''sudo apt install -f ./myAppsPlugin.deb'''

Headset Buttons:

*Jabra: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-java.rules
**Add <code>ATTRS{idVendor}=="0b0e", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Epos: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-epos.rules
** Add <code>ATTRS{idVendor}=="1395", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Plantronics: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-plantronics.rules
** Add <code>ATTRS{idVendor}=="047f", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Snom: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-snom.rules
** Add <code>ATTRS{idVendor}=="251c", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Yealink: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-yealink.rules
** Add <code>ATTRS{idVendor}=="6993", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>

No additional configuration required.

=== Configuration on the Terminalserver ===
The Softphone App at the terminal server does not require any additional configuration.

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

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

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

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

== Known issues ==

=== Citrix Workspace app 64-bit (Windows) ===
The MyApps Plugin for Windows currently works only with the '''32-bit version''' of the Citrix Workspace app.
Starting with Citrix Workspace app 2603.10, Citrix offers a 32-bit and a 64-bit version for Windows (earlier versions such as 2603.1 were 32-bit only). If the 64-bit version is installed, the plugin does not work.

'''Workaround:''' Install the 32-bit version of the Citrix Workspace app (2603.10 is also available as 32-bit).

=== Audio (Linux/IGEL OS) ===
The audio module in the MyApps Plugin for Linux/IGEL OS has no echo cancellation. It is therefore recommended to use a headset, as headsets usually have their own echo cancellers.

=== Video ===
* Webcam and remote videos must be rendered over the Softphone App, but for the time being a native window is opened at the terminal client (only for the Windows Plugin).
* Connecting to a conference or 3rd party conference does not transmit video, as video starts in the JavaScript code of the Softphone App and JavaScript has no access to the local webcam at the remote server.
** Video is displayed but with delay due to the rendering process.
** Citrix may provide access to the local webcam internally and the webcam may be available, but the remote peer will probably experience delay of the received video.

=== Notifications with Citrix Published App ===
When MyApps is used as a Citrix Published App, notification pop-ups cannot be displayed. This is because Citrix does not recognize the notifications as part of MyApps and therefore does not show them as part of the published app. If the full desktop is used in Citrix, the notifications function correctly.

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

=== macOS ===
The MyApps Plugin for macOS supports only Citrix Workspace. The "Windows App" from Microsoft is currently not supported.

==Troubleshooting==
If the problem still exists after trying the OS-specific hints below, open a support ticket and send a trace from the myApps client (remote) with App and Browser option. Please send also all myAppsPlugin-x.txt and myAppsRemote-x.txt trace files from the myApps-plugin on the local PC.

=== Troubleshooting Windows ===
If Citrix is used as a terminal server environment:
#Citrix must be installed '''BEFORE''' the plugin
#Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll
#Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there. "VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin
#In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

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

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

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

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

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

'''Disable Echo Canceler (Windows PC)'''

Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps einen neuen Eintrag erstellen:

Type: DWORD (REG_DWORD)

Name: disableEchoCanceller

Value: 1 ( or use, Value: 0 to enable the Echo Canceller)

=== Troubleshooting Linux ===

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

Innovaphone Plugin is installed under /opt/innovaphone/'''myAppsPlugin''' and in /opt/Citrix/ICAClient/'''myAppsCitrixPlugin.so'''

myAppsCitrixPlugin.so library is called by the Citrix Workspace App and this library opens the myAppsPlugin.

There is a file in the Citrix installation called module.ini (/opt/Citrix/ICAClient/config/module.ini). Inside this file the myApps Citrix Plugin library is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with '''myAppsCitrixPlugin=On''' must exist and

Following directory '''/var/log/apps/myAppsPlugin/''' must also exist for the log files with write permission for everyone (drwxrwxrwx)

====Audio Quality issues (e.g. choppy audio)====
If you run into audio quality when using myapps on Linux, the following configuration is recommended:

* Use Pipewire as the audio server
* Set the system-wide sample rate (default 44.1 kHz) to 48 kHz, since most USB headsets (e.g. Jabra) operate at 48 kHz.

You need to apply settings on OS level, since the audio backend and sample rate are operating system settings and cannot be controlled by the application.

You can check the Active audio server and sample rate with the following command:

<code>pactl info</code>

Based on your language-settings you will get a different output.
But you want to look for something like "Server Name" and "Default-Sample-Specification".

The expected results are (Language set to English):

Server Name: pulseaudio

Default Sample Specification: s16le 2ch 48000Hz

If you use pipewire you will get something like this:

Server Name: PulseAudio (on PipeWire 1.4.2)

Default Sample Specification: float32le 2ch 48000Hz

=== Troubleshooting MacOS ===

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

In /Library/Application Support/Citrix/PlugIns

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

under:

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

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

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

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

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

=== Troubleshooting Citrix ===
A Virtual Channel Policy must be added to the Registry at the '''Citrix Server''':

Create '''VCPolicies''' folder under '''HKLM/Software/Policies/Citrix''' if it does not exist.

Create '''VCPolicies''' folder under '''HKLM/Software/WOW6432Node/Policies/Citrix''' if it does not exist.

Create a REG_MULTI_SZ entry with the name '''VirtualChannelWhiteList'''. This entry must contain as value: '''INNOHDX,C:\Program Files (x86)\innovaphone\myApps\myApps.exe'''

=== Troubleshooting RTP Stream ===

You can analyze the RTP stream with the switch "--record-rtp-stream"

* RTP reception after Echo Canceller and JitterBuffer
* Audio from microphone and send to RTP

You have to start the myApps client as follows: myApps.exe --record-rtp-stream

After the call, you can find the audio files in the folder: C:\Users\...\AppData\Local\innovaphone\myApps

Tool to listen to the RTP stream: Audacity

Go to: File / Import / Raw Data and open the Folder with the Rtp stream and select the file.

For RTP-Send and RTP-Recv Data, use the Audio Codec G711 -> A-Law and 8000

For the Wave-in (out) Data Use Signed 16-bit PCM and 8000 Abtastrate

==Hints==
If all users would like to start with a clean, fresh appproxy (eg to be sure that all cached data is re-retrieved), you can add the appproxy directory to the 'Ausschlussliste - Verzeichnisse'/'Exclusion list - directories' for each user:
* Open Citrix Studio
* Open Policies in the left navigation pane (Configuration/Policies)
* Edit or Create an exisiting policy (Upon create you can filter for 'profile' or 'exclusion'). Search for 'Profile Management/Exclusion list – directories' or 'ProfilverwaltungAusschlussliste Verzeichnisse'.
* Select Exclusion list - directories and click Add.
* Add 'AppData\Local\innovaphone\myApps\appproxy'

== Related Articles ==

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

Howto:Get the trap trace on unexpected restart (reboot) caused by a crash of the system

2026-10-14T08:56:33Z

Sga: /* Reset-Sources */

== Applies To ==
This information applies to:

* All innovaphone gateways and phones with IP interface

== Problem Description ==
In a very rare cases software errors could cause an unexpected reboot of an innovaphone device. We call this situation a trap and the crash dump information stored on the device in this case a trap trace.

The devices events log will show such restart:

Error 0x000b0001 Major CMD0 Unexpected Restart WATCHDOG (2) of 121022

To be able to investigate the problem our developer rely on the information provided in the trap trace. Therefore it is very important to deliver this trace to innovaphone support if such unexpected reboot happens.

The trap trace can be downloaded via the web interface of the innovaphone device under ''Maintenance -> Diagnostics -> Tracing -> trace(buffer)'' ('''do not use''' ''trace(continuous)''!).

IMPORTANT: The trace buffer can be downloaded only one time after reboot.
The download of the trap trace or a reboot of the device will cause clearance of the trace buffer and reinitializes the tracing activity.

The IPVA has a slightly different way to obtain the crash dump. Please refer to the related wiki article [[Reference12r1:Concept Innovaphone Virtual Appliance#Troubleshooting]].

In case an unexpected restart happens, download the trap trace from the device, store it in a TXT file and deliver it to the innovaphone support.

Make sure the trace files contains the trap information. In contrast to a normal text trace, a trap trace contains stack and other dump information at the end of the trace:

12r3 sr45 IP123[12.3456], Bootcode[12345], Hardware[123]
IP123-12-34-56
Uptime 0d 0h 1m 23s

...

0:0498:966:2 - AC-DSP0: headset_detach - already detached
0:0498:966:2 - AC-DSP0: update_dsp 4->4 0->0 0->0 1->1 0
0:0498:972:6 - PHONE_CALL.0 -> RING_CH.0 : CHANNEL_DISCONNECT
0:0498:972:7 - PHONE_DSP.0 -> AC_CH.0 : CHANNEL_UNPAUSE
0:0498:972:7 - phone_app: call_update 0001 SEND_CONNECT
0:0498:972:7 - PHONE_CALL.0 -> VOIP_CALL.2 : SIG_CONN faststart=0 channel=-1 cmd=SELECT cn=''
0:0498:973:2 - VOIP_CALL.2 -> H323_CALL.0 : event type = 0
0:0498:973:6 - PCAP NO-DATA
0:0498:974:0 - PCAP NO-DATA
0:0498:974:1 - PHONE_APP.0 -> PHONE_APP.0 : APP_DISP_FLUSH
0:0498:974:5 - PCAP NO-DATA
0:0498:975:2 - PCAP NO-DATA
0:0498:975:3 - PCAP NO-DATA
0:0498:981:3 - MEM-DELETE: obj at 0x87eb7388 inconsistent
0:0498:981:3 - HEXDUMP
87eb7288 - 88 73 eb 87 00 00 00 00 0d 00 00 00 c8 a3 79 80 .s............y.
...
87eb7468 - c0 00 00 00 00 00 00 00 5b 00 00 00 64 00 00 00 ........[...d...
87eb7478 - a8 00 00 00 b6 00 00 00 64 00 00 00 a8 00 00 00 ........d.......
0:0498:981:3 - Assertion failed line 1205 in common/os/os.cpp, MEM-OBJ
0:0498:981:3 - assert-ep 800047f4 called from 800af588
0:0498:981:3 - BUILD 121147 Uptime 0d 0h 8m 18s Local Time 01.06.17 14:57:20

0:0498:981:3 - 0: - 0 ticks=1146
0:0498:981:3 - 1: - 0 ticks=17300
0:0498:981:3 - 2: - 0 ticks=16828
0:0498:981:3 - 3: - 0 ticks=10994
0:0498:981:4 - 4: ETHIF6 306 ticks=30252
0:0498:981:4 - 5: - 0 ticks=1335680
0:0498:981:4 - 6: - 0 ticks=0
0:0498:981:4 - 7: - 0 ticks=0
0:0498:981:4 - 8: - 0 ticks=104458
0:0498:981:4 - 9: PHONE_APP 2100 ticks=605083
0:0498:981:4 - 10: - 0 ticks=0
0:0498:981:4 - 11: - 0 ticks=0
0:0498:981:4 - 12: - 0 ticks=0
0:0498:981:4 - 13: - 0 ticks=0

0:0498:981:4 - stack(87eb72a8):
0:0498:981:4 - HEXDUMP
87eb72a0 - 00000000 8000487c 8047fec0 87eb7358 ....|H....G.Xs..
87eb72b0 - 00000000 87eb7398 808c66a8 8079a23c .....s...f..<.y.
87eb72c0 - 87eb7388 800af588 00000000 00000001 .s..............
87eb72d0 - 80f4b760 00000004 00000088 802a220c `............"*.
...
87eb8290 - 00000000 00000000 00000000 00000000 ................

0:0498:982:6 - HALT
end of trace

reset-source=WATCHDOG(2)

BUILD: 121147

0: - 0
1: - 0
2: - 0
3: - 0
4: ETHIF6 306
5: - 0
6: - 0
7: - 0
8: - 0
9: PHONE_APP 2100
10: - 0
11: - 0
12: - 0
13: - 0

XCPT: no exception context present

ok

=== IPxx13 ===
On IPxx13 devices (IP6013 & IP0013) the trap trace is additionally stored in flash. Up to 5 dumps are kept and survive a reboot or firmware update; the oldest are discarded when space is needed.
;<code>!mod cmd CPU crash-list</code>: Lists the stored trap traces, <code>[n]</code> is the reference number (use it as shown, numbers are not consecutive).
;<code>!mod cmd CPU crash-load n</code>: Shows the respective trace. If <code>n</code> is not specified, the most recent one is shown.

=== Reset-Sources ===
;<code>PWR-ON(0)</code>: device was re-powered (no trap)
;<code>WATCHDOG(2)</code>: device was restarted by the watchdog (trap)
;<code>COMMAND(3)</code>: device was reset using the admin ui or update script (no trap)

== Related Articles ==
*[[Reference9:Maintenance/Diagnostics/Tracing]]
*[[Reference12r1:Concept Innovaphone Virtual Appliance#Troubleshooting]]
*[[Reference:Device Health Check]]
*[[Howto:Monitor device uptime and gather traces with trap information via automated script]]
*[[Reference9:Event/0x000b0001]]

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

Understanding the innovaphone trouble ticket status page

2026-07-10T15:43:08Z

Sga: /* More Information */

This page will give you an overview of all the tickets you have opened with innovaphone. The issues will be ordered by project and status.
==Applies To==
The innovaphone ticket system used for a number of services, including support, presales, [[RMA]] and more.
==More Information==

===Background===
Access to the current case history is available from https://portal.innovaphone.com under ''Licences tab and then Tickets tab''.

===Information available===
You cannot get at all the communications regarding these issues via this page. Communication solely takes place via email. ''If you lost track of an issue or have no clue what it is all about, you are invited to simply send an email (use the '''ID''' link for that) to innovaphone''. It will be associated to the issues conversation trail and someone will contact you to clarify.

The columns and their meaning:

{| border=1
|-
| Close? || Allows to resolve/close an issue (see below)
|-
| <code>ID</code> || The trouble ticket number.
|-
| <code>Customer Project</code> || The name of the project the ticket is associated with (if any). This is what you have set using the @customer directive.
|-
| <code>Summary</code> || The title of the issue (usually the subject you provided when reporting the issue)
|-
| <code>Fileupload</code> || This links to a page where you can upload additional files to your case
|-
| <code>History</code> || This links to a page which shows the entire conversation associated with the issue (note that you might not see all of the notes though).
Please note that you will - for security reasons - not have access to any attachments. If you need to retrieve an attachment previously sent or received, send a note and ask for it.
|-
| <code>Level</code> || The support level assigned to the issue. This is one of
{|
| <code>none</code> || No specific level. The requester is probably not eligible for support
|-
| <code>normal</code> ||
|-
| <code>preferred</code> || Premium level. Probably because the requestor is considered as an ''A-Partner''
|-
| <code>escalation</code> || Highest level, probably because of a problem that requires immediate attention
|}
|-
| <code>Owner</code> || The techserv person handling the issue (that is, the person with overall support responsibility, as opposed to the person currently working on it)
|-
| <code>Status</code>
| The current status of this issue (set by innovaphone personnel). The following states are defined:
{|
| <code>assigned</code> || The ticket is assigned to innovaphone personnel and the ball is with us
|-
| <code>feedback</code> || Someone requested your feedback regarding this ticket and the ball is with you. Please respond (using the ID link e.g.)
|-
| <code>postponed</code> || The ticket is not being worked on currently (regardless of the priority set)
|-
| <code>closed</code>|| The ticket is closed, or we have not received any further feedback (See: [[How to post a successful Mantis Request|Understanding the state "closed"]])
|}
|-
|<code>Changes</code>
|Number of changes to this issue so far. This figure is bold if the issue had been touched during the last 36 hours
|-
|<code>Assigned To</code>
|The person currently working on the issue
|-
|<code>Priority</code>
|The following priorities are defined
{|
| <code>normal</code> || The ticket is being processed regularly
|-
| <code>high</code> || The ticket is considered more important than the average
|-
| <code>urgent</code> || The ticket is one of the next issues taken
|-
| <code>immediate</code> || The ticket is being worked on right now
|}
This is the real-time working priority currently associated with this issues for the next step. For overall priority, see <code>Level</code>.
|-
|<code>Date Submitted</code>
|The date the ticket was created
|-
|<code>Updated</code>
|The most recent date the ticket has been changed
|}

=== Hints ===

Please note that we expect your feedback regarding all the issues marked as <code>feedback</code>. If you do not respond, the ticket will likely be closed soon with no further action.

If you feel that an ''issue is already resolved, although'' it appears in this list, then you are kindly requested to close it using the [[Image:Understanding the innovaphone trouble ticket status page - Resolved.jpg]] or [[Image:Understanding_the_innovaphone_trouble_ticket_status_page_-_Close_Icon.jpg]] icon.

To submit any information regarding an issue (e.g. providing requested feedback), you may use the <code>ID</code> link.

== Related Articles ==

* [[How to post a successful Mantis Request]]
* [[Reference:My Innovaphone#Mantis]]

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

Reference:IP73 WLAN WiFi Wireless IP-Phone

2026-04-30T11:55:08Z

Sga: /* Packet loss and voice quality issues with non-tested WLAN AP and IP73 */

This article describes the IP73 WLAN/WiFi wireless IP phone, differences to the deprecated IP62 Wireless IP phone and a list of compatible WLAN infrastructures.

==Applies To==
This information applies to:
*innovaphone IP73 (50-00073-001)

==Requirements==

To perform configuration changes on the IP73 device a desktop programming kit (IP62/IP64/IP65/IP73) (Art.No. 50-00060-021 / Prod.ID DP1-UAAA/1A1) is required. The programming kit enables to connect the IP73 handset to a PC in order the configuration changes can be done using WinPDM software.

==Feature Comparison==
This chapter describes the differences in the feature sets between old and new WiFi handsets.

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ Handset Features Matrix
! Feature !! IP62 !! IP73 !! Description
|-
| Signaling Protocols || H.323/SIP || SIP only ||
|-
| Codecs || G.711, G.722, G.729 A || Opus Wideband, G.711, G.722, G.729 A/B/AB ||
|-
| Talk Time/ Standby Time || 15 h / 100 h || 10 h / 100 h || with U-APSD
|-
| WiFi Standards || 802.11 a/b/g/n || 802.11 a/b/g/n/ac, 802.11r, 802.11k || MCS 0-7 only, Fast BSS Transition (FT or 802.11r)
|-
| SSL Certificates || customer managed || preinstalled by innovaphone/customer managed ||
|-
| call diversion || ok || only with DTMF ||
|-
| Headset Connector || 2,5 mm || 3,5 mm ||
|}

As of firmware version 4.0.0, the connection of a central telephone book via LDAP is supported. For configuration to be carried out refer to the [[#Central Phonebook Access|corresponding section below]].

==WLAN Infrastructure Compatibility==

===Certified WLAN Platforms===
'''IMPORTANT''': Ask [mailto:presales_AT_innovaphone_D0T_com innovaphone Presales Team] for possible interop configuration recommendations and pitfalls before you order the WiFi equipment and start with the roll-out.

Note that availability and combinations of controllers and access points may be subject to change by the manufacturer and are not in the responsability of innovaphone. Errors and omissions excepted.

Wi-Fi infrastructures not listed in this document are not supported. Use of the IP73 in unsupported infrastructures is at your own risk.

{| class="wikitable"
|+Certified WLAN Platforms as of March 2026
!AP Model
!Controller Model
!SW Version
!Test date
!Report
|-
! colspan="5" |Aruba
|-
|AP 303, 304, 305, 314, 315, 324, 325, 334, 335, 344, 345, 504, 505, 514, 515, 534, 535, 554, 555, 635, 655
|7000/7200/9000/MX-VA-xxx
|8.10.0.13 LSR
|09-Sep-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_aruba_networking_8_10_0_13.pdf}}]]
|-
|AP 303, 304, 305, 314, 315, 324, 325, 334, 335, 344, 345, 504, 505, 514, 515, 534, 535, 554, 555, 635, 655
|Networking Central
|10.4.1.3_90100
|12-Aug-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_aruba_networking_central_10_4_1_3.pdf}}]]
|-
! colspan="5" |Cisco
|-
|AP 1832, 1852, 2802, 3802, 4800, 9105, 9115, 9117, 9120, 9130
|WLC 3504, 5520, 8540, vWLC, Mobility Express Solution
|8.10.162
|04-Feb-2022
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_wlc_8_10_162.pdf}}]]
|-
|AP 1602, 2602, 3502, 3602, 1702, 2702, 3700, 2802, 3802, 1832, 1852
|WLC 2504, 3504, 5508, 5520, 7510, 8510, 8540, vWLC
|8.5.182
|14-Feb-2022
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_wlc_8_5_182.pdf}}]]
|-
|AP 1702, 2702, 3702
|Catalyst 9800
|17.3.3
|01-Jun-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_catalyst_17_3_3.pdf}}]]
|-
|AP 1832, 1852, 2802, 3802, 4800, 9115, 9117, 9120, 9130, 9136
|Catalyst 9800
|17.9.3
|20-Jun-2022
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_catalyst_17_9_3.pdf}}]]
|-
! colspan="5" |Cisco Meraki
|-
|MR20/MR30H/MR33/MR42/MR42E/MR52/MR53/MR53E/MR70/MR74/MR84 (802.11ac wave 2)
MR36/MR44/MR46/MR46E/MR76/MR86 (802.11ax)
| -
|MR 27.7.1
|29-Sept-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_meraki_mr_27_7_1.pdf}}]]
|-
|MR36/MR44/MR46/MR46E/MR76/MR86 (802.11ax)
CW9162/CW9163E/CW9164/CW9166/CW9166D1 (Wifi 6E)
| -
|MR 30.7
|Nov-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_meraki_mr_30_7.pdf}}]]
|-
! colspan="5" |Extreme Networks (Enterasys/IdentiFi)
|-
|AP 3801, 3805, 3825, 3865, 3935
|Extreme Wireless C25, C35, C2110, C5110, C5210, v2110
|AP:10.51.10
|03-Feb-2020
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_wireless_10_51_10.pdf}}]]
|-
|AP 122, 130, 230, 250, 550, 650
|Extreme Cloud
|AP 10.0r8, Cloud 20.1.1.3
|19-Mar-2020
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_cloud_10_0r8.pdf}}]]
|-
|AP 310i/e, 410i/e, 505i/e, 510i/e, 360i/e, 460i/e, 560
|XCC Controllers E1120, E2120, E3120, VE6120/VE6125, VE6120H
|05.16.01.0025
|10-Dec-2020
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_xcc_05_16_01_0025.pdf}}]]
|-
|AP305c/cx, 410c, 460c, 510c/cx, 650
|Extreme Cloud C25, C35, C2110, C5110, C5210, v2110
|AP 10.2.4.0, Cloud 20.1.1.3
|20-Jan-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_cloud_10_2_4_0.pdf}}]]
|-
|AP310i/e, 410i/e, 460i/e, 510i/e, 650i
|Extreme WING NX 5500, 75xx, 9500, 9510, 9600, 9610, VX9000
|7.5.2.0
|12-Apr-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_wing_7_5_2_0.pdf}}]]
|-
|AP 305c/305cx, 410c, 460c, 510c/510cx, 650/650x, 4000, 5010
|Extreme Cloud iQ
|AP 10.8.3.0, Cloud 25.4.3-40
|Aug-2025
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_cloud_10_8_3_0.pdf}}]]
|-
! colspan="5" |Fortinet
|-
|AP1010/1014/1020/822/832, APU221EV/U223EV/U321EV/U323EV/U421EV/U423EV
|MC1550/3x00/4x00/5000/6000 FortiWLC-50D ,200D, 500D, 1000D, 3000D FWC- VM-50, 200, 500, 1000, 3000
|8.5-2-5
|03-Jun-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_fortinet_wlc_8_5_2_5.pdf}}]]
|-
! colspan="5" |Huawei
|-
|AirEngine5760-51/5760-22W/6760-X1/6760-X1E/6760R-51/6760R-51E/8760-X1-PRO/8760R-X1/8760R-X1E
|AirEngine 9700-M1, AC6508/6805/6800V, iMaster NCE-Campus
|V200R022C10SPC100
|10-May-2023
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_huawei_airengine_V200R022C10SPC100.pdf}}]]
|-
! colspan="5" |Juniper Mist
|-
|AP34, AP45
|Mist Cloud
|0.12.26354
|Aug-2023
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_juniper_0_12_26354.pdf}}]]
|-
|AP12, AP32, AP33, AP41, AP 43, AP61, AP 63
|Mist Cloud
|0.12.27139
|Feb-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_juniper_0_12_27139.pdf}}]]
|-
! colspan="5" |Ruckus
|-
|SmartZone ZoneFlex R300, R310, T300, T310, R500, R510, H510, R600, R610, R710, R720
|SmartZone platform, vSZ-(H,E,D), SZ100/300
|5.2.0.0.699
|27-Apr-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_ruckus_smartzone_5_2_0_0.pdf}}]]
|-
|SmartZone ZoneFlex R350, R350e, T350, R550, R650, R750, T750, R850, R500, R510, R610, R710, R720
|SmartZone platform, vSZ-(H,E,D), SZ144/300
|6.1.2.0.404
|29-Apr-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_ruckus_smartzone_6_1_2_0.pdf}}]]
|}

=== DAS Compatibility ===
[http://en.wikipedia.org/wiki/Distributed_antenna_system Distributed Antenna Systems (DAS)] provide a cost-effective solution for extending radio coverage inside large facilities. Simply put, a DAS can be seen as a long cable starting at a base station or access point to which many antennas are connected. While the architecture can be utilized to mitigate certain coverage issues, the innovaphone IP73 was not designed to accommodate for such RF environments. Furthermore it is difficult to ascertain and ensure WLAN reliability in regard to interference, capacity, roaming, location-based services, and some important [http://en.wikipedia.org/wiki/IEEE_802.11n 802.11n] features, such as [http://en.wikipedia.org/wiki/Multiple-input_multiple-output MIMO]. As a consequence thereof, innovaphone will not endorse nor provide RF support for WiFi deployments over any Distributed Antenna System.

=== WPA3 Compatibility ===
The IP73 already supports the configuration option for ''WPA3''. However, this should not yet be actively used. 
''WPA3'' is currently only recommended for demo purposes. Support for ''WPA3'' is implemented, but no successful interoperability tests have been performed. WPA3 is not recommended being used except for demo purposes.

=== U-APSD Required ===
U-APSD is a power saving function that is always enabled on the IP73. It must also be enabled/supported on the AP to avoid packet loss/voice problems.

==Configuration==
IP73 configuration is done via WinPDM-application available at [https://store.innovaphone.com the Software section of the innovaphone App Store]. Use of desktop programming kit (IP62/IP64/IP65) (50-00060-021) is required.

=== Security ===
From version 7.x onwards, the IP73 firmware includes several changes to achieve compliance with the EU Radio Equipment Directive (RED) and the Cybersecurity Delegated Act.

This requires some additional configuration changes to get the handset operational:

====New handset initial configuration====
{{IP73_703_WinPDM_Auth}}

Resolution is to enter the [[#Shortcuts|default admin access code]] and afterwards to either disable WinPDM Authentication or change the Admin access code:

[[Image:IP73 703 WinPDMAuth.png|ip73_703_winpdmauth.png/]]

====Configuration changes for PBX connection====
For handsets running firmware 7.x, the following settings must be configured via WinPDM in order to enable a PBX connection:
* Unite connection mode must be set to another value than ‘Automatic’ at [Device/Unite/Connection mode].
* Admin access code must be set at [Device/General/Admin access code]. 5 - 10 characters required.
* Phone lock code must be set at [Device/Settings/Force phone lock]. 4 - 8 characters required. By setting the phone lock code the phone lock will be applied for every subsequent bootup. Phone lock is enforced on by default but can be turned off by parameter [Device/Settings/Force phone lock] or by admin menu in handset GUI. Note that handset does not comply with RED by turning off forced phone lock!
* Security has also been strengthen by disabling some outdated security protocols by default. If a service is no longer working after upgrade try to use more modern cryptographic protocol or set parameter “<service>/Allow outdated security protocols” to ‘Yes’.

===PBX Registration===
====Authentication via client certificate====
The recommended way to register an IP73 handset at the innovaphone PBX is SIP over TLS with authentication by a client certificate. The IP73 handset is delivered with a preinstalled device certificate already trusted by an innovaphone PBX.

Prerequisites on the PBX for such type of authentication are:

*The issuer of the IP73 client certificate is on the Trust List of the PBX gateway
*The CN of the client certificate used by IP73 equals the MAC address of the IP73 itself (alternatively other CN and registration identity can be used)
*User Object contains a Device with a Hardware Id matching the MAC address of the IP73

On the IP73 following settings must be configured:
*VoIP->SIP
**SIP TLS client certificate: <select certificate with MAC address as CN> or <Automatic if preinstalled certificate is used>
**SIP Transport: TLS
**Primary SIP proxy: <IP-address of the PBX> or <DNS-name of PBX>
**SIP proxy ID: <PBX system name>
**SIP proxy password: <no password is required>
**Registration and Authentication identity: MAC address

====Authentication via username/hardware id and password====
*VoIP->General->Endpoint ID: username or hardware id on User Object
*VoIP->SIP
**SIP Transport: TCP or UDP
**SIP proxy password: <password on the User Object or PBX System password, depending on Users Device configuration>
**Registration and Authentication identity: Endpoint ID

=== ICE/TURN ===
ICE is enabled by default. It is required to provide STUN and TURN server configuration under VoIP->General to secure correct negotiation of media channels.

=== Factory Reset ===
You can use the local ''Admin menu'' on the Phone or the WinPDM Software (Rightclick on the device) to make a Factory Reset.

=== MWI for IP73===
The IP73 can be configured to display a message waiting indication / MWI.
You need a programming shell and the WinPDM software (available for download in our [https://store.innovaphone.com/release/141A000/download.htm Store] under the Software tab).
*Connect programming cradle to the administration PC
*Install WinPDM and start the application
*Place IP73 into the programming cradle
*If the IP73 is recognized in WinPDM, the parameter settings can be opened by switching to the Numbers tab (1)
*select the respective device type (2 -> WH2 = IP73) and double-clicking the device line (3).
*Select menu Device (4) and step to Message Centre (5)
*Insert the number of the voicemail object for the Message Centre Number (6)
*Insert the user number for the voice mail number (7)
Confirm settings with OK and ensure correct synchronisation of config changes to the handset. Reset of handset is recommended.

[[Image:WIFIMwi.PNG|wifimwi.png/]]

===Central Phonebook Access===
The device offers access to a central LDAP-based directory. Following configuration steps have to be carried out by the administrator:

'''Device Configuration via the WinPDM application'''
* Device has to be plugged into programming cradle and edited via WinPDM
* Device has to be operated with at least firmware '''6.1.13''' available at the [https://store.innovaphone.com innovaphone store].
* Open section Device and step to Central phonebook. Change the central phonebook mode to LDAP and enter the appropriate parameters for the ldap directory to be queried.

For innovaphone PBX query, the following settings and attributes can be used and adapted to the PBX setup.

[[image:IP73_PBX_query.png|ip73_pbx_query.png/]]

In case of using LDAP-secure-queries, upload of the LDAP-server-'''ROOT''' certificate to the IP73 trust list is required:

[[image:IP73_Certificate.png|ip73_certificate.png/]]

==Troubleshooting==
Log Options can be configured in the WinPDM software, under Device->Log.

===Remote PCAP Tracing===
You can activate the remote PCAP interface and Trace flags directly in the phone configuration (Admin Menu :: Logging :: Mode) or via WinPDM under Device->Log->PCAP capturing: RPCAP.

Only IP traces are available via RPCAP, no innovaphone or device internal traces are logged.

===PCAP to file via USB Tracing===
It is possible to store PCAP trace file in the ''pcap'' folder on the handset by setting in the phone configuration (Admin Menu :: Logging :: Mode) or via WinPDM under Device->Log->PCAP capturing the option "PCAP to file".

To access the file set Device -> General -> USB behavior to "Ask" and select "File transfer", when connect the handset to the WinPDM. Navigate to the folder ''pcap'' on the ''Handset diagnostics'' drive.

===Trace Options===
Following additional trace options are available:

*WLAN Trace
*Configuration Trace
*GUI Trace
*GLI Trace
*Unite Trace
*VoIP Trace
*System Trace
*Protector Trace
*SaS Trace
*Bluetooth Trace

The resulting traces are available via USB file transfer and are encrypted. The encrypted log files can be encrypted by support only.

===Logging via Syslog, SFTP or logfile===

The handset can be configured to send Syslog messages to a Syslog server, an SFTP server or to a local logfile located in the folder ''tracelog''.

The configuration is available via WinPDM Device -> Log -> Syslog or SFTP.

===Handset Error Messages===

====No network====
The ''No network'' message indicates missing WLAN connection. It can be caused by wrong settings for SSID, Security, reg. domain and WLAN channels or lack of coverage.

====No access====
The ''No access'' message is caused by missing IP connectivity to the PBX or wrong configuration for authentication at the PBX.

== Shortcuts ==
There are some hidden tools for information and analysis, which can be accessed via specific menus and codes:

;Handset Device Information
:''*#34#'' in the main display

;RSSI Indicator
:''*#76#'' in the main display. Type again to exit.
: Here you find the following information in the display:
:* Line 1: SSID
:* Line 2: Current AP
:* Line 3: Current AP MAC
:* Line 4: Previous AP
:* Line 5: Previous AP MAC

;Site Survey Tool
:''*#77#'' in the main display.

;Admin Menu
: Go to the ''Settings menu'' and type in ''40022''

==Known Problems==

===Packet loss and voice quality issues with non-tested WLAN AP and IP73===

'''Issuer: Ascom'''

'''Published: 2022-12-07'''

'''Background''' 
It has come to our (Ascom) knowledge that in later Aruba software versions than Ascom-certified v.8.7.1.1 there is a critical issue affecting clients using power save (U-APSD). 
Data packets will not be transmitted properly to clients in power save.

'''Affected Ascom Certified Aruba Access Points:''' 
7000/7200/9000/MX-VA-xxx Controllers 
AP-303, 304, 305, 314, 315, 324, 325, 334, 335, 344, 345, 
504, 505, 514, 515, 534, 535, 554, 555, 635 

'''Typical symptoms are:''' 
Poor voice quality issues. 

'''Workaround''' 
Currently none available. Disabling U-APSD on the SSID isn’t a viable workaround as this is a requirement for Ascom i63 handsets in enterprise-grade VoWi-Fi deployments. 
Thus it is strongly recommended to avoid upgrades to v. 8.9.x and higher at this point. 

'''Solution''' 
Update Aruba equipment to ArubaOS-8.10.0.11, see [https://arubanetworking.hpe.com/techdocs/ArubaOS-8.x-Books/Release-Notes/810/ArubaOS-8.10.0.11-Release-Notes.pdf Aruba Release notes (search for Ascom)] for details.

===Bluetooth automatically disabled===

'''Issuer: Ascom''' 

'''Version''' 
Handset Firmware 4.0.6

'''Detailed Information''' 
If you have enabled Bluetooth over WinPDM and you want to configure (establish connection to the headset), you get the message "Bluetooth automatically disabled".

'''Background''' 
The chip responsible for handling wireless radio communication, WLAN and BT, has a bug in its current firmware. Thus, using WLAN and BT on similar frequency bands does not work well.

'''Solution/Workaround''' 
Bluetooth is prohibited to be used when WLAN band 2.4 is in use by being automatically disabled. Bluetooth can only be used when WLAN on the 2.4 GHz band is inactive. 
You can disable WLAN 2.4 band over the WinPDM tool.

==Related Articles==
*[[IP73 Technical Data EN]]
*[[Reference:IP62 WLAN WiFi Wireless IP-Phone]]

Reference:IP73 WLAN WiFi Wireless IP-Phone

2026-04-30T11:54:33Z

Sga: /* Packet loss and voice quality issues with non-tested WLAN AP and IP73 */

This article describes the IP73 WLAN/WiFi wireless IP phone, differences to the deprecated IP62 Wireless IP phone and a list of compatible WLAN infrastructures.

==Applies To==
This information applies to:
*innovaphone IP73 (50-00073-001)

==Requirements==

To perform configuration changes on the IP73 device a desktop programming kit (IP62/IP64/IP65/IP73) (Art.No. 50-00060-021 / Prod.ID DP1-UAAA/1A1) is required. The programming kit enables to connect the IP73 handset to a PC in order the configuration changes can be done using WinPDM software.

==Feature Comparison==
This chapter describes the differences in the feature sets between old and new WiFi handsets.

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ Handset Features Matrix
! Feature !! IP62 !! IP73 !! Description
|-
| Signaling Protocols || H.323/SIP || SIP only ||
|-
| Codecs || G.711, G.722, G.729 A || Opus Wideband, G.711, G.722, G.729 A/B/AB ||
|-
| Talk Time/ Standby Time || 15 h / 100 h || 10 h / 100 h || with U-APSD
|-
| WiFi Standards || 802.11 a/b/g/n || 802.11 a/b/g/n/ac, 802.11r, 802.11k || MCS 0-7 only, Fast BSS Transition (FT or 802.11r)
|-
| SSL Certificates || customer managed || preinstalled by innovaphone/customer managed ||
|-
| call diversion || ok || only with DTMF ||
|-
| Headset Connector || 2,5 mm || 3,5 mm ||
|}

As of firmware version 4.0.0, the connection of a central telephone book via LDAP is supported. For configuration to be carried out refer to the [[#Central Phonebook Access|corresponding section below]].

==WLAN Infrastructure Compatibility==

===Certified WLAN Platforms===
'''IMPORTANT''': Ask [mailto:presales_AT_innovaphone_D0T_com innovaphone Presales Team] for possible interop configuration recommendations and pitfalls before you order the WiFi equipment and start with the roll-out.

Note that availability and combinations of controllers and access points may be subject to change by the manufacturer and are not in the responsability of innovaphone. Errors and omissions excepted.

Wi-Fi infrastructures not listed in this document are not supported. Use of the IP73 in unsupported infrastructures is at your own risk.

{| class="wikitable"
|+Certified WLAN Platforms as of March 2026
!AP Model
!Controller Model
!SW Version
!Test date
!Report
|-
! colspan="5" |Aruba
|-
|AP 303, 304, 305, 314, 315, 324, 325, 334, 335, 344, 345, 504, 505, 514, 515, 534, 535, 554, 555, 635, 655
|7000/7200/9000/MX-VA-xxx
|8.10.0.13 LSR
|09-Sep-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_aruba_networking_8_10_0_13.pdf}}]]
|-
|AP 303, 304, 305, 314, 315, 324, 325, 334, 335, 344, 345, 504, 505, 514, 515, 534, 535, 554, 555, 635, 655
|Networking Central
|10.4.1.3_90100
|12-Aug-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_aruba_networking_central_10_4_1_3.pdf}}]]
|-
! colspan="5" |Cisco
|-
|AP 1832, 1852, 2802, 3802, 4800, 9105, 9115, 9117, 9120, 9130
|WLC 3504, 5520, 8540, vWLC, Mobility Express Solution
|8.10.162
|04-Feb-2022
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_wlc_8_10_162.pdf}}]]
|-
|AP 1602, 2602, 3502, 3602, 1702, 2702, 3700, 2802, 3802, 1832, 1852
|WLC 2504, 3504, 5508, 5520, 7510, 8510, 8540, vWLC
|8.5.182
|14-Feb-2022
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_wlc_8_5_182.pdf}}]]
|-
|AP 1702, 2702, 3702
|Catalyst 9800
|17.3.3
|01-Jun-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_catalyst_17_3_3.pdf}}]]
|-
|AP 1832, 1852, 2802, 3802, 4800, 9115, 9117, 9120, 9130, 9136
|Catalyst 9800
|17.9.3
|20-Jun-2022
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_cisco_catalyst_17_9_3.pdf}}]]
|-
! colspan="5" |Cisco Meraki
|-
|MR20/MR30H/MR33/MR42/MR42E/MR52/MR53/MR53E/MR70/MR74/MR84 (802.11ac wave 2)
MR36/MR44/MR46/MR46E/MR76/MR86 (802.11ax)
| -
|MR 27.7.1
|29-Sept-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_meraki_mr_27_7_1.pdf}}]]
|-
|MR36/MR44/MR46/MR46E/MR76/MR86 (802.11ax)
CW9162/CW9163E/CW9164/CW9166/CW9166D1 (Wifi 6E)
| -
|MR 30.7
|Nov-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_meraki_mr_30_7.pdf}}]]
|-
! colspan="5" |Extreme Networks (Enterasys/IdentiFi)
|-
|AP 3801, 3805, 3825, 3865, 3935
|Extreme Wireless C25, C35, C2110, C5110, C5210, v2110
|AP:10.51.10
|03-Feb-2020
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_wireless_10_51_10.pdf}}]]
|-
|AP 122, 130, 230, 250, 550, 650
|Extreme Cloud
|AP 10.0r8, Cloud 20.1.1.3
|19-Mar-2020
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_cloud_10_0r8.pdf}}]]
|-
|AP 310i/e, 410i/e, 505i/e, 510i/e, 360i/e, 460i/e, 560
|XCC Controllers E1120, E2120, E3120, VE6120/VE6125, VE6120H
|05.16.01.0025
|10-Dec-2020
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_xcc_05_16_01_0025.pdf}}]]
|-
|AP305c/cx, 410c, 460c, 510c/cx, 650
|Extreme Cloud C25, C35, C2110, C5110, C5210, v2110
|AP 10.2.4.0, Cloud 20.1.1.3
|20-Jan-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_cloud_10_2_4_0.pdf}}]]
|-
|AP310i/e, 410i/e, 460i/e, 510i/e, 650i
|Extreme WING NX 5500, 75xx, 9500, 9510, 9600, 9610, VX9000
|7.5.2.0
|12-Apr-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_wing_7_5_2_0.pdf}}]]
|-
|AP 305c/305cx, 410c, 460c, 510c/510cx, 650/650x, 4000, 5010
|Extreme Cloud iQ
|AP 10.8.3.0, Cloud 25.4.3-40
|Aug-2025
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_extreme_cloud_10_8_3_0.pdf}}]]
|-
! colspan="5" |Fortinet
|-
|AP1010/1014/1020/822/832, APU221EV/U223EV/U321EV/U323EV/U421EV/U423EV
|MC1550/3x00/4x00/5000/6000 FortiWLC-50D ,200D, 500D, 1000D, 3000D FWC- VM-50, 200, 500, 1000, 3000
|8.5-2-5
|03-Jun-2021
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_fortinet_wlc_8_5_2_5.pdf}}]]
|-
! colspan="5" |Huawei
|-
|AirEngine5760-51/5760-22W/6760-X1/6760-X1E/6760R-51/6760R-51E/8760-X1-PRO/8760R-X1/8760R-X1E
|AirEngine 9700-M1, AC6508/6805/6800V, iMaster NCE-Campus
|V200R022C10SPC100
|10-May-2023
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_huawei_airengine_V200R022C10SPC100.pdf}}]]
|-
! colspan="5" |Juniper Mist
|-
|AP34, AP45
|Mist Cloud
|0.12.26354
|Aug-2023
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_juniper_0_12_26354.pdf}}]]
|-
|AP12, AP32, AP33, AP41, AP 43, AP61, AP 63
|Mist Cloud
|0.12.27139
|Feb-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_juniper_0_12_27139.pdf}}]]
|-
! colspan="5" |Ruckus
|-
|SmartZone ZoneFlex R300, R310, T300, T310, R500, R510, H510, R600, R610, R710, R720
|SmartZone platform, vSZ-(H,E,D), SZ100/300
|5.2.0.0.699
|27-Apr-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_ruckus_smartzone_5_2_0_0.pdf}}]]
|-
|SmartZone ZoneFlex R350, R350e, T350, R550, R650, R750, T750, R850, R500, R510, R610, R710, R720
|SmartZone platform, vSZ-(H,E,D), SZ144/300
|6.1.2.0.404
|29-Apr-2024
|[[File:P2pdf.png|40px|link={{fullurl:Special:FilePath/i63_interop_ruckus_smartzone_6_1_2_0.pdf}}]]
|}

=== DAS Compatibility ===
[http://en.wikipedia.org/wiki/Distributed_antenna_system Distributed Antenna Systems (DAS)] provide a cost-effective solution for extending radio coverage inside large facilities. Simply put, a DAS can be seen as a long cable starting at a base station or access point to which many antennas are connected. While the architecture can be utilized to mitigate certain coverage issues, the innovaphone IP73 was not designed to accommodate for such RF environments. Furthermore it is difficult to ascertain and ensure WLAN reliability in regard to interference, capacity, roaming, location-based services, and some important [http://en.wikipedia.org/wiki/IEEE_802.11n 802.11n] features, such as [http://en.wikipedia.org/wiki/Multiple-input_multiple-output MIMO]. As a consequence thereof, innovaphone will not endorse nor provide RF support for WiFi deployments over any Distributed Antenna System.

=== WPA3 Compatibility ===
The IP73 already supports the configuration option for ''WPA3''. However, this should not yet be actively used. 
''WPA3'' is currently only recommended for demo purposes. Support for ''WPA3'' is implemented, but no successful interoperability tests have been performed. WPA3 is not recommended being used except for demo purposes.

=== U-APSD Required ===
U-APSD is a power saving function that is always enabled on the IP73. It must also be enabled/supported on the AP to avoid packet loss/voice problems.

==Configuration==
IP73 configuration is done via WinPDM-application available at [https://store.innovaphone.com the Software section of the innovaphone App Store]. Use of desktop programming kit (IP62/IP64/IP65) (50-00060-021) is required.

=== Security ===
From version 7.x onwards, the IP73 firmware includes several changes to achieve compliance with the EU Radio Equipment Directive (RED) and the Cybersecurity Delegated Act.

This requires some additional configuration changes to get the handset operational:

====New handset initial configuration====
{{IP73_703_WinPDM_Auth}}

Resolution is to enter the [[#Shortcuts|default admin access code]] and afterwards to either disable WinPDM Authentication or change the Admin access code:

[[Image:IP73 703 WinPDMAuth.png|ip73_703_winpdmauth.png/]]

====Configuration changes for PBX connection====
For handsets running firmware 7.x, the following settings must be configured via WinPDM in order to enable a PBX connection:
* Unite connection mode must be set to another value than ‘Automatic’ at [Device/Unite/Connection mode].
* Admin access code must be set at [Device/General/Admin access code]. 5 - 10 characters required.
* Phone lock code must be set at [Device/Settings/Force phone lock]. 4 - 8 characters required. By setting the phone lock code the phone lock will be applied for every subsequent bootup. Phone lock is enforced on by default but can be turned off by parameter [Device/Settings/Force phone lock] or by admin menu in handset GUI. Note that handset does not comply with RED by turning off forced phone lock!
* Security has also been strengthen by disabling some outdated security protocols by default. If a service is no longer working after upgrade try to use more modern cryptographic protocol or set parameter “<service>/Allow outdated security protocols” to ‘Yes’.

===PBX Registration===
====Authentication via client certificate====
The recommended way to register an IP73 handset at the innovaphone PBX is SIP over TLS with authentication by a client certificate. The IP73 handset is delivered with a preinstalled device certificate already trusted by an innovaphone PBX.

Prerequisites on the PBX for such type of authentication are:

*The issuer of the IP73 client certificate is on the Trust List of the PBX gateway
*The CN of the client certificate used by IP73 equals the MAC address of the IP73 itself (alternatively other CN and registration identity can be used)
*User Object contains a Device with a Hardware Id matching the MAC address of the IP73

On the IP73 following settings must be configured:
*VoIP->SIP
**SIP TLS client certificate: <select certificate with MAC address as CN> or <Automatic if preinstalled certificate is used>
**SIP Transport: TLS
**Primary SIP proxy: <IP-address of the PBX> or <DNS-name of PBX>
**SIP proxy ID: <PBX system name>
**SIP proxy password: <no password is required>
**Registration and Authentication identity: MAC address

====Authentication via username/hardware id and password====
*VoIP->General->Endpoint ID: username or hardware id on User Object
*VoIP->SIP
**SIP Transport: TCP or UDP
**SIP proxy password: <password on the User Object or PBX System password, depending on Users Device configuration>
**Registration and Authentication identity: Endpoint ID

=== ICE/TURN ===
ICE is enabled by default. It is required to provide STUN and TURN server configuration under VoIP->General to secure correct negotiation of media channels.

=== Factory Reset ===
You can use the local ''Admin menu'' on the Phone or the WinPDM Software (Rightclick on the device) to make a Factory Reset.

=== MWI for IP73===
The IP73 can be configured to display a message waiting indication / MWI.
You need a programming shell and the WinPDM software (available for download in our [https://store.innovaphone.com/release/141A000/download.htm Store] under the Software tab).
*Connect programming cradle to the administration PC
*Install WinPDM and start the application
*Place IP73 into the programming cradle
*If the IP73 is recognized in WinPDM, the parameter settings can be opened by switching to the Numbers tab (1)
*select the respective device type (2 -> WH2 = IP73) and double-clicking the device line (3).
*Select menu Device (4) and step to Message Centre (5)
*Insert the number of the voicemail object for the Message Centre Number (6)
*Insert the user number for the voice mail number (7)
Confirm settings with OK and ensure correct synchronisation of config changes to the handset. Reset of handset is recommended.

[[Image:WIFIMwi.PNG|wifimwi.png/]]

===Central Phonebook Access===
The device offers access to a central LDAP-based directory. Following configuration steps have to be carried out by the administrator:

'''Device Configuration via the WinPDM application'''
* Device has to be plugged into programming cradle and edited via WinPDM
* Device has to be operated with at least firmware '''6.1.13''' available at the [https://store.innovaphone.com innovaphone store].
* Open section Device and step to Central phonebook. Change the central phonebook mode to LDAP and enter the appropriate parameters for the ldap directory to be queried.

For innovaphone PBX query, the following settings and attributes can be used and adapted to the PBX setup.

[[image:IP73_PBX_query.png|ip73_pbx_query.png/]]

In case of using LDAP-secure-queries, upload of the LDAP-server-'''ROOT''' certificate to the IP73 trust list is required:

[[image:IP73_Certificate.png|ip73_certificate.png/]]

==Troubleshooting==
Log Options can be configured in the WinPDM software, under Device->Log.

===Remote PCAP Tracing===
You can activate the remote PCAP interface and Trace flags directly in the phone configuration (Admin Menu :: Logging :: Mode) or via WinPDM under Device->Log->PCAP capturing: RPCAP.

Only IP traces are available via RPCAP, no innovaphone or device internal traces are logged.

===PCAP to file via USB Tracing===
It is possible to store PCAP trace file in the ''pcap'' folder on the handset by setting in the phone configuration (Admin Menu :: Logging :: Mode) or via WinPDM under Device->Log->PCAP capturing the option "PCAP to file".

To access the file set Device -> General -> USB behavior to "Ask" and select "File transfer", when connect the handset to the WinPDM. Navigate to the folder ''pcap'' on the ''Handset diagnostics'' drive.

===Trace Options===
Following additional trace options are available:

*WLAN Trace
*Configuration Trace
*GUI Trace
*GLI Trace
*Unite Trace
*VoIP Trace
*System Trace
*Protector Trace
*SaS Trace
*Bluetooth Trace

The resulting traces are available via USB file transfer and are encrypted. The encrypted log files can be encrypted by support only.

===Logging via Syslog, SFTP or logfile===

The handset can be configured to send Syslog messages to a Syslog server, an SFTP server or to a local logfile located in the folder ''tracelog''.

The configuration is available via WinPDM Device -> Log -> Syslog or SFTP.

===Handset Error Messages===

====No network====
The ''No network'' message indicates missing WLAN connection. It can be caused by wrong settings for SSID, Security, reg. domain and WLAN channels or lack of coverage.

====No access====
The ''No access'' message is caused by missing IP connectivity to the PBX or wrong configuration for authentication at the PBX.

== Shortcuts ==
There are some hidden tools for information and analysis, which can be accessed via specific menus and codes:

;Handset Device Information
:''*#34#'' in the main display

;RSSI Indicator
:''*#76#'' in the main display. Type again to exit.
: Here you find the following information in the display:
:* Line 1: SSID
:* Line 2: Current AP
:* Line 3: Current AP MAC
:* Line 4: Previous AP
:* Line 5: Previous AP MAC

;Site Survey Tool
:''*#77#'' in the main display.

;Admin Menu
: Go to the ''Settings menu'' and type in ''40022''

==Known Problems==

===Packet loss and voice quality issues with non-tested WLAN AP and IP73===

'''Issuer: Ascom'''

'''Published: 2022-12-07'''

'''Background''' 
It has come to our (Ascom) knowledge that in later Aruba software versions than Ascom-certified v.8.7.1.1 there is a critical issue affecting clients using power save (U-APSD). 
Data packets will not be transmitted properly to clients in power save.

'''Affected Ascom Certified Aruba Access Points:''' 
7000/7200/9000/MX-VA-xxx Controllers 
AP-303, 304, 305, 314, 315, 324, 325, 334, 335, 344, 345, 
504, 505, 514, 515, 534, 535, 554, 555, 635 

'''Typical symptoms are:''' 
Poor voice quality issues. 

'''Workaround''' 
Currently none available. Disabling U-APSD on the SSID isn’t a viable workaround as this is a requirement for Ascom i63 handsets in enterprise-grade VoWi-Fi deployments. 
Thus it is strongly recommended to avoid upgrades to v. 8.9.x and higher at this point. 

'''Solution''' 
Update Aruba equipment to ArubaOS-8.10.0.11, see [[https://arubanetworking.hpe.com/techdocs/ArubaOS-8.x-Books/Release-Notes/810/ArubaOS-8.10.0.11-Release-Notes.pdf Aruba Release notes (search for Ascom)]] for details.

===Bluetooth automatically disabled===

'''Issuer: Ascom''' 

'''Version''' 
Handset Firmware 4.0.6

'''Detailed Information''' 
If you have enabled Bluetooth over WinPDM and you want to configure (establish connection to the headset), you get the message "Bluetooth automatically disabled".

'''Background''' 
The chip responsible for handling wireless radio communication, WLAN and BT, has a bug in its current firmware. Thus, using WLAN and BT on similar frequency bands does not work well.

'''Solution/Workaround''' 
Bluetooth is prohibited to be used when WLAN band 2.4 is in use by being automatically disabled. Bluetooth can only be used when WLAN on the 2.4 GHz band is inactive. 
You can disable WLAN 2.4 band over the WinPDM tool.

==Related Articles==
*[[IP73 Technical Data EN]]
*[[Reference:IP62 WLAN WiFi Wireless IP-Phone]]

Howto14r2:Step-by-Step Distribute a custom device certificate

2026-04-28T14:17:29Z

Sga: /* Known issues */

[[Category:Step-by-Step|Distribute a custom device certificate]]

{{HOWTOMOD13r3 Translation Info}}

This article describes a method to roll out a custom certificate to innovaphone devices.

[[image:device-certificate-overview.png]]

== Purpose ==
Some customers run their own public key infrastructure (PKI) and want to use their own certificate (eg a wildcard certificate like *.company.com). This way you can distribute this certificate to all innovaphone devices.

=== Features ===
* A convenient way to distribute a custom device certificate
* Reboot is not necessary

=== Limitations ===
* The length of the public key should not exceed 2048 bits. This is to limit the CPU consumption on our devices, see [[:Reference11r1:Certificate_management|Certificate management]] for details.

== Requirements ==
* Devices App
* Innovaphone PBX
* Firmware should be at least v14r2sr4
* You need a complete certificate chain containing the private key. We recommend to use a PEM encoded Text file [[:Reference11r1:Certificate_management#Uploading_a_certificate_chain_together_with_the_private_key|as explained here.]]
* Wireshark

== Things to know before you begin ==
* The certificate device configuration in your Devices app only maintains your trust list. As a result it will not distribute the device certificate.
* The pre-installed certificate signed by the Inno-CA remains in the Flash when you upload a new certificate. If you delete the new certificate, the pre-installed certificate will reappear.

== Configuration ==
=== Create Expert configuration ===
* Open your ''Devices'' App->''<your Domain>''-''>Device Configuration''-''>Define device configuration''->''Expert''
* Assign a ''Description'' e.g Device certificate
* Assign the provisioning category to this device configuration that should receive the new device certificate

[[image:device-certificate-1.png]]
=== Get VARS ===
* Open your Wireshark
* Drag and drop the PEM file into your Wireshark
* Your Wireshark will only display a few packets

[[image:device-certificate-2.png]]
* Click on the first packet
* Do a right click on the section starting with Certificate
* Select Copy and then Copy as Hex stream
* Create a first line in your Expert configuration starting with ''vars create X509/CERTIFICATE/00000 pbln'' and paste the Hex stream from wireshark to the end of the line

[[image:device-certificate-3.png]]

* Then repeat the same procedure for each certificate in the certificate chain, but increase the index by 1. e.g. ''vars create X509/CERTIFICATE/00001''

[[image:device-certificate-4.png]]

The private key has to be copied as well.
* Open the last packet in Wireshark and select the BER section. Copy the section as Hex stream as well.
* Create a line ''vars create X509/KEY pbxln'' and paste the Hex stream from the BER packet to the end of the line.

[[image:device-certificate-5.png]]

If no '''BER''' section is available, open the '''PRIVATE KEY''' packet instead. 
Expand the '''PrivateKeyInfo''' structure and locate the entry '''privateKey'''. 
Copy this section as a '''Hex stream''' as well, and use it in the same way as described above.

=== Finish Expert configuration ===
* The last line in our script is: ''mod cmd X509 /servercert-update''
* In the end the expert configuration should look like this:

[[image:device-certificate-6.png]]

*As soon as you save the configuration, the device certificate will be pushed.

== Verification ==
Look at the Advanced UI of the device. You should see a new Device certificate on General/Certificates
== Known issues ==
===High CPU load ===
We only recommend to use a certificate that uses 2048 bit public key length.

===Certificate Key Format===
Certificate authorities may provide a certificate key in a format other than PKCS#1, such as PKCS#8. If you upload the certificate using the '' General/Certificates'' advanced UI, the firmware will convert it to the required PKCS#1 format. However, if you distribute the certificate key via variables, as shown here, you must distribute it in PKCS#1 format. To convert the key from one format to another, you can use a tool such as OpenSSL. Refer to the OpenSSL documentation to find the correct command. For example, converting a PKCS#8 to a PKCS#1 key can be done using the command <code>openssl rsa -in pkcs8.key -traditional -out pkcs1.key</code>

== Related Articles ==
*[[Courseware:IT_Advanced_-_09_Custom_certificates]]
*[[Reference11r1:Certificate_management]]

Howto16r1:Firmware Upgrade V15r1 V16r1

2026-04-28T13:45:09Z

Sga: /* Changes visible to the end customers */

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

* 16r1 introduces the feature of [[Reference16r1:Concept_Reconnect_Calls | Reconnect Calls for Seamless Handover & Roaming]]. As a result, users will receive visual (MyApps or phone display) and audio (in-band tone) notifications when an active call is reconnected.

== 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 Service Conference Scaler: [[Reference16r1:Concept_App_Service_Conference_Scaler]]
; 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:Apps/PbxManager/App myApps Transcriptions

2026-04-24T12:23:50Z

Sga:

With the transcription 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.

=== Transcriptions API ===

====== Remote Service URL ======
The URL to your transcription service. This could be your self-hosted service (e.g Faster-Whisper) or a commercial service like openAI or lemonfox (e.g. [https://api.openai.com/v1/audio/transcriptions https://eu-api.lemonfox.ai/v1/audio/transcriptions])

====== API key ======
If you're using a commercial service you'd probably need an API key to access. Put it here.

===== Model =====
Different service providers use different models. The openAI uses for example "whisper-1" others could be "Systran/faster-whisper-small"...

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Transcriptions|Reference16r1:Concept App Service Transcriptions]]

Reference16r1:Concept App Service Transcriptions

2026-04-24T12:23:10Z

Sga:

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

* innovaphone Transcription Service from version 16r1

== Overview ==

The Transcription Service converts audio input into text using automatic speech recognition (ASR) models. In terms of its concept, it is located between the client services that generate or capture audio data and the transcription backend that performs the actual speech-to-text processing.
These transcription backends can run either as a locally hosted AI service within the same environment or as an external service accessed through a compatible API.

The Transcription Service itself is responsible for managing sessions, handling parallel requests, and coordinating the data flow between clients and the selected backend. The external ASR model performs the actual transcription.

The service is designed to work with OpenAI-compatible APIs, enabling clients to freely choose their preferred backend provider.

== Licensing ==

In order to use the Transcriptions Service including the Transcriptions App the newly introduced UCC license is necessary.
== Installation ==
Go to the '''Settings App''' (formerly known as 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 '''"Transcriptions"''' and click on it
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) in order to refresh the list of the available colored AP plugin icons.
* Open the '''"AP transcriptions"''' plugin by clicking on it and select '''" + Add an App"''' afterwards. Then click on the '''"Transcriptions API"''' button.
* Enter a '''"Name"''' ''(used as display name / all character allowed)'' and the '''"SIP"''' ''(no space, no capital letters)''. ''e.g : Name: Transcriptions API, SIP: transcriptions-api''
* Enter the '''Remote service Url''' (Destination URL of the service provider)
* Enter the '''API Key''' (provided by the service provider)
* Enter the '''model name''' (must be supported by the configured provider)
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings. A green check mark will be shown to confirm that the configuration is good.

== How it works ==

*A client service that requires transcription initiates the process by sending a transcription request via a WebSocket connection.
* The transcription service creates a session, assigns a transcription ID, and returns a dedicated HTTP endpoint to the client.
* The client uploads the audio data to the transcription service using HTTP connections, targeting the provided endpoint.
* The transcription service forwards the received audio data to the configured ASR backend (for example, a Whisper-compatible API) over HTTP.
* The ASR backend performs the transcription and returns the result to the transcription service, which then forwards the outcome back to the client.

== Transcriptions Flow Overview ==
[[File:Screenshot 2026-01-29 161703.png|center|thumb|964x964px|alt=flow overview|Transciptions Flow Overview|Transciptions Flow Overview]]

== Transcriptions - App Service ==
The App Service implements an API to use a remote transcription provider (e.g. whisper).

It can be configured in the '''Settings App''' [[{{NAMESPACE}}:Apps/PbxManager/App_myApps_Transcriptions |Transcriptions plugin]].

* The '''Remote Service URL''' defines the target URL of the remote transcription provider.

* The '''API Key''' is required to access the selected backend and to authenticate with the remote provider.

* The '''Model''' defines which model the backend should use for transcription.

These parameters are stored as a configuration and are forwarded to the backend. At present, these values must be entered manually in the Settings plugin.

The service does not validate or confirm these values. It assumes that all the given values are correct and only uses them for communication with the backend. Since the users are able to choose their own providers, they are also responsible for selecting a fitting model and understanding the limitations of the models (such as supported Audio formats, size limits, etc.).

Furthermore, applications that require transcription functionality must explicitly consume the Transcription Service API and demonstrate this functionality in their own user interface, such as applied in the Conference Transcriptions app.

== Transcriptions App ==
The service also provides a user interface where audio files can be uploaded and transcribed directly.

Once the transcription is complete, a simple summary can be generated and exported as a PDF (basic version).

Audio files can be selected using the Choose audio file button. The transcription process and its results are displayed on the same screen.

Neither the uploaded audio data nor the generated transcription text is stored by the service.[[File:ReferenceConceptTranscriptionsAppServiceTranscriptionsApp.png|thumb|/ReferenceConceptTranscriptionsAppServiceTranscriptionsApp.png|Transcriptions App Review]]

== Troubleshooting ==

For troubleshooting the Transcriptions App Service, you need to activate the traceflags ''App'', ''Database and'' ''HTTP-Client'' in your Transcription App instance.

== Limitations ==

* Limitations such as maximum audio size, supported languages, or handling multilingual audio mainly depend on the selected model and provider and may vary based on the user’s provider choice.
* Differences in response structure can also occur. These responses are forwarded unchanged, since they may contain important metadata for the client, such as timestamps.
* The service does not validate the selected model. Choosing a suitable model is therefore the user’s responsibility.
* Transcriptions may contain misheard words or spelling inaccuracies, especially in cases of background noise or strong accents.

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.transcriptions/com.innovaphone.transcriptions.htm SDK Documentation - Transcriptions API]
* [[{{NAMESPACE}}:Apps/PbxManager/App_myApps_Transcriptions]]

Reference16r1:Concept App Service Conference Transcriptions

2026-04-24T12:18:17Z

Sga: /* Related Articles */

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

* innovaphone Conference Transciptions from version 16r1

== Overview ==
[[File:Reference16r1 Concept App Service Conference Transcriptions Softphone App.png|thumb|309x309px|reference16r1_concept_app_service_conference_transcriptions_softphone_app.png/|/Reference16r1_Concept_App_Service_Conference_Transcriptions_Softphone_App.png]]
The main goal of the Conference Transcriptions Service is to create video‑conference meeting summaries, which can be accessed in the Phone Apps.

To achieve this:
# Users can start a transcription of the conference audio by clicking the '''“Transcribe Conference”''' button in the Phone Apps.
#* This action makes the Conference Transcriptions service connect to the conference room.
#* It records the audio and creates audio files of approximately one minute in length.
#* It forwards these small audio files via the com.innovaphone.transcriptions API, offered by the Transcriptions Service ([[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]])
#* It receives the transcripts of these small files and stores them in the service database.
# If the user stops the transcription by clicking on the "'''Transcribe Conference'''" Button again
#* The Conference Transcriptions Service gathers the transcribed text from the database
#* It retrieves the prompt configured in the settings plugin [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions | ConferenceTranscriptions settings plugin]]
#* It sends the transcript together with the prompt to the Assistant App Service via the com.innovaphone.assistant API
#* It receives the meeting summary and stores that summary in the database of the service
# Users may start and stop transcriptions multiple times during a meeting. As long as users remain in the room, the service recognizes that the meeting is still the same for that room.
# After the meeting, users can find the AI‑generated meeting summary in the call list of their Phone Apps by clicking on the '''“i”''' button. 

== Licensing ==

In order to use the service you will need the newly introduced '''UCC license'''
== Installation ==
Go to the '''Settings App''' (fomerly known as 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 '''"Conference Transcriptions"''' and click on it.
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) in order to refresh the list of the available colored AP plugin icons.
* Open the '''"AP Conference Transcriptions"''' Plugin by clicking on it and click on '''" + Add an App"''' and then on the '''"Conference Transcriptions API"''' button.
* Enter a '''"Name"''' ''(used as display name / all character allowed)'' and the '''"SIP"''' ''(no space, no capital letters)''. ''e.g : Name: Conference Transcriptions API, SIP: conference-transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings. A green check mark will be shown to confirm that the configuration is good.

In order to make the service work properly, two supplemental services must be installed:

* the myApps Assistant which will summarize the transcript [[{{NAMESPACE}}:Concept App Service myApps Assistant | Concept App Service myApps Assistant]]
* the Transcriptions Service which establishes a connection to a remote transcription server [[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]]

== Conference Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Transcribes the audio of a conference room
* Stores the transcript in the database
* Creates and stores the summary of the transcript in the database

It can be configured in the '''Settings App''' [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions | ConferenceTranscriptions settings plugin]].

== Summary prompts ==
You may configure the prompt freely. Here are some propositions you may copy/paste into the corresponding field of the settings plugin:

'''1. General prompt'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

Summary: 
 
(2–4 sentences describing the purpose of the meeting and the main outcomes.)
 
 
Decisions:
 
 
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
Key Points:
 
 
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
Tasks:
 
 
<ul>
<li>Person (with sip e.g. @pso)— Task — Deadline (if mentioned)</li>

</ul>
 
 
Open Questions:
 
 
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

'''2. A more structured version:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<ul>
<li>Summary: </li>
<ul>

<li>Sentence 1</li>
<li>Sentence 2</li>
</ul>
 
 
<li>Decisions:</li>
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
<li>Key Points:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
<li>Tasks:</li>
<ul>
<li>Person — Task — Deadline (or “No deadline mentioned”)</li>

</ul>
 
 
<li>Open Questions:</li>
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>
</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.
Use a normal text style. No italic.

TRANSCRIPT:
</pre>

'''3. When meetings are used to take decisions:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<li>Results:</li>
<ul>
<li>Results 1</li>
<li>Results 2</li>

</ul>
 
 
<li>Miscellaneous:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

== Troubleshooting ==

For troubleshooting the Conference Transcirptions App Service, you need activate the traceflags ''App'', ''Database and'' ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.conference-transcriptions/com.innovaphone.conference-transcriptions.htm SDK Documentation - Conference Transcriptions API]
* [[{{NAMESPACE}}:Concept App Service myApps Assistant]]
* [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions]]

Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions

2026-04-24T12:17:46Z

Sga: /* Related Articles */

With the conference-transcription 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.

=== Conference Transcriptions API ===

====== Transcript auto deletion ======
Transcripts and summaries are stored in the database. You may choose to auto delete them after a certain time.

====== Summary prompt ======
At the end of a conference the transcript is send to the LLM you have chosen in order to create the summary. You may adapt the prompt to your liking. You may find examples [[{{NAMESPACE}}:Concept App Service Conference Transcriptions#Summary_prompts|here]]

===== LLM (Model) =====
The actual LLM (model) you intend to use. These are requested using the [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm local assistant JavaScript API] offered by the Assistant App Service. That model will create the summary using the defined prompt and the collected transcript

==Related Articles==
* [[{{NAMESPACE}}:Concept App Service Conference Transcriptions|Concept App Service Conference Transcriptions]]

Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions

2026-04-24T12:16:43Z

Sga:

Reference16r1:Concept App Service Conference Transcriptions

2026-04-24T12:16:06Z

Sga: /* Conference Transcriptions - App Service */

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

* innovaphone Conference Transciptions from version 16r1

== Overview ==
[[File:Reference16r1 Concept App Service Conference Transcriptions Softphone App.png|thumb|309x309px|reference16r1_concept_app_service_conference_transcriptions_softphone_app.png/|/Reference16r1_Concept_App_Service_Conference_Transcriptions_Softphone_App.png]]
The main goal of the Conference Transcriptions Service is to create video‑conference meeting summaries, which can be accessed in the Phone Apps.

To achieve this:
# Users can start a transcription of the conference audio by clicking the '''“Transcribe Conference”''' button in the Phone Apps.
#* This action makes the Conference Transcriptions service connect to the conference room.
#* It records the audio and creates audio files of approximately one minute in length.
#* It forwards these small audio files via the com.innovaphone.transcriptions API, offered by the Transcriptions Service ([[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]])
#* It receives the transcripts of these small files and stores them in the service database.
# If the user stops the transcription by clicking on the "'''Transcribe Conference'''" Button again
#* The Conference Transcriptions Service gathers the transcribed text from the database
#* It retrieves the prompt configured in the settings plugin [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions | ConferenceTranscriptions settings plugin]]
#* It sends the transcript together with the prompt to the Assistant App Service via the com.innovaphone.assistant API
#* It receives the meeting summary and stores that summary in the database of the service
# Users may start and stop transcriptions multiple times during a meeting. As long as users remain in the room, the service recognizes that the meeting is still the same for that room.
# After the meeting, users can find the AI‑generated meeting summary in the call list of their Phone Apps by clicking on the '''“i”''' button. 

== Licensing ==

In order to use the service you will need the newly introduced '''UCC license'''
== Installation ==
Go to the '''Settings App''' (fomerly known as 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 '''"Conference Transcriptions"''' and click on it.
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) in order to refresh the list of the available colored AP plugin icons.
* Open the '''"AP Conference Transcriptions"''' Plugin by clicking on it and click on '''" + Add an App"''' and then on the '''"Conference Transcriptions API"''' button.
* Enter a '''"Name"''' ''(used as display name / all character allowed)'' and the '''"SIP"''' ''(no space, no capital letters)''. ''e.g : Name: Conference Transcriptions API, SIP: conference-transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings. A green check mark will be shown to confirm that the configuration is good.

In order to make the service work properly, two supplemental services must be installed:

* the myApps Assistant which will summarize the transcript [[{{NAMESPACE}}:Concept App Service myApps Assistant | Concept App Service myApps Assistant]]
* the Transcriptions Service which establishes a connection to a remote transcription server [[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]]

== Conference Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Transcribes the audio of a conference room
* Stores the transcript in the database
* Creates and stores the summary of the transcript in the database

It can be configured in the '''Settings App''' [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions | ConferenceTranscriptions settings plugin]].

== Summary prompts ==
You may configure the prompt freely. Here are some propositions you may copy/paste into the corresponding field of the settings plugin:

'''1. General prompt'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

Summary: 
 
(2–4 sentences describing the purpose of the meeting and the main outcomes.)
 
 
Decisions:
 
 
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
Key Points:
 
 
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
Tasks:
 
 
<ul>
<li>Person (with sip e.g. @pso)— Task — Deadline (if mentioned)</li>

</ul>
 
 
Open Questions:
 
 
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

'''2. A more structured version:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<ul>
<li>Summary: </li>
<ul>

<li>Sentence 1</li>
<li>Sentence 2</li>
</ul>
 
 
<li>Decisions:</li>
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
<li>Key Points:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
<li>Tasks:</li>
<ul>
<li>Person — Task — Deadline (or “No deadline mentioned”)</li>

</ul>
 
 
<li>Open Questions:</li>
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>
</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.
Use a normal text style. No italic.

TRANSCRIPT:
</pre>

'''3. When meetings are used to take decisions:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<li>Results:</li>
<ul>
<li>Results 1</li>
<li>Results 2</li>

</ul>
 
 
<li>Miscellaneous:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

== Troubleshooting ==

For troubleshooting the Conference Transcirptions App Service, you need activate the traceflags ''App'', ''Database and'' ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.conference-transcriptions/com.innovaphone.conference-transcriptions.htm SDK Documentation - Conference Transcriptions API]
* [[Reference16r1:Concept App Service myApps Assistant]]
* [[Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions]]

Reference16r1:Concept App Service Conference Transcriptions

2026-04-24T12:14:19Z

Sga: /* Installation */

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

* innovaphone Conference Transciptions from version 16r1

== Overview ==
[[File:Reference16r1 Concept App Service Conference Transcriptions Softphone App.png|thumb|309x309px|reference16r1_concept_app_service_conference_transcriptions_softphone_app.png/|/Reference16r1_Concept_App_Service_Conference_Transcriptions_Softphone_App.png]]
The main goal of the Conference Transcriptions Service is to create video‑conference meeting summaries, which can be accessed in the Phone Apps.

To achieve this:
# Users can start a transcription of the conference audio by clicking the '''“Transcribe Conference”''' button in the Phone Apps.
#* This action makes the Conference Transcriptions service connect to the conference room.
#* It records the audio and creates audio files of approximately one minute in length.
#* It forwards these small audio files via the com.innovaphone.transcriptions API, offered by the Transcriptions Service ([[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]])
#* It receives the transcripts of these small files and stores them in the service database.
# If the user stops the transcription by clicking on the "'''Transcribe Conference'''" Button again
#* The Conference Transcriptions Service gathers the transcribed text from the database
#* It retrieves the prompt configured in the settings plugin [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions | ConferenceTranscriptions settings plugin]]
#* It sends the transcript together with the prompt to the Assistant App Service via the com.innovaphone.assistant API
#* It receives the meeting summary and stores that summary in the database of the service
# Users may start and stop transcriptions multiple times during a meeting. As long as users remain in the room, the service recognizes that the meeting is still the same for that room.
# After the meeting, users can find the AI‑generated meeting summary in the call list of their Phone Apps by clicking on the '''“i”''' button. 

== Licensing ==

In order to use the service you will need the newly introduced '''UCC license'''
== Installation ==
Go to the '''Settings App''' (fomerly known as 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 '''"Conference Transcriptions"''' and click on it.
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) in order to refresh the list of the available colored AP plugin icons.
* Open the '''"AP Conference Transcriptions"''' Plugin by clicking on it and click on '''" + Add an App"''' and then on the '''"Conference Transcriptions API"''' button.
* Enter a '''"Name"''' ''(used as display name / all character allowed)'' and the '''"SIP"''' ''(no space, no capital letters)''. ''e.g : Name: Conference Transcriptions API, SIP: conference-transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings. A green check mark will be shown to confirm that the configuration is good.

In order to make the service work properly, two supplemental services must be installed:

* the myApps Assistant which will summarize the transcript [[{{NAMESPACE}}:Concept App Service myApps Assistant | Concept App Service myApps Assistant]]
* the Transcriptions Service which establishes a connection to a remote transcription server [[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]]

== Conference Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Transcribes the audio of a conference room
* Stores the transcript in the database
* Creates and stores the summary of the transcript in the database

It can be configured in the '''Settings App''' (formerly known as PBXManager App) [[Reference16r1:Apps/PbxManager/App_myApps_ConferenceTranscriptions]]

== Summary prompts ==
You may configure the prompt freely. Here are some propositions you may copy/paste into the corresponding field of the settings plugin:

'''1. General prompt'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

Summary: 
 
(2–4 sentences describing the purpose of the meeting and the main outcomes.)
 
 
Decisions:
 
 
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
Key Points:
 
 
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
Tasks:
 
 
<ul>
<li>Person (with sip e.g. @pso)— Task — Deadline (if mentioned)</li>

</ul>
 
 
Open Questions:
 
 
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

'''2. A more structured version:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<ul>
<li>Summary: </li>
<ul>

<li>Sentence 1</li>
<li>Sentence 2</li>
</ul>
 
 
<li>Decisions:</li>
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
<li>Key Points:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
<li>Tasks:</li>
<ul>
<li>Person — Task — Deadline (or “No deadline mentioned”)</li>

</ul>
 
 
<li>Open Questions:</li>
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>
</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.
Use a normal text style. No italic.

TRANSCRIPT:
</pre>

'''3. When meetings are used to take decisions:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<li>Results:</li>
<ul>
<li>Results 1</li>
<li>Results 2</li>

</ul>
 
 
<li>Miscellaneous:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

== Troubleshooting ==

For troubleshooting the Conference Transcirptions App Service, you need activate the traceflags ''App'', ''Database and'' ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.conference-transcriptions/com.innovaphone.conference-transcriptions.htm SDK Documentation - Conference Transcriptions API]
* [[Reference16r1:Concept App Service myApps Assistant]]
* [[Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions]]

Reference16r1:Concept App Service Conference Transcriptions

2026-04-24T12:11:55Z

Sga: /* Overview */

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

* innovaphone Conference Transciptions from version 16r1

== Overview ==
[[File:Reference16r1 Concept App Service Conference Transcriptions Softphone App.png|thumb|309x309px|reference16r1_concept_app_service_conference_transcriptions_softphone_app.png/|/Reference16r1_Concept_App_Service_Conference_Transcriptions_Softphone_App.png]]
The main goal of the Conference Transcriptions Service is to create video‑conference meeting summaries, which can be accessed in the Phone Apps.

To achieve this:
# Users can start a transcription of the conference audio by clicking the '''“Transcribe Conference”''' button in the Phone Apps.
#* This action makes the Conference Transcriptions service connect to the conference room.
#* It records the audio and creates audio files of approximately one minute in length.
#* It forwards these small audio files via the com.innovaphone.transcriptions API, offered by the Transcriptions Service ([[{{NAMESPACE}}:Concept_App_Service_Transcriptions | Concept App Service Transcriptions]])
#* It receives the transcripts of these small files and stores them in the service database.
# If the user stops the transcription by clicking on the "'''Transcribe Conference'''" Button again
#* The Conference Transcriptions Service gathers the transcribed text from the database
#* It retrieves the prompt configured in the settings plugin [[{{NAMESPACE}}:Apps/PbxManager/App myApps ConferenceTranscriptions | ConferenceTranscriptions settings plugin]]
#* It sends the transcript together with the prompt to the Assistant App Service via the com.innovaphone.assistant API
#* It receives the meeting summary and stores that summary in the database of the service
# Users may start and stop transcriptions multiple times during a meeting. As long as users remain in the room, the service recognizes that the meeting is still the same for that room.
# After the meeting, users can find the AI‑generated meeting summary in the call list of their Phone Apps by clicking on the '''“i”''' button. 

== Licensing ==

In order to use the service you will need the newly introduced '''UCC license'''
== Installation ==
Go to the '''Settings App''' (fomerly known as 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 '''"Conference Transcriptions"''' and click on it.
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) in order to refresh the list of the available colored AP plugin icons.
* Open the '''"AP Conference Transcriptions"''' Plugin by clicking on it and click on '''" + Add an App"''' and then on the '''"Conference Transcriptions API"''' button.
* Enter a '''"Name"''' ''(used as display name / all character allowed)'' and the '''"SIP"''' ''(no space, no capital letters)''. ''e.g : Name: Conference Transcriptions API, SIP: conference-transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings. A green check mark will be shown to confirm that the configuration is good.

In order to make the service work properly, two supplemental services must be installed:

* the myApps Assistant which will summarize the transcript [[Reference16r1:Concept App Service myApps Assistant]]
* the Transcriptions Service which establishes a connection to a remote transcription server [[Reference16r1:Concept_App_Service_Transcriptions]]

== Conference Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Transcribes the audio of a conference room
* Stores the transcript in the database
* Creates and stores the summary of the transcript in the database

It can be configured in the '''Settings App''' (formerly known as PBXManager App) [[Reference16r1:Apps/PbxManager/App_myApps_ConferenceTranscriptions]]

== Summary prompts ==
You may configure the prompt freely. Here are some propositions you may copy/paste into the corresponding field of the settings plugin:

'''1. General prompt'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

Summary: 
 
(2–4 sentences describing the purpose of the meeting and the main outcomes.)
 
 
Decisions:
 
 
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
Key Points:
 
 
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
Tasks:
 
 
<ul>
<li>Person (with sip e.g. @pso)— Task — Deadline (if mentioned)</li>

</ul>
 
 
Open Questions:
 
 
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

'''2. A more structured version:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<ul>
<li>Summary: </li>
<ul>

<li>Sentence 1</li>
<li>Sentence 2</li>
</ul>
 
 
<li>Decisions:</li>
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
<li>Key Points:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
<li>Tasks:</li>
<ul>
<li>Person — Task — Deadline (or “No deadline mentioned”)</li>

</ul>
 
 
<li>Open Questions:</li>
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>
</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.
Use a normal text style. No italic.

TRANSCRIPT:
</pre>

'''3. When meetings are used to take decisions:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<li>Results:</li>
<ul>
<li>Results 1</li>
<li>Results 2</li>

</ul>
 
 
<li>Miscellaneous:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

== Troubleshooting ==

For troubleshooting the Conference Transcirptions App Service, you need activate the traceflags ''App'', ''Database and'' ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.conference-transcriptions/com.innovaphone.conference-transcriptions.htm SDK Documentation - Conference Transcriptions API]
* [[Reference16r1:Concept App Service myApps Assistant]]
* [[Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions]]

Reference16r1:Concept App Service Conference Transcriptions

2026-04-24T12:06:52Z

Sga:

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

* innovaphone Conference Transciptions from version 16r1

== Overview ==
[[File:Reference16r1 Concept App Service Conference Transcriptions Softphone App.png|thumb|309x309px|reference16r1_concept_app_service_conference_transcriptions_softphone_app.png/|/Reference16r1_Concept_App_Service_Conference_Transcriptions_Softphone_App.png]]
The main goal of the Conference Transcriptions Service is to create video‑conference meeting summaries, which can be accessed in the Phone Apps.

To achieve this:
# Users can start a transcription of the conference audio by clicking the '''“Transcribe Conference”''' button in the Phone Apps.
#* This action makes the Conference Transcriptions service connect to the conference room.
#* It records the audio and creates audio files of approximately one minute in length.
#* It forwards these small audio files via the com.innovaphone.transcriptions API, offered by the Transcriptions Service ([[Reference16r1:Concept_App_Service_Transcriptions]])
#* It receives the transcripts of these small files and stores them in the service database.
# If the user stops the transcription by clicking on the "'''Transcribe Conference'''" Button again
#* The Conference Transcriptions Service gathers the transcribed text from the database
#* It retrieves the prompt configured in the settings plugin [[Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions]]
#* It sends the transcript together with the prompt to the Assistant App Service via the com.innovaphone.assistant API
#* It receives the meeting summary and stores that summary in the database of the service
# Users may start and stop transcriptions multiple times during a meeting. As long as users remain in the room, the service recognizes that the meeting is still the same for that room.
# After the meeting, users can find the AI‑generated meeting summary in the call list of their Phone Apps by clicking on the '''“i”''' button. 

== Licensing ==

In order to use the service you will need the newly introduced '''UCC license'''
== Installation ==
Go to the '''Settings App''' (fomerly known as 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 '''"Conference Transcriptions"''' and click on it.
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) in order to refresh the list of the available colored AP plugin icons.
* Open the '''"AP Conference Transcriptions"''' Plugin by clicking on it and click on '''" + Add an App"''' and then on the '''"Conference Transcriptions API"''' button.
* Enter a '''"Name"''' ''(used as display name / all character allowed)'' and the '''"SIP"''' ''(no space, no capital letters)''. ''e.g : Name: Conference Transcriptions API, SIP: conference-transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings. A green check mark will be shown to confirm that the configuration is good.

In order to make the service work properly, two supplemental services must be installed:

* the myApps Assistant which will summarize the transcript [[Reference16r1:Concept App Service myApps Assistant]]
* the Transcriptions Service which establishes a connection to a remote transcription server [[Reference16r1:Concept_App_Service_Transcriptions]]

== Conference Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Transcribes the audio of a conference room
* Stores the transcript in the database
* Creates and stores the summary of the transcript in the database

It can be configured in the '''Settings App''' (formerly known as PBXManager App) [[Reference16r1:Apps/PbxManager/App_myApps_ConferenceTranscriptions]]

== Summary prompts ==
You may configure the prompt freely. Here are some propositions you may copy/paste into the corresponding field of the settings plugin:

'''1. General prompt'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

Summary: 
 
(2–4 sentences describing the purpose of the meeting and the main outcomes.)
 
 
Decisions:
 
 
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
Key Points:
 
 
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
Tasks:
 
 
<ul>
<li>Person (with sip e.g. @pso)— Task — Deadline (if mentioned)</li>

</ul>
 
 
Open Questions:
 
 
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

'''2. A more structured version:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<ul>
<li>Summary: </li>
<ul>

<li>Sentence 1</li>
<li>Sentence 2</li>
</ul>
 
 
<li>Decisions:</li>
<ul>
<li>Decision 1</li>
<li>Decision 2</li>

</ul>
 
 
<li>Key Points:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

 
 
<li>Tasks:</li>
<ul>
<li>Person — Task — Deadline (or “No deadline mentioned”)</li>

</ul>
 
 
<li>Open Questions:</li>
<ul>
<li>Question 1</li>
<li>Question 2</li>

</ul>
</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.
Use a normal text style. No italic.

TRANSCRIPT:
</pre>

'''3. When meetings are used to take decisions:'''

<pre>
You will receive a meeting transcript. Your task is to turn it into a structured meeting summary.

The entire summary — including section headers, bullet points, and all text — must be written in the same language as the transcript. Detect the language automatically. If the transcript is in german write the summary in german. If the transcript is in english, write the summary in english...

Follow these instructions exactly:

1. Read the transcript carefully.
2. Extract only the information that is clearly stated. Do not guess or invent anything.
3. Create the final summary using the exact structure below, but translate the section headers into the language of the transcript.

OUTPUT FORMAT (translate the headers into the transcript language, but keep the structure):

 
A short title describing the meeting.
 
 

<li>Results:</li>
<ul>
<li>Results 1</li>
<li>Results 2</li>

</ul>
 
 
<li>Miscellaneous:</li>
<ul>
<li>Bullet point 1</li>
<li>Bullet point 2</li>
<li>Bullet point 3</li>


</ul>

RULES:

Use HTML lists (<ul><li></li></ul>) only for bullet points.
Do not add information that is not in the transcript.
Keep the writing clear and concise.
Keep the structure exactly as shown, but translate the headers.
Do not wrap the whole answer in a single HTML tag.

TRANSCRIPT:
</pre>

== Troubleshooting ==

For troubleshooting the Conference Transcirptions App Service, you need activate the traceflags ''App'', ''Database and'' ''HTTP-Client'' in your App instance.

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.conference-transcriptions/com.innovaphone.conference-transcriptions.htm SDK Documentation - Conference Transcriptions API]
* [[Reference16r1:Concept App Service myApps Assistant]]
* [[Reference16r1:Apps/PbxManager/App myApps ConferenceTranscriptions]]

Reference13r1:Concept App Service Yealink

2026-04-17T07:39:48Z

Sga:

[[Category:Concept|Apps]]
The Provisioning App for Yealink is an App Service which can be installed on an innovaphone App Platform and is used to easily provision Yealink SIP devices with myApps. This enables the user to easily set up a Yealink SIP device via his profile. ''The administrator also has the possibility to set up a Yealink SIP device for a user via UsersAdmin.''
When a Yealink phone is provisioned on Profile ''or UsersAdmin'', the Yealink App connects to the Yealink Redirect To Provisioning Server (RPS) and redirects the phone to the Yealink App on the customer App Platform, where the config files will be requested afterwards. These config files are generated on the Yealink App with user data received from Users and device configuration data received from Devices.
== Applies To ==

* innovaphone PBX from version 13r1sr18

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r1xx
* Devices App
* Profile App
* Users Admin App
* MAC address of the Yealink Device (usually on the back of the device)

== Apps ==
=== Yealink App (innovaphone-yealink) ===
[[Image: Yealink-App.png|yealink-app.png/|yealink-app.png/]]
This is an App, where the administrator can check the communication between the RPS and the Provisioning App.

Also some config items can be edited on the hamburguer menu:

* RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access
* Interval for phone updates
* Timeserver and timezone
* Device Admin account credentials
* Media Relay option for the HW-ID
* SIP protocol (TCP or TLS)
* HTTP(S) protocol for provisioning access

Parameters:
;Websocket: to get the URL of the app, so the phones can be redirected
;Admin: to be able to edit the device on the User object
;Services: needed to use the Devices API (com.innovaphone.devices), so the phone configuration can be received
;Devices-API: gives access to the Devices App, which is needed for the provisioning of phones

Parameters for Profile App Object:

;Yealink: gives access to the Provisioning App, which is needed for the provisioning of phones

== PBX Manager Plugins ==

=== Yealink ===

With the Yealink plugin App Objects can be created, edited and deleted on the PBX.

==Configuration==
* Download the Provisioning App for Yealink via App Store.
* Install the App on the App Platform Manager.
* Create a instance for the Provisioning App for Yealink on the App Platform Manager.
* Create a new PBX Object with the PBX Manager Plugin.
* Assign App to authorized (admin) users, which will be allowed to open the Admin UI of the Provisioning App.
* Set access in the Profile App Object in the advanced UI to the Provisioning App for Yealink. This gives access to the Provisioning App for Yealink, which is needed for the provisioning of phones.

[[File:RPS-account.png|alt=RPS account|thumb|rps-account.png/|rps-account.png/]]
Do not forget to check the default configuration on the hamburguer menu of the Provisioning App. There it is possible to set:

* Your own RPS account (We recommend that you use your own account. You will receive your own login credentials from your official Yealink distributor. '''The default login credentials should only be used for testing purposes.''')
* Device provisioning account for configuration file access

* The interval when the phone must ask for updates
* The default device configuration parameters (only updated when then phone requests the configuration)
** NTP server
** Timezone
** Location
**Device Admin account credentials
** Media Relay (Set [[Reference13r2:PBX/Objects#Devices Config Flags|Media Relay Flag]] '''on the HW-ID of the PBX user object''' and disable ICE on the phone, '''DO NOT set media relay for the whole pbx!!!''')
** TLS (To use SIP/TLS for registration, you have to put the root certificate (Yealink Equipment Issuing CA or Yealink Root CA) for devices from Yealink in the trust list of the Reverse Proxy and PBX. Please ask Yealink for this Yealink Equipment Issuing CA certificate or Yealink Root CA.)
** HTTPS (This defines if the Provisioning URL configured on the Phone must be HTTP or HTTPS)

Also refer to [[Howto:Deploy Yealink Devices on myApps|this illustrated configuration document]] on how to deploy Yealink devices.

==Provisioning workflow==
[[Image: Yealink workflow.jpg|thumb|upright=1.0|right|yealink_workflow.jpg/|yealink_workflow.jpg/]]
First of all, when the App starts running it '''publishes a Provisioning API''' (''com.innovaphone.provisioning''), so that the Profile App and Users Admin App will be able to find it as provider. For this Profile and Users Admin must be able to access the Provisioning App, which can be configured on each App Object on the PBX. This is also automatically configured on the PBX Manager when adding or editing a Provisioning App Object. The Provisioning App also registers its URL with a server name (which is usually the 24 first characters of the domain name) on the Yealink RPS everytime the app service starts, which will be used to redirect the devices afterwards.

On '''Profile''' (or Users Admin) the provisioning of a new phone is started and it looks for the Provisioning APIs that have been published. The user must select which one is the right one for the given phone (in this case Yealink) because there could be more than one manufacturer. Afterwards, the provisioning categories and the provisioning code are requested to Devices and saved on the Users Service. Then the '''MAC address''' must be entered on Profile. This with the provisioning code (and also other user-related data like username) is sent from Users to the Provisioning App.

Next the Provisioning App opens a '''Sysclient''' connection and when it is set Devices sends the configuration for the phone through the Sysclient connection. This connection remains opened and it is used to receive configuration updates.

Finally the phone is redirected on the '''Yealink RPS''', which will redirect the phone to the Provisioning App when it requests for the configuration. This can be triggered it by doing a Factory Reset. The phone requests the configuration by sending a GET request to the app, which will be answered with the '''configuration file'''. If an '''update timeout''' has been defined on the Yealink App, the phone will keep requesting for a new configuration file periodically to the Provisioning App. After the configuration file has been sent, the '''device''' on the user object is edited to update the Media Relay, TLS only and Reverse Proxy flags.

==How to provision a device==
Yealink devices can be added by provisioning a new phone but selecting Yealink instead of innovaphone as the manufacturer. From a user point of view this should work as follows:
* Open myApps/Profile/My phones and select "'''+ Phone'''" to add a new device
* Then choose the manufacturer of the phone, in this case '''Yealink'''
* A drop down is displayed to select a '''category'''
* Enter the '''MAC''' address of the Yealink device (must be entered without ":" or "-")
* Enter a '''name''' for this device, which will be the name of the app displayed on the home screen afterwards
* Unpacks the phone and connects it to the network (or do a factory reset on the device)
* The phone looks for the configuration and when it has finished the user should be able to make calls

At the end:
* A new app must have been added to the home screen
* A new device must have been added to the user object (this can be checked on Users Admin or on the PBX)
* A new entry for the given device must have been added on the Devices tab of the Provisioning App
* The device must have been added to the Devices App

==User interface==
[[Image: Yealink RPS history.jpg|thumb|upright=1.0|right|yealink_rps_history.jpg/|yealink_rps_history.jpg/]]
[[Image: Yealink Devices.jpg|thumb|upright=1.0|right|yealink_devices.jpg/|yealink_devices.jpg/]]
In the user interface of the administrator app there are 2 tabs: RPS history and Devices.

On the '''RPS history''' tab, the history of the comunication between the app and the Yealink RPS can be seen. Here the commands sent from the app to the Yealink RPS with their answers are displayed. To be considered:
* Everytime the app starts, an '''ADD SERVER''' command is sent to register the URL of the app to the server name. After the first start of the app, this command will be always answered with '''Error: The server name has been used''' because the URL was already registered the first time.
* Every time a phone is provisioned, first a '''DEREGISTER DEVICE''' command is sent to remove it from the RPS if the phone has already been provisioned before. Then a '''REDIRECT DEVICE''' command is sent to redirect the config requests from the phone to the app. If the phone has not already been provisioned before, the first command will be answered with '''Error: Invalid MAC(s)'''.

On the '''Devices''' tab, the list of all the devices provisioned by the app and their status are displayed. To be considered:
* If a phone is not on the list, the device data has not been received by the app.
* If the value of the '''Device Config''' column is not '''Config Received''', then the sysclient Connection between Devices App and the Provisioning App has not been set or the configuration has not been received.
* If the value of the '''Phone Requests''' column is not '''Provisioned''', that means that the phone has still not requested the config file to the app. In this case, a Factory Reset should be done on the phone.
* On the '''Last Config Request''' column, the timestamp of the last config request done by the phone is displayed.

==Known issues==
[[Image: Yealink trusted certificates.jpg|thumb|upright=1.0|right|yealink_trusted_certificates.jpg/|yealink_trusted_certificates.jpg/]]
It the phone configuration has been received but after a factory reset no phone requests have been received, you may need to disable the security certificates in the Yealink phone web interface under Security>Trusted Certificates:
* Only Accept Trusted Certificates -> Disabled
* Common Name Validation -> Disabled
* CA Certificates -> All Certificates

==Troubleshooting==
If the provisioning of a Yealink device fails, stopp the service (Provisioning App for Yealink), delete the previous traces and select: App, App Websocket, Database, HTTP Client, TCP, TLS and Webserver Traffic.
Attempt the provisioning again, collect the traces and open a support ticket.

==Related Articles==
* [[Howto:Deploy Yealink Devices on myApps|Deploy Yealink Devices]]
* [[Howto:Yealink IP phones - Yealink - 3rd Party Product|Yealink Devices Compatibility]]

* SDK Integration (if the content is available)

Reference16r1:Concept Reconnect Calls

2026-04-13T14:51:41Z

Sga: /* Known Issues */

Restoring calls can be necessary for various reasons:

* Restart of the PBX. Calls are lost during the PBX restart.
* Loss of network connectivity, for example due to a coverage gap or when leaving a Wi-Fi network and transitioning to 5G or PC switching between ETH and WiFi.
* Audio/video problems in a conference, as an attempt to repair the session.

== Applies To ==
innovaphone PBX and Clients from version 16r1

== Requirements ==
Version 16r1 (not compatible with older versions of PBX or clients)

== Configuration ==
No configuration needed

== How it works ==

=== PBX Registration ===
A registration with the PBX is needed in order to establish a call.

In older version (15r1 and below) calls were automatically dropped when the clients lost the registration with the PBX.

Calls now remain in the endpoints and once the registration is restablished with the PBX the reconnect call will be started replacing the old call.

There is an important different between a PBX Reboot or a switching in the network interface:

During a PBX reboot the registration is lost but the RTP Path for audio and video may remain and the user will not notice the reboot while during a switching the user temporarily loses all internet connections experiencing no audio until registration with the PBX and reconnect call are restablished.

=== Mechanism ===
The idea of this new feature is that all endpoints involved in a connection store the information required to restablish the connection.

To indicate that this mechanism is supported, the Facility '''FTY_RECONNECT_INIT''' is sent during call setup.

An endpoint that supports this mechanism responds with '''FTY_RECONNECT_INFO''' Facility which contains an '''id''' for the call (the user could have two calls simultaneosly or start a second one later on) and also a '''hardware''' id (since the user could have several Softphone instances running)

Restoring the connection is performed by establishing a new call that replaces the old one.

This new call is always initiated by the endpoint that received FTY_RECONNECT_INFO which is typically the side that originally established the call.

The reconnect call setup contains the Facility '''FTY_RECONNECT_SETUP''' which contains the '''id''' and '''hardware''' provided in the '''FTY_RECONNECT_INFO'''.

Once this call is transparently connected (user is not aware of the reconnect process) the old call is cleared up.

==Limitations==
* not supported for IP73 Wifi-endpoints and IP-DECT endpoints

== Known Issues ==

* Reconnect calls is still not working for external calls initiated by the external participant
* iOS clients take long to detect switching between network interfaces (5G <-> WiFi). That means that there could be a long period without Audio until the registration with the PBX is restablished and the reconnect call can be started.
* myApps may crash if the call is on Hold.
* Calls in a conference are not reconnected at the moment.
* Non successfully Reconnect Calls will be shown in the call list.
* Reconnect calls don't work for calls to/from analog interfaces

Reference15r1:Concept App Service Fax

2026-04-01T09:53:15Z

Sga: /* App Service Log */

[[Category:Concept|Apps]]

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

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax#Default_settings_for_mail_notifications|Centralized setup]] of mailing notifications
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a [[{{NAMESPACE}}:Gateway/Interfaces#FAX_interface|FAX interface]]
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png|concept_fax.png/]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements| licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The fax service has a built-in SMTP server, which is needed for Mail2Fax. Here, you activate the mail reception for the fax service, enter the fax domain and configure the credentials for the authentication against the SMTP server. The mails can contain a subject and body for the cover page, and '''one PDF document can be appended as attachment'''. No cover page is added if both the subject and the mail content are empty. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charsets are UTF-8 and ISO 8859-1 (Latin 1).

As of 14r2 the SMTP server only listens on port 25. STARTTLS is possible.

For the Fax service to receive the mails in the first place, the mailserver needs to forward mails for the fax-domain to the APs IP address.

An example for an Exchange configuration can be found [[Howto14r2:Fax App - Mail2Fax with Exchange 2019|here]]

Starting with 16r1 you also can configure OAuth2 Authentications. You can have a look into our HowTo Article for assistance: [[Howto16r1:Configure OAuth2 E-Mail]]

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document to be sent can be uploaded with the HTTP post command. The arguments within the HTTP URL sets the data of the new fax job. The job is created in the context of a user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the URL:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact (must be url-encoded).
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created (must be url-encoded).
* cover-page-content: The content of an optional cover page if should be created (must be url-encoded).
* cover-page-content-html: If set to true, the cover page content is in HTML.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

Here an example:

curl -X POST "http://AP-DNS-name/DOMAIN/fax/?api-key=1234&user-sip=vgr&contact-number=00049703173009&cover-page-subject=Hello%20World&app-object=fax" -T testfax.pdf

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*SMTP
*TLS
*TCP
*DB files

As these options generate extensive logs, please '''only enable them to track a current problem and disable them again afterwards'''.

== Known Issues ==
* '''Important:''' If using Mail2Fax, only '''ONE''' PDF attachment is allowed and can be handled by the Fax service. If multiple attachments are added the first PDF is used and all other attachments like more PDFs, pictures etc. are ignored.
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.
* Fax Fallback from T.38 to G.711 passthrough (AudioFax) is not supported by FaxAPP when a SIP Trunk with media-relay is used, which is often the case. The solution in such a scenario is to disable T.38 on the SIP Interface with media-relay and only use Audio-Fax.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [[Courseware:IT_Plus_-_Fax|the book about fax application setup]] as part of our IT Plus Training.
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App
* [[Howto: Mail2Fax with Exchange 2019]]

Reference13r3:Concept App Service Fax

2026-04-01T09:52:58Z

Sga: /* App Service Log */

[[Category:Concept|Apps]]

== Applies To ==
* innovaphone PBX from version 13r3

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* The Fax app can forward the received [[Reference13r3:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[Reference13r3:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* If you enter a number in the input field and click on it, this number will be stored inside the fax database as a contact. Currently, these contacts can't be deleted, so be aware to not click and thus save wrong numbers.
** This behavior has changed in 14r1: If a contact no longer has any jobs, it is deleted at night. Deleted jobs are removed after two weeks, only then is a contact empty.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Courseware:IT_Plus_-_Fax | IT Connect Training]].
* [[Reference13r3:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r1:Concept App Service Fax

2026-04-01T09:52:43Z

Sga: /* App Service Log */

[[Category:Concept|Apps]]

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

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts

== Requirements ==
* innovaphone App Platform
* Device with a FAX interface
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements | licensed accordingly]].

==== Mail Configuration ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*SMTP (only if the problem is related to mail forwarding etc.)

== Known Issues ==
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again (by means of a new call attempt), if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to our [[Courseware:IT_Plus_-_Fax | IT Connect Training]].
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App

Reference14r2:Concept App Service Fax

2026-04-01T09:52:26Z

Sga: /* App Service Log */

[[Category:Concept|Apps]]

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

== Overview ==
The App Service Fax is an app service which can be installed on an innovaphone App Platform. It provides sending or receiving FAX documents with the innovaphone PBX and a user app to manage the documents.

== Features ==
* The App Service Fax sends PDF documents as FAX documents and converts received FAX documents to PDF.
* Cover page with user content for outgoing FAX documents.
* The Fax app can forward the received [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|fax documents by mail]], as notification only or with the document in PDF.
* Transmission reports and error notifications
* Contact search by using myApps search API providers, inclusive removing number decorations
* PBX node support
* Using several fax interfaces
* Group fax accounts
* Automatic deletion of older fax documents
* Customized email texts
* Mail2Fax
* App API (HTTP Post)

== Requirements ==
* innovaphone App Platform
* Device with a [[{{NAMESPACE}}:Gateway/Interfaces#FAX_interface|FAX interface]]
* One port license to register the fax interface towards the fax object
* A UC or fax license for each PBX user which is allowed to receive or send personal fax documents
* A fax (or UC) license for each group fax account

== Apps ==
'''Fax App (innovaphone-fax)''' 
This app is provided for the users to send fax documents and view or download received documents. The app reads the argument mailbox=<sip name> to work with the given account instead of the user logged in. It uses the com.innovaphone.search API to search for contacts with FAX numbers.

== Technical Overview ==
[[Image:Concept fax.png|concept_fax.png/]]

== Technical Concept ==
The innovaphone fax feature needs three parts:
* An innovaphone PBX with one or more fax objects
* One or more FAX interface registered to fax objects
* The Fax app on the App Platform (AP)

The app service on the AP provides a user app. Users can upload and download PDF documents. The app service converts them from and to a fax protocol compatible file (SFF).
The app service controls calls between the FAX interface and an external remote party. To do this, it requires a websocket connection to the PBX. The FAX interface accesses the file with authenticated WebDAV.
The documents saved in the app service are available with WebDAV with the app instance name as user name and the app instance password as password and in the directories
* <app-web-path>/sff for the SFF files
* <app-web-path>/doc for the PDF files

==== Additional Information ====
* Files of deleted fax jobs are permanently deleted after two weeks.
* The myApps background picture (myapps.png) is also included in all HTML mail bodies with customized mail texts, if these texts contain the string "url(cid:myapps.png)".

== Configuration ==

==== PBX Manager Plugin ====
All possible configurations can be done with the [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] of the Fax App. The app service options can be set as well as the corresponding app objects in the PBX can be added, modified or deleted. Additionally, available devices with a fax interface can be found and configured. 
As with any app, the Fax App needs to be assigned to users and [[#Requirements| licensed accordingly]].

==== Mail Configuration (SMTP Server) ====
The fax service has a built-in SMTP server, which is needed for Mail2Fax. Here, you activate the mail reception for the fax service, enter the fax domain and configure the credentials for the authentication against the SMTP server. The mails can contain a subject and body for the cover page, and '''one PDF document can be appended as attachment'''. No cover page is added if both the subject and the mail content are empty. The destination number must be included in the recipient mail address in this format: <destination number>@<fax server domain>. The fax server domain is the app service domain or the configured domain if different. Recipient addresses do not match are discarded.

The supported charsets are UTF-8 and ISO 8859-1 (Latin 1).

As of 14r2 the SMTP server only listens on port 25. STARTTLS is possible.

For the Fax service to receive the mails in the first place, the mailserver needs to forward mails for the fax-domain to the APs IP address.

An example for an Exchange configuration can be found [[Howto14r2:Fax App - Mail2Fax with Exchange 2019|here]]

==== Mail Configuration (SMTP Client) ====
The SMTP configuration is to be set in the Fax App PBX Manager plugin to make mail forwarding, transmission reports and notifications available. Only email addresses of the user configured in his PBX object are used and each user has to enable the several mails in the burger menu of the Fax app.
Available types of mails:
* Forwarding of a received document as PDF
* Incoming notifications without a document
* Error notifications for outgoing fax jobs
* Transmission confirmations
* Transmission reports for outgoing fax jobs as PDF

The mails are sent in the language the user set in myApps when the Fax app was last used, unless the language for mails was explicitly set within the app.

If a failure occurs and mails cannot be sent, the app service retries the mail transmission of a mail every 30 minutes, but no longer than two days.

==== PBX Node Configuration ====
The Fax app object can be assigned to a certain PBX node. If so, the node number is included within the user's fax number.

==== Group Fax Account ====
If a Group Fax app is configured, all users have the same group account with this app, and the same jobs. The mail addresses configured in this Group app are available and used instead of the user's mail addresses.

==== Sharing FAX Interfaces ====
FAX interfaces are normally registered to one app object. Other PBX Fax objects use these fax resources for calls if they are configured as external resource in the objects.

== App API ==
A document to be sent can be uploaded with the HTTP post command. The arguments within the HTTP URL sets the data of the new fax job. The job is created in the context of a user and is shown in the app. If the file is successfully saved, the job is directly queued for sending.

An API key must be configured to enable this feature and to authenticate the command.

Arguments of the HTTP post command in the URL:
* api-key: The configured authentication key. Mandatory.
* user-sip: The SIP of the user which sends the document. Mandatory.
* contact-name: An optional contact name shown in the app as contact (must be url-encoded).
* contact-number: The contact number used for sending the document. Mandatory.
* cover-page-subject: The subject of an optional cover page if should be created (must be url-encoded).
* cover-page-content: The content of an optional cover page if should be created (must be url-encoded).
* cover-page-content-html: If set to true, the cover page content is in HTML.
* app-object: The app object of the PBX used for sending. If not set, any is used.
* file-name: An optional file name of the uploaded file. Not used in the app.

Here an example:

curl -X POST "http://AP-DNS-name/DOMAIN/fax/?api-key=1234&user-sip=vgr&contact-number=00049703173009&cover-page-subject=Hello%20World&app-object=fax" -T testfax.pdf

== Troubleshooting ==
==== Log Files ====
The progress of fax jobs is reported in the log file:

Info job id 58, direction 0, progress 0, result 0

;direction
:0: incoming job
:1: outgoing job

;progress
:0: job created
:1: job queued
:2: job converted
:3: job finished

;result
:0: no error or successfully completed
:1: call aborted, repeating
:2: job stopped with an error
:3: job stopped caused by a conversion failure

==== App Service Log ====
*App
*App WebSocket
*SMTP (only if the problem is related to mail forwarding etc.)

==== App Service Logs for Mail2Fax ====
*App
*Smtp
*TLS
*TCP
*DB files
-> Since these options creates huge logs, please just enable for tracing a current problem and deactivate afterward

== Known Issues ==
* '''Important:''' If using Mail2Fax, only '''ONE''' PDF attachment is allowed and can be handled by the Fax service. If multiple attachments are added to an E-Mail, the Faxservice will get in a broken status.
* Since the Fax-Interface currently offers '''only''' support for 200 dpi and 400 dpi faxes, the same dpi is required on the remote party.
* Enabling of non-T.38 coder (audio-fax) is also possible for T.38-only capable devices.
: Has to be judged by the user himself, if selected fax interface features audio-fax.
* An IPVA is not capable of sending faxes with a non-T.38 coder (audio-fax coder, e.g. G.711A), because it has no DSPs which are needed for an audio-fax. Therefore, ''only'' T.38 faxes work on an IPVA FAX interface.
** '''Important:''' T.38 is to be enabled on ''all'' interfaces are used in the call flow, e.g. FAX, GW, SIP interface.
** '''Important:''' Often "exclusive" is activated on SIP interfaces. This prevents the renegotiation with the provider and T.38 can not be used. Therefore, the "exclusive" flag is to be disabled for such configurations.
* If the name (H.323) of an user is changed in the PBX, the data in the fax service are not accessible for this user and a new account is created for him in the service.
* With 14r1, faxes will be sent with 400dpi per default, and tried with a lower resolution again, if the remote side doesn't support 400dpi faxes. In a 13r3 fax app (no 400dpi support), you will see the first - non working - try, which is the normal behavior, since all faxes (working and non working) are shown in the fax app.

== Related Articles ==
* For a more detailed description about the configuration, please refer to [https://class.innovaphone.com/moodle2/course/view.php?id=1705&topic=0#section-2 the book about fax application setup] as part of our IT Plus Training.
* [[{{NAMESPACE}}:Apps/PbxManager/App_Fax|PBX Manager plugin]] for the Fax App
* [[Howto: Mail2Fax with Exchange 2019]]

Reference16r1:Concept myApps Redundancy

2026-03-24T11:35:46Z

Sga: /* General concept */

[[Category:Concept|myApps Redundancy]]
[[Category:Concept_myApps]]

The myApps client handles the failure of a single PBX by failover to a secondary PBX.

== Applies to ==
* innovaphone devices with a PBX from version 16r1
* innovaphone myApps (all platforms)

== General concept ==
The innovaphone PBX has implemented a mechanism, that by adding a single PBX to an installation, from the failure of any single PBX can be recovered.
* For a single PBX a standby PBX can be configured
* For a slave PBX a standby-slave PBX or otherwise the master can act as standby
* For a master PBX any slave PBX can act as standby

The myApps client can connect to any PBX in the system. If it does not match the PBX on which the user is configured on, the client follows a number of redirects until it ends up at the user's PBX.
* Slave PBXes redirect to their master PBX.
* The master PBX redirects to the slave PBX of the user.

=== Handling of standby cases ===

If the current PBX has no registration to the PBX it would redirect to, it acts as a standby and keeps the myApps connection.

If a slave should act as a standby for the master, the myApps client must be logged on to the slave. This forwards the login to the master. In the event of a failover, the slave takes over.

For cases in which the initial PBX is unavailable the myApps client tries to connect to two PBXes in an alternating manner:
;Primary PBX: This is the PBX where the client tries to connect first.
;Secondary PBX: This is the PBX, where the client tries to connect, when the connection to the primary PBX failed.

=== Handling of connection loss ===
If the connection to the current PBX is lost:
* myApps tries to re-connect to the current PBX first.
* If the current PBX is unavailable it restarts connecting to the primary and secondary PBX in an alternating manner.

== Determination of primary and secondary PBX ==
On each successful connection in a non-standby case, myApps determines the primary and secondary PBX automatically and stores the information for handling standby cases.

=== Primary PBX ===

The PBX configured in the myApps client is used as the primary PBX.

=== Secondary PBX ===

There are different cases to be considered to determine the secondary PBX:
* In case the client was redirected to the PBX the user is configured on
** the explicit standby of this PBX is used as secondary PBX (if existing)
** this PBX is used as secondary PBX (otherwise)
* In case the client was not redirected but stayed on the primary PBX
** the explicit standby of the primary PBX is used as secondary PBX (if existing)
** the implicit standby of the primary PBX (the master for slave PBXes) is used as secondary PBX (if exisiting)
** no secondary PBX is used (otherwise)

== Published information for the softphone app ==
The myApps client publishes the determined configuration along with other connection details in the API model of com.innovaphone.client inside the <code>connInfo</code> object.

This information is used by the softphone app. See [[{{NAMESPACE}}:Concept_Softphone_Redundancy]] for details.

Example:

"connInfo": {
"up": true,
"standby": false,
"cur": "slave.example.com/PBX0",
"pri": "master.example.com/PBX0",
"sec": "slave.example.com/PBX0",
"phys": "master"
}

Values:
;up: true, if the connection is up. false if myApps is offline.
;standby: true, if the myApps client is connected to a standby PBX. false, if the myApps client is connected to the user's PBX.
;cur: the current PBX in the format host/pbx-module
;pri: the primary PBX in the format host/pbx-module
;sec: the secondary PBX in the format host/pbx-module
;phys: the physical location, if configured explicitly

== Configuration ==
For configuration in the myApps launcher, see [[{{NAMESPACE}}:Concept_myApps_platform_services#Server_configuration]].

In the browser the PBX specified by the URL is used as the primary PBX. An explicit physical location can be set using a URL parameter, see [[{{NAMESPACE}}:Concept_myApps#Supported_URL_Parameters]].

== Tracing ==
Trace flags
;Browser Console
: to see the connection flow including redirects and determined configuration

For trace flags for the softphone app see [[{{NAMESPACE}}:Concept_Softphone_Redundancy#Tracing]]

Reference14r2:MyApps Plugin for Virtual Desktops

2026-01-28T12:32:27Z

Sga: /* Recommendation for Linux Administrators (Audio) */

[[Category:Concept|Apps]]
== Description ==
A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.
Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
Video suffers from the same limitations.

The myApps Virtual Desktop Plugin enables media data to be transferred to the local client in terminal server environments.
== Applies To ==
* innovaphone PBX from version 14r2
* Client OS: Windows, Linux (Ubuntu 22 or 23, RangeeOS<ref>RangeeOS is listed due to a customer testimonial. No tests have been conducted by innovaphone. Tests were done using myapps 14r2sr3, RangeeOS Firmware 12.00 build 203 ff and Citrix Workspace 2311. (Workspace version 2402 & 2405 have a bug with USB redirection and 2408 is not starting reliably)</ref>, IGEL OS<ref>IGEL OS: available at [https://app.igel.com/myAppsPlugin/15.1.455+1 IGEL App Portal]</ref>) or MacOS operating systems
* Hypervisor OS: Citrix, Windows Terminal Server environments and VMWare Horizon<ref>VMWare Horizon OS is listed due to a customer testimonial. No tests have been conducted by innovaphone.</ref> 
<references/>

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

== Concept ==
The myApps Plugin at the client is in charge of all tasks related to the media streams and the management of the Audio/Video devices. For instance:
* start or stop an audio/video device
* gathering of the ICE candidates
* connect to a remote peer with the ICE protocol
* start a ringing device
* rendering of video

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

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

* [https://docs.citrix.com/en-us/citrix-virtual-apps-desktops/technical-overview/virtual-channels Citrix technical overview]
* [https://support.citrix.com/support-home/kbsearch/article?articleNumber=CTX691230 Citrix support article summary]
* [https://learn.microsoft.com/en-us/windows/win32/termserv/using-terminal-services-virtual-channels Microsoft Remote Desktop Services virtual channels]

=== Call signaling ===
The VDI Plugin has no connection to the PBX. Signaling is still done at the terminal server by the myApps client.

=== Audio transmission ===
The plugin connects Audio, ICE and DTLS directly to the other endpoint. Since Audio itself does not use virtual channels, the plugin on the client must be able [[Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#ICE_STUN_TURN|to reach the TURN/STUN server via port 3478]].

== Configuration ==
'''Citrix Workspace app must first be installed on all platforms. This is necessary because the myApps plugin must copy a .dll (Windows) / .so (MacOS/Linux) into the Citrix installation directory. '''
For this to work, the Citrix installation directory must be in the %ProgramFiles(x86)% or %ProgramFiles% directory.

=== Windows ===
The myApps Plugin .msi must be installed or deployed at the Thin-Client and does not require any configuration.

=== MacOS ===
Install the myAppsPlugin.dmg or .pkg at the Thin-Client and does not require any configuration.

=== Linux ===
Update your Linux PC first:

'''sudo apt-get update'''

Download latest Citrix Workspace App (Mar 7, 2024) for Debian and x86_64 platform:

'''https://www.citrix.com/downloads/workspace-app/linux/workspace-app-for-linux-latest.html'''

Citrix Workspace app needs '''libwebkit2gtk-4.0-37''' packet and this packet is not available in Ubuntu-24.04 version.

Install it at your Linux PC:

https://docs.citrix.com/en-us/citrix-workspace-app-for-linux/install.html

'''sudo apt install -f ./icaclient_<version>._amd64.deb'''

Install (or update) now the myApps Plugin:

'''sudo apt install -f ./myAppsPlugin.deb'''

Headset Buttons:

*Jabra: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-java.rules
**Add <code>ATTRS{idVendor}=="0b0e", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Epos: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-epos.rules
** Add <code>ATTRS{idVendor}=="1395", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Plantronics: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-plantronics.rules
** Add <code>ATTRS{idVendor}=="047f", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Snom: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-snom.rules
** Add <code>ATTRS{idVendor}=="251c", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Yealink: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-yealink.rules
** Add <code>ATTRS{idVendor}=="6993", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>

No additional configuration required.

=== Configuration on the Terminalserver ===
The Softphone App at the terminal server does not require any additional configuration.

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

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

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

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

== Known issues ==
* The audio module in the MyApps Plugin for Linux/IgelOS has no echo cancellation. It is therefore recommended to use a headset, as headsets usually have their own echo cancellers.
* Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client (only for the Windows Plugin)
* Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
**Video is displayed but with delay due to the rendering process.
**Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.
* When MyApps is used as a Citrix Published App, notification pop-ups cannot be displayed. This is because Citrix does not recognize the notifications as part of MyApps and therefore does not show them as part of the published app. If the full desktop is used in Citrix, the notifications function correctly.
* Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
* The MyApps Plugin for macOS supports only Citrix Workspace, the "Windows-App" from Microsoft is currently not supported
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client (only for the Windows Plugin)

==Troubleshooting==
If the problem still exists after trying the OS-specific hints below, open a support ticket and send a trace from the myApps client (remote) with App and Browser option. Please send also all myAppsPlugin-x.txt and myAppsRemote-x.txt trace files from the myApps-plugin on the local PC.

=== Troubleshooting Windows ===
If Citrix is used as a terminal server environment:
#Citrix must be installed '''BEFORE''' the plugin
#Check in "C:/program files/Citrix/ICA Client" folder, there is the .dll myAppscitrixremoteserviesvc.dll
#Check in the registry, that: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\ICA 3.0 is there. "VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin
#In Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\ICA Client\Engine\Configuration\Advanced\Modules\InnovaphoneCitrixPlugin as Drivename and DrivenameWin32 you should find the .dll as value and as innovaphone path the path of the plugin for the file myAppsplugin

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

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

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

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

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

'''Disable Echo Canceler (Windows PC)'''

Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps einen neuen Eintrag erstellen:

Type: DWORD (REG_DWORD)

Name: disableEchoCanceller

Value: 1 ( or use, Value: 0 to enable the Echo Canceller)

=== Troubleshooting Linux ===

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

Innovaphone Plugin is installed under /opt/innovaphone/'''myAppsPlugin''' and in /opt/Citrix/ICAClient/'''myAppsCitrixPlugin.so'''

myAppsCitrixPlugin.so library is called by the Citrix Workspace App and this library opens the myAppsPlugin.

There is a file in the Citrix installation called module.ini (/opt/Citrix/ICAClient/config/module.ini). Inside this file the myApps Citrix Plugin library is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with '''myAppsCitrixPlugin=On''' must exist and

Following directory '''/var/log/apps/myAppsPlugin/''' must also exist for the log files with write permission for everyone (drwxrwxrwx)

====Audio Quality issues (e.g. choppy audio)====
If you run into audio quality when using myapps on Linux, the following configuration is recommended:

* Use PulseAudio as the audio server
* Set the system-wide sample rate (default 44.1 kHz) to 48 kHz, since most USB headsets (e.g. Jabra) operate at 48 kHz.

You need to apply settings on OS level, since the audio backend and sample rate are operating system settings and cannot be controlled by the application.

You can check the Active audio server and sample rate with the following command:

<code>pactl info</code>

Based on your language-settings you will get a different output.
But you want to look for something like "Server Name" and "Default-Sample-Specification".

The expected results are (Language set to English):

Server Name: pulseaudio
Default Sample Specification: s16le 2ch 48000Hz

=== Troubleshooting MacOS ===

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

In /Library/Application Support/Citrix/PlugIns

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

under:

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

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

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

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

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

=== Troubleshooting Citrix ===
A Virtual Channel Policy must be added to the Registry at the '''Citrix Server''':

Create '''VCPolicies''' folder under '''HKLM/Software/Policies/Citrix''' if it does not exist.

Create '''VCPolicies''' folder under '''HKLM/Software/WOW6432Node/Policies/Citrix''' if it does not exist.

Create a REG_MULTI_SZ entry with the name '''VirtualChannelWhiteList'''. This entry must contain as value: '''INNOHDX,C:\Program Files (x86)\innovaphone\myApps\myApps.exe'''

=== Troubleshooting RTP Stream ===

You can analyze the RTP stream with the switch "--record-rtp-stream"

* RTP reception after Echo Canceller and JitterBuffer
* Audio from microphone and send to RTP

You have to start the myApps client as follows: myApps.exe --record-rtp-stream

After the call, you can find the audio files in the folder: C:\Users\...\AppData\Local\innovaphone\myApps

Tool to listen to the RTP stream: Audacity

Go to: File / Import / Raw Data and open the Folder with the Rtp stream and select the file.

For RTP-Send and RTP-Recv Data, use the Audio Codec G711 -> A-Law and 8000

For the Wave-in (out) Data Use Signed 16-bit PCM and 8000 Abtastrate

== Related Articles ==

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

Reference16r1:Concept App Service Transcriptions

2026-01-27T15:14:22Z

Sga: /* Transcriptions - App Service */

{{FIXME|reason=This article is still work in progress}}
[[Category:Concept|Apps]]
[[Category:Concept App Service Transcriptions]]
== Applies To ==

* innovaphone from version 16r1

== Overview ==

== Licensing ==

== Installation ==
Go to the '''Settings App''' (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 '''"Transcriptions"''' and click on it
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) again in order to refresh the list of the available colored AP plugin
* Click on the '''"AP transcriptions"''' and click on '''" + Add an App"''' and then on the '''"Transcriptions API"''' button.
* 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: Transcriptions API, SIP: transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Implements the API to a remote transcription server (e.g. whisper)

It can be configured in the '''Settings App''' (PBX Manager App) [[Reference16r1:Apps/PbxManager/App_myApps_Transcriptions]]

== Transcriptions App ==
Apart from offering the transcriptions API the service also offers the Transcriptions App. Here you may upload audio files and receive the transcript of it.

You may also create a simple summary for the transcript and print it as PDF (very simple version)
[[File:ReferenceConceptTranscriptionsAppServiceTranscriptionsApp.png|thumb|Transcriptions App|/ReferenceConceptTranscriptionsAppServiceTranscriptionsApp.png]]

== Troubleshooting ==

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

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.transcriptions/com.innovaphone.transcriptions.htm SDK Documentation - Transcriptions API]
* [[Reference16r1:Apps/PbxManager/App_myApps_Transcriptions]]

Reference16r1:Concept App Service Transcriptions

2026-01-12T16:56:38Z

Sga: /* Installation */

{{FIXME|reason=This article is still work in progress}}
[[Category:Concept|Apps]]
[[Category:Concept App Service Transcriptions]]
== Applies To ==

* innovaphone from version 16r1

== Overview ==

== Licensing ==

== Installation ==
Go to the '''Settings App''' (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 '''"Transcriptions"''' and click on it
* Select the proper firmware version, for example '''"Version 16r1"''' 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 reopen the '''Settings App''' (PBX manager) again in order to refresh the list of the available colored AP plugin
* Click on the '''"AP transcriptions"''' and click on '''" + Add an App"''' and then on the '''"Transcriptions API"''' button.
* 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: Transcriptions API, SIP: transcriptions-api''
* Choose a LLM (model) from the dropdown
* Tick the appropriate template to distribute the App (the app is needed at every user object from any user who wants to use the assistant API)
* Click OK to save the settings and a green check mark will be shown to inform you that the configuration is good

== Transcriptions - App Service ==
The App Service performs tasks in the following areas:
* Implements the API to a remote transcription server (e.g. whipser)

It can be configured in the '''Settings App''' (PBX Manager App) [[Reference16r1:Apps/PbxManager/App_myApps_Transcriptions]]

== Troubleshooting ==

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

== Related Articles ==
* [https://sdk.innovaphone.com/16r1/web1/com.innovaphone.transcriptions/com.innovaphone.transcriptions.htm SDK Documentation - Transcriptions API]

Reference13r2:Gateway/Interfaces/SIP

2025-10-29T12:50:04Z

Sga: /* More frequently used Advanced Parameters */

== SIP Registration section ==
The entry fields for a '''SIP registration''' are:
{|
|valign=top nowrap=true|'''Name'''
|Descriptive name for this registration.
|-
|valign=top nowrap=true|'''Disable'''
|A switch to temporarily disable this interface without deleting the configuration.
|-
|valign=top nowrap=true|'''Type'''
|
*Provider: Creates a registration at a remote SIP server (of a SIP provider)
*Open Federation: SIP/TLS interface without registration used to send and receive calls to federation partners.
*Closed Federation: Like 'Open Federation' but even more restricted to pre-configured set of federation partners. In the 'Closed Federation' mode, the DNS queries for resolving the domain name of the federation partner are made without the '''Recursion Desired''' (RD) Flag. This means only DNS entries configured on the local DNS server are resolved, so the list of the partners for 'Closed Federation' must be maintained on the local DNS server.
|-
|valign=top nowrap=true|'''Transport'''
|
*UDP: SIP signaling using UDP as transport protocol (RFC 3261).
*TCP: SIP signaling using TCP as transport protocol (RFC 3261).
*TLS: SIP signaling using TLS as transport protocol (RFC 3261). [[Howto:Security works with innovaphone]]
*Without registration: By default sip trunks are using with registration. Can be disabled here.
|-
|valign=top nowrap=true|'''AOR'''
|Address of Record: SIP-URI used to register. Enter the registration ID followed by the SIP provider domain name (for example 8111111e0@sipgate.de or 8111111e0@x.x.x.x:5080 if you need to use the IP-address and a different Port number).
|-
|valign=top nowrap=true|'''Local Hostname'''
|The Local Domain for SIP Federation enables to select the TLS Certificate according to the Domain Name. On the incoming SIP calls the host part of the URI is removed if equals with the Local Domain configured here, and the user part is used as Name (H323-ID) or Number (E164).
|-
|valign=top nowrap=true|'''Local Port'''
|The local source port for SIP signalling can be configured here. If its empty a random port will be used. ''Dont use the same static port on multiple SIP Accounts!''
|-
|valign=top nowrap=true|'''Proxy'''
|DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination. (append ":<port>" if you need a different destination Port)
|-
|valign=top nowrap=true|'''STUN Server'''
|The STUN servers to use. See [[{{NAMESPACE}}:IP4/General/STUN | STUN]] for details regarding the format.
|}

== Authorization ==
Username and password for authorization. Username can be omitted if equal to userpart of AOR.

== Media Properties ==

The configuration of the media properties is evaluated for calls from/to this interface to/from a physical (ISDN, analog, TEST, ...) only. If media relay is active for a call using this interface an 'exclusive' coder config is used to prohibit the use of any other coder. This 'exclusive code media-relay' config can be used to solve interop problems with other equipment which does not support media renegotiation, because with this config no media renegotiation will be performed.

For more information see [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]] and [[Howto:Security works with innovaphone]]

== SIP Interop Tweaks ==

{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-

|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls .
*'''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header).
*'''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only.
*'''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number.
*'''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string.
*'''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id) sent on outgoing calls
*'''CGPN in user part of URI''': Variable Identity-URI with actual calling party number
*'''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number
*'''UUI''': the relayed call must include ''user-to-user-info'' (UUI). This UUI is used as Identity-URI. [[Howto:How_to_customize_the_From/Identity_header_value_at_SIP_interfaces|In the UUI]], the string <code>{initiator}</code> is replaced by the the call's ''diversion-info'' (a.k.a. ''leg-2-info'') if available or the calling party number otherwise
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262).
*'''Supported''': Supported as optional extension.
*'''Required''': Required as mandatory extension.
*'''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Advanced'''
|Allows the configuration of additional, not further documented, interop tweaks(e.g. /pai on). The same tweaks can be configured also globally(i.e. not for this SIP-Interface) at the SIP(or TSIP/SIPS)-module. Any tweaks configured at the SIP-Interface will overwrite globally configured tweaks.
|}

=== More frequently used ''Advanced'' Parameters ===
There are some options which influence the stack behaviour to handle ambiguities in the SIP standard:

; /pai on : send identity URI in <code>P-Asserted-Identity</code> header. By default, it is sent in the <code>P-Asserted-Identity</code> header for calls from the PBX to the endpoint, in the <code>P-Preferred-Identity</code> header otherwise
; /ppi on : send identity URI in <code>P-Preferred-Identity</code> header

Other options are available which instruct the stack to use non-standard or deprecated behaviour. Note that this should only be used in rare cases. Better have the vendor of your 3rd party SIP equipment fix its stack implementation:

; /send-deprecated-diversion-header on : send call history information in the deprecated <code>Diversion</code> header in addition to the <code>History-Info</code> header
; /single-audio-description : don't send SAVP+AVP, but SAVP or AVP media description in SDP
; /no-authentication-info : don't send <code>Authentication-Info</code> header in REGISTER response
; /send-no-historyinfo : don't send call history information (i.e. call forward) in outgoing Invite
; /contact-addr [option] : adjust the Contact header to a fixed value necessary in scenarios of SIP Provider trunk without registration using TCP/TLS and uses Contact Header for Authentication. Example /contact-addr x.x.x.x:5061;user=phone;transport=TLS
; /options-interval n : Send SIP options every "n" seconds to the configured remote SIP Address configured on the Interface.
; /get-cdpn-from-to-uri : get CDPN of incoming provider-calls from To-URI instead of Request-URI
; /prefer-pai : get CGPN from PAI/PPI/RPID if present
; /no-diverting-name: don't add display name to diverting party URI
; /installed-certificate: for SIP/TLS trunks where the installed certificate should be used instead of the build-in device certificate

=== Extra Options ===
{{3rd_Party_Input}}

==== Disable Interworking of Hold Notifications to SIP Provider ====

During the tests we concluded that when interworking the hold-notify message to SIP and sending to the SIP Provider two consecutive Re-Invites with "send-only" attributes, the IMS platform replies to the second re-invite with "inactive". By doing so this call is put on hold without any Music on Hold - just silence.
To avoid this behaviour we need to disable the interworking of the hold-notify message by this setting:

!config add SIP /no-hr-notify (Alternative: TSIP / SIPS)
!config write
!config activate

==== SIP Options Interval (Optional) ====

Some Provider uses SIP Options to monitor the SIP Trunks, so it's mandatory that Innovaphone replies to incoming SIP Options received. This is done by default. Additionally we can also send SIP Options to the SIP Proxy and have similar mechanism for redundancy. If the remote Proxy doesn't reply to outgoing SIP Options, the Innovaphone Gateway will send the call to the next interface. To enable sending of Options - messages, the following setting must be done:

!config add SIP /options-interval 30 (Alternative: TSIP / SIPS)
!config write
!config activate

This option will only take effect on connections "without registration". In connections with a registration there already exist a keep alive.

==== Remove Comfort Noise (CN) Capability from SDP ====

During the tests we found out that some specific 3rd party devices connected to the IMS network support only a single coder/payload in the offer. When doing the coder negotiation, this devices repeat the coder negotiation until they have only 1 coder in the offer or until they reach a specific number of retries. Since Innovaphone by default always include the payload 13 (Comfort Noise) in addition to the used voice coder/payload, this would make the remote device to do multiple re-invites to try to reach the single coder/payload in the offer.
To avoid unnecessary signalling, we should disable the sending of Comfort Noise capability.

!config add SIP /rem-cn-capability (Alternative: TSIP / SIPS)
!config write
!config activate

==== Setting of P-Asserted ID instead of P-Preferred ID ====

When using the feature of ReRouting the call (SIP 302 Move Temporary) to the SIP Trunk, the IMS platform checks the P-Asserted ID setting. By default we send as P-Preferred ID instead, so that will not work. As a result, we need to configure the following setting:

!config add SIP /pai (Alternative: TSIP / SIPS)
!config write
!config activate

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-10-21T15:12:27Z

Sga: /* After update endpoint no longer registers to the PBX */

== Applies To ==
This information applies to:

* All 15r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 15r1, 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 V15 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Here is how you upgrade a system from 14r2 to 15r1.

Before you begin, be sure that your whole installation is running the latest 14r2 service release. 

=== AP Upgrade to Image 130006 ===
* Please Upgrade as first your Application Platform to Image Version 130006. After that you can go ahead.
* Before you begin, be sure that your Upgrade as first your Application Platform to Image Version 130006. After that you can go ahead.. 

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

=== App Platform on CF card (IPxx10) ===
Make sure that no App Platform is installed on a CF card, as this function is removed with the update.
Migrate the App Platform to a gateway with SSD or as a virtual machine before the update.

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

* '''myApps''': New UI design. In new installations users will see an intro video when logging in the first time.
* '''myApps iOS/Android''': You will find a new Version without the Major Version in the icon. Starting with V15, the client no longer needs to be replaced in the future.
* '''Phone App and Softphone App''': [[ReleaseNotes15r1:Firmware#192745 - Phone App and Softphone App: New UI design|New UI design]]
* '''Switchboard App''': See list of improvements in the [[Reference15r1:Concept App Service Queues#V15 Improvements|Concept App Service Queues Article]]
* '''Connect App''': New version with many new features. See list of improvements in the [[Reference15r1:Concept App Connect|connect article]].
* '''Chat App''': The chat app for persistent chat is now integrated in the connect app. More information in the [[Reference15r1:Concept App Connect#Chat|connect article]].
* '''Fax App settings plugin''': The admin can now set [[Reference15r1:Apps/PbxManager/App Fax#Default settings for mail notifications|default settings for mail notifications]] for the user specific/group fax app.
* '''Contacts App''': Contacts now has a new start screen, vCard Files can now be imported and exported, as well as there were made some User-Interface improvements. For more information, see [[Reference15r1:Concept App Service Contacts#15r1 Features|here]].
* '''Devices App''':OTA (Over the Air) Features for dect systems can now be [[Reference15r1:IP1202/IP1203 DECT System#OTA (Over the Air) Features|configured]].

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

=== myApps ===
* To configure an optional intro that is shown when user login the first time, see: [[Reference15r1:Concept_myApps#Onboarding]]

=== Techassist App ===
* You have to enable the API "PbxSignal" in the APP Objects "App" Tab

=== myApps iOS/Android ===
* You must install the new app without the major version in the icon. (Starting with V15, the client no longer needs to be replaced in future).
** iOS: https://apps.apple.com/us/app/innovaphone-myapps/id6739562892
** Android: https://play.google.com/store/apps/details?id=com.innovaphone.myapps

=== IPVA VMWare Fault Tolerance ===
* With 15r1 you can use again the VMWare Fault Tolerance Feature. If you want to re-enable this feature you have to [[Howto15r1:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance|setup a new IPVA-SCSI]] and export/import your configuration to the new machine.

=== Working App ===

* With 15r1, it is necessary to specify the master PBX in the Settings plugin under "Configuration"

=== Connect ===

* You need to enable "impersonation" at all Connect app objects in order to make chat work correctly. Otherwise, chat messages will not be received from the target user.
* A new mode "admin-service" needs to be add in order to allow other apps (like Projects) to create posts in connect.

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

=== Projects App ===
* Concept Article: [[Reference15r1:Concept App Service Projects|Concept App Service Projects]]

=== Virtual Background App ===
* Concept Article: [[Reference15r1:Concept Virtual Background App|Concept Virtual Background App]]

=== Remote Control Client msi application for external participants ===
* Concept Article [[Reference15r1:Concept App Remote Control|Concept App Remote Control]]

=== Assistant App ===
* Concept Article [[Reference15r1:Concept App Service myApps Assistant#Assistant App|Concept Assistant App]]

‎<onlyinclude>

== Good2Know ==

=== PBXManager ===
“PBX Manager” is now called “Settings”

=== Exchange Online calendar integration — Calendar App / Connector for Microsoft 365 ===
In the past, Microsoft has announced the end of support for Exchange Online EWS support in 2026:

https://techcommunity.microsoft.com/blog/exchange/retirement-of-exchange-web-services-in-exchange-online/3924440

Since the Calendar App uses EWS to synchronize calendar events from Exchange Online to the PBX, this feature will stop working from then on.

Microsoft suggests switching to the Graph API for this functionality and since we already have an app that works with the Graph API, we have extended the feature set of the Connector for Microsoft 365.

In addition to the initial functionality of synchronizing line states and presences bi-directionally between the Azure Portal (Teams) and the PBX, the Connector for Microsoft 365 can now also retrieve calendar events and integrate them into the PBX.

The Connector for Microsoft 365 requires a valid licence for each user.

The Exchange Online functionality of the Calendar App will no longer be enhanced or improved, but the current functionality will be included for as long as Microsoft continues to support EWS for Exchange Online.

The on-premise functionality is not affected by this and will remain in the Calendar App.

''As both apps integrate Exchange Online calendar events in the same way, it is not recommended or supported to use both calendar integrations at the same time.''

''However, you can use the Connector for Microsoft 365 for presence and line state synchronization and the Calendar App for calendar event integration.''

=== Federation ===
Beginning with 15r1 the certificate or CA of the certificate of the client device '''must''' be in the trust list of the RP/gateway or else, federation doesn't work anymore.

=== Devices App: Evaluation of PBX User Rights ===
When a PBX user with [[Reference9:PBX/Objects/Edit_Rights|administrative rights]] accesses the Devices App, their PBX rights are enforced. As a result, only the PBX-related pages permitted by the user's rights can be modified.
However, PBX rights do not apply to other modules (e.g. IP configuration). This means that users retain full administrative access to non-PBX-related functions within the Devices App, regardless of their PBX rights.
Additionally, in the syslog the administrative changes now also contain a user ID and the remote IP address if the Devices App is used.
‎</onlyinclude>

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

* running an App Platform on the CF card of an IPxx10 gateway (Removed, migrate to a gateway with an SSD or a Virtual Machine to run the App Platform)
* Audio codec software transcoding to G.729 removed on: IP11x, IP10x, myApps, DECT-Radios. Only the conversion to G.729 has been removed, not the playback of already converted g.729 audio files such as an MOH or voicemail announcements. These can still be played.

== 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. 
See: [[Howto14r2:Firmware_Upgrade_V14r1_V14r2#Deprecated]] 
We strongly recommend migrating to our successor products.

* iQM (innovaphone Queue Monitor) - Migrate to the [[Howto:Queueboard - MediaRunway - Partner App|Queueboard App]]. For existing innovaphone QueueMonitor licences, the corresponding MediaRunway Queueboard licences can be downloaded via portal.innovaphone.

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

===App Platform doesn't boot after Upgrade===
If you didn't upgrade the AP Image before upgrading the apps like describe [[#AP_Upgrade_to_Image_130006|here]] and the AP isn't reachable via http(s), but still via ssh, please follow these [[Reference14r2:Concept_App_Platform#It_still_doesn't_start|instructions]] to get the AP work correct again.

===Downgrade of Devices App from 15r1 to 14r2===
The database schema for update jobs in the Devices App has changed between versions 14r2 and 15r1. If you need to downgrade from 15r1 back to 14r2, you must delete all 15r1 update jobs before.

Failing to do so will cause the 14r2 Devices App to crash on startup. In that case, you will need to restore a 14r2 backup of the Devices App.

===After update endpoint no longer registers to the PBX ===
An incoming registration to a PBX is incorrectly identified as coming from/over the reverse proxy when the certificate sent by the registering endpoint matches a certificate mentioned in the reverse proxy addresses of the PBX, regardless of the IP address associated with this certificate in the 'PBX/Config/General/Reverse Proxy Addresses' list. The registration is rejected then, if the device at the PBX-object has no ''Reverse Proxy'' Flag.

For example, this often occurs with slave/standby PBXs if a wildcard certificate is used for registration and this wildcard certificate is also mentioned in the 'PBX/Config/General/Reverse Proxy Addresses' list. 

'''Solution 1''': Remove the wildcard-certificate from the Reverse Proxy-list '''or''' 
'''Solution 2''': Configure a strong password on the PBX-object and change the endpoint registration from 'H323/TLS' to 'H323/TCP' (and so with password).
'''or''' 
'''Solution 3''': Activate the ''Reverse Proxy'' Flag at the PBX-object

== Resources Considerations ==
New firmware always has more features which in turn requires more resources. Growing firmware will thus consume both more flash and RAM for sure. A given system configuration will run flawlessly after a firmware largely only if there is still enough memory left after boot.

Standard configurations which are according the specs will run on all supported hardware. However, unusual configurations may not. It is a good idea to examine both flash and RAM memory left on high load situations in your existing configuration to see if there is enough resources left for an upgrade. Please find details in Reference:Device Health Check.

=== RAM ===
As a rough rule of thumb, a 15r1 release will consume the same amount of RAM compared to a v14r2 firmware.

=== Flash Memory ===
As a rough rule of thumb, a v15r1 release will consume ~ 64KB flash memory compared to a v14r2 firmware.
New firmware comes with new code for new features which consumes more flash memory for the firmware image. For this reason, devices may run out of flash memory during upgrade to v15r1. Here is the recommended procedure for upgrade on such devices:

* save entire configuration
* reset to factory defaults
* load saved configuration (this will reorganize the flash memory usage)
* upgrade to new firmware

When there is still not enough flash memory available to store the new firmware (Web GUI ends up in a ''Firmwareupdate failed:no space'' / Update client end in a ''Error 0x00130001 Major FLASHMAN0 no space'' event) please open a support case with your current configuration file.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]
* [[Howto16r1:Firmware_Upgrade_V15r1_V16r1]]
[[Category:Howto|{{PAGENAME}}]]

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-10-21T15:02:37Z

Sga: /* Slave/Standby-PBXs no longer register to the Master-PBX */

== Applies To ==
This information applies to:

* All 15r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 15r1, 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 V15 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Here is how you upgrade a system from 14r2 to 15r1.

Before you begin, be sure that your whole installation is running the latest 14r2 service release. 

=== AP Upgrade to Image 130006 ===
* Please Upgrade as first your Application Platform to Image Version 130006. After that you can go ahead.
* Before you begin, be sure that your Upgrade as first your Application Platform to Image Version 130006. After that you can go ahead.. 

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

=== App Platform on CF card (IPxx10) ===
Make sure that no App Platform is installed on a CF card, as this function is removed with the update.
Migrate the App Platform to a gateway with SSD or as a virtual machine before the update.

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

* '''myApps''': New UI design. In new installations users will see an intro video when logging in the first time.
* '''myApps iOS/Android''': You will find a new Version without the Major Version in the icon. Starting with V15, the client no longer needs to be replaced in the future.
* '''Phone App and Softphone App''': [[ReleaseNotes15r1:Firmware#192745 - Phone App and Softphone App: New UI design|New UI design]]
* '''Switchboard App''': See list of improvements in the [[Reference15r1:Concept App Service Queues#V15 Improvements|Concept App Service Queues Article]]
* '''Connect App''': New version with many new features. See list of improvements in the [[Reference15r1:Concept App Connect|connect article]].
* '''Chat App''': The chat app for persistent chat is now integrated in the connect app. More information in the [[Reference15r1:Concept App Connect#Chat|connect article]].
* '''Fax App settings plugin''': The admin can now set [[Reference15r1:Apps/PbxManager/App Fax#Default settings for mail notifications|default settings for mail notifications]] for the user specific/group fax app.
* '''Contacts App''': Contacts now has a new start screen, vCard Files can now be imported and exported, as well as there were made some User-Interface improvements. For more information, see [[Reference15r1:Concept App Service Contacts#15r1 Features|here]].
* '''Devices App''':OTA (Over the Air) Features for dect systems can now be [[Reference15r1:IP1202/IP1203 DECT System#OTA (Over the Air) Features|configured]].

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

=== myApps ===
* To configure an optional intro that is shown when user login the first time, see: [[Reference15r1:Concept_myApps#Onboarding]]

=== Techassist App ===
* You have to enable the API "PbxSignal" in the APP Objects "App" Tab

=== myApps iOS/Android ===
* You must install the new app without the major version in the icon. (Starting with V15, the client no longer needs to be replaced in future).
** iOS: https://apps.apple.com/us/app/innovaphone-myapps/id6739562892
** Android: https://play.google.com/store/apps/details?id=com.innovaphone.myapps

=== IPVA VMWare Fault Tolerance ===
* With 15r1 you can use again the VMWare Fault Tolerance Feature. If you want to re-enable this feature you have to [[Howto15r1:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance|setup a new IPVA-SCSI]] and export/import your configuration to the new machine.

=== Working App ===

* With 15r1, it is necessary to specify the master PBX in the Settings plugin under "Configuration"

=== Connect ===

* You need to enable "impersonation" at all Connect app objects in order to make chat work correctly. Otherwise, chat messages will not be received from the target user.
* A new mode "admin-service" needs to be add in order to allow other apps (like Projects) to create posts in connect.

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

=== Projects App ===
* Concept Article: [[Reference15r1:Concept App Service Projects|Concept App Service Projects]]

=== Virtual Background App ===
* Concept Article: [[Reference15r1:Concept Virtual Background App|Concept Virtual Background App]]

=== Remote Control Client msi application for external participants ===
* Concept Article [[Reference15r1:Concept App Remote Control|Concept App Remote Control]]

=== Assistant App ===
* Concept Article [[Reference15r1:Concept App Service myApps Assistant#Assistant App|Concept Assistant App]]

‎<onlyinclude>

== Good2Know ==

=== PBXManager ===
“PBX Manager” is now called “Settings”

=== Exchange Online calendar integration — Calendar App / Connector for Microsoft 365 ===
In the past, Microsoft has announced the end of support for Exchange Online EWS support in 2026:

https://techcommunity.microsoft.com/blog/exchange/retirement-of-exchange-web-services-in-exchange-online/3924440

Since the Calendar App uses EWS to synchronize calendar events from Exchange Online to the PBX, this feature will stop working from then on.

Microsoft suggests switching to the Graph API for this functionality and since we already have an app that works with the Graph API, we have extended the feature set of the Connector for Microsoft 365.

In addition to the initial functionality of synchronizing line states and presences bi-directionally between the Azure Portal (Teams) and the PBX, the Connector for Microsoft 365 can now also retrieve calendar events and integrate them into the PBX.

The Connector for Microsoft 365 requires a valid licence for each user.

The Exchange Online functionality of the Calendar App will no longer be enhanced or improved, but the current functionality will be included for as long as Microsoft continues to support EWS for Exchange Online.

The on-premise functionality is not affected by this and will remain in the Calendar App.

''As both apps integrate Exchange Online calendar events in the same way, it is not recommended or supported to use both calendar integrations at the same time.''

''However, you can use the Connector for Microsoft 365 for presence and line state synchronization and the Calendar App for calendar event integration.''

=== Federation ===
Beginning with 15r1 the certificate or CA of the certificate of the client device '''must''' be in the trust list of the RP/gateway or else, federation doesn't work anymore.

=== Devices App: Evaluation of PBX User Rights ===
When a PBX user with [[Reference9:PBX/Objects/Edit_Rights|administrative rights]] accesses the Devices App, their PBX rights are enforced. As a result, only the PBX-related pages permitted by the user's rights can be modified.
However, PBX rights do not apply to other modules (e.g. IP configuration). This means that users retain full administrative access to non-PBX-related functions within the Devices App, regardless of their PBX rights.
Additionally, in the syslog the administrative changes now also contain a user ID and the remote IP address if the Devices App is used.
‎</onlyinclude>

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

* running an App Platform on the CF card of an IPxx10 gateway (Removed, migrate to a gateway with an SSD or a Virtual Machine to run the App Platform)
* Audio codec software transcoding to G.729 removed on: IP11x, IP10x, myApps, DECT-Radios. Only the conversion to G.729 has been removed, not the playback of already converted g.729 audio files such as an MOH or voicemail announcements. These can still be played.

== 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. 
See: [[Howto14r2:Firmware_Upgrade_V14r1_V14r2#Deprecated]] 
We strongly recommend migrating to our successor products.

* iQM (innovaphone Queue Monitor) - Migrate to the [[Howto:Queueboard - MediaRunway - Partner App|Queueboard App]]. For existing innovaphone QueueMonitor licences, the corresponding MediaRunway Queueboard licences can be downloaded via portal.innovaphone.

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

===App Platform doesn't boot after Upgrade===
If you didn't upgrade the AP Image before upgrading the apps like describe [[#AP_Upgrade_to_Image_130006|here]] and the AP isn't reachable via http(s), but still via ssh, please follow these [[Reference14r2:Concept_App_Platform#It_still_doesn't_start|instructions]] to get the AP work correct again.

===Downgrade of Devices App from 15r1 to 14r2===
The database schema for update jobs in the Devices App has changed between versions 14r2 and 15r1. If you need to downgrade from 15r1 back to 14r2, you must delete all 15r1 update jobs before.

Failing to do so will cause the 14r2 Devices App to crash on startup. In that case, you will need to restore a 14r2 backup of the Devices App.

===After update endpoint no longer registers to the PBX ===
An incoming registration to a PBX is incorrectly identified as coming from/over the reverse proxy when the certificate sent by the registering endpoint matches a certificate mentioned in the reverse proxy addresses of the PBX. For example, this often occurs with slave/standby PBXs if a wildcard certificate is used for registration and this wildcard certificate is also mentioned in the 'PBX/Config/General/Reverse Proxy Addresses' list. 

'''Solution 1''': Remove the wildcard-certificate from the Reverse Proxy-list '''or''' 
'''Solution 2''': Configure a strong password on the PBX-object and change the endpoint registration from 'H323/TLS' to 'H323/TCP' (and so with password).

== Resources Considerations ==
New firmware always has more features which in turn requires more resources. Growing firmware will thus consume both more flash and RAM for sure. A given system configuration will run flawlessly after a firmware largely only if there is still enough memory left after boot.

Standard configurations which are according the specs will run on all supported hardware. However, unusual configurations may not. It is a good idea to examine both flash and RAM memory left on high load situations in your existing configuration to see if there is enough resources left for an upgrade. Please find details in Reference:Device Health Check.

=== RAM ===
As a rough rule of thumb, a 15r1 release will consume the same amount of RAM compared to a v14r2 firmware.

=== Flash Memory ===
As a rough rule of thumb, a v15r1 release will consume ~ 64KB flash memory compared to a v14r2 firmware.
New firmware comes with new code for new features which consumes more flash memory for the firmware image. For this reason, devices may run out of flash memory during upgrade to v15r1. Here is the recommended procedure for upgrade on such devices:

* save entire configuration
* reset to factory defaults
* load saved configuration (this will reorganize the flash memory usage)
* upgrade to new firmware

When there is still not enough flash memory available to store the new firmware (Web GUI ends up in a ''Firmwareupdate failed:no space'' / Update client end in a ''Error 0x00130001 Major FLASHMAN0 no space'' event) please open a support case with your current configuration file.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]
* [[Howto16r1:Firmware_Upgrade_V15r1_V16r1]]
[[Category:Howto|{{PAGENAME}}]]

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-10-20T12:20:27Z

Sga: /* Known Problems */

== Applies To ==
This information applies to:

* All 15r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 15r1, 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 V15 in https://portal.innovaphone.com/ and load into the system before upgrade (The system needs to have the SSC up to date).

== Migration Policy ==
Here is how you upgrade a system from 14r2 to 15r1.

Before you begin, be sure that your whole installation is running the latest 14r2 service release. 

=== AP Upgrade to Image 130006 ===
* Please Upgrade as first your Application Platform to Image Version 130006. After that you can go ahead.
* Before you begin, be sure that your Upgrade as first your Application Platform to Image Version 130006. After that you can go ahead.. 

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

=== App Platform on CF card (IPxx10) ===
Make sure that no App Platform is installed on a CF card, as this function is removed with the update.
Migrate the App Platform to a gateway with SSD or as a virtual machine before the update.

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

* '''myApps''': New UI design. In new installations users will see an intro video when logging in the first time.
* '''myApps iOS/Android''': You will find a new Version without the Major Version in the icon. Starting with V15, the client no longer needs to be replaced in the future.
* '''Phone App and Softphone App''': [[ReleaseNotes15r1:Firmware#192745 - Phone App and Softphone App: New UI design|New UI design]]
* '''Switchboard App''': See list of improvements in the [[Reference15r1:Concept App Service Queues#V15 Improvements|Concept App Service Queues Article]]
* '''Connect App''': New version with many new features. See list of improvements in the [[Reference15r1:Concept App Connect|connect article]].
* '''Chat App''': The chat app for persistent chat is now integrated in the connect app. More information in the [[Reference15r1:Concept App Connect#Chat|connect article]].
* '''Fax App settings plugin''': The admin can now set [[Reference15r1:Apps/PbxManager/App Fax#Default settings for mail notifications|default settings for mail notifications]] for the user specific/group fax app.
* '''Contacts App''': Contacts now has a new start screen, vCard Files can now be imported and exported, as well as there were made some User-Interface improvements. For more information, see [[Reference15r1:Concept App Service Contacts#15r1 Features|here]].
* '''Devices App''':OTA (Over the Air) Features for dect systems can now be [[Reference15r1:IP1202/IP1203 DECT System#OTA (Over the Air) Features|configured]].

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

=== myApps ===
* To configure an optional intro that is shown when user login the first time, see: [[Reference15r1:Concept_myApps#Onboarding]]

=== Techassist App ===
* You have to enable the API "PbxSignal" in the APP Objects "App" Tab

=== myApps iOS/Android ===
* You must install the new app without the major version in the icon. (Starting with V15, the client no longer needs to be replaced in future).
** iOS: https://apps.apple.com/us/app/innovaphone-myapps/id6739562892
** Android: https://play.google.com/store/apps/details?id=com.innovaphone.myapps

=== IPVA VMWare Fault Tolerance ===
* With 15r1 you can use again the VMWare Fault Tolerance Feature. If you want to re-enable this feature you have to [[Howto15r1:Implement PBX with zero downtime using IPVA and VMWare Fault Tolerance|setup a new IPVA-SCSI]] and export/import your configuration to the new machine.

=== Working App ===

* With 15r1, it is necessary to specify the master PBX in the Settings plugin under "Configuration"

=== Connect ===

* You need to enable "impersonation" at all Connect app objects in order to make chat work correctly. Otherwise, chat messages will not be received from the target user.
* A new mode "admin-service" needs to be add in order to allow other apps (like Projects) to create posts in connect.

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

=== Projects App ===
* Concept Article: [[Reference15r1:Concept App Service Projects|Concept App Service Projects]]

=== Virtual Background App ===
* Concept Article: [[Reference15r1:Concept Virtual Background App|Concept Virtual Background App]]

=== Remote Control Client msi application for external participants ===
* Concept Article [[Reference15r1:Concept App Remote Control|Concept App Remote Control]]

=== Assistant App ===
* Concept Article [[Reference15r1:Concept App Service myApps Assistant#Assistant App|Concept Assistant App]]

‎<onlyinclude>

== Good2Know ==

=== PBXManager ===
“PBX Manager” is now called “Settings”

=== Exchange Online calendar integration — Calendar App / Connector for Microsoft 365 ===
In the past, Microsoft has announced the end of support for Exchange Online EWS support in 2026:

https://techcommunity.microsoft.com/blog/exchange/retirement-of-exchange-web-services-in-exchange-online/3924440

Since the Calendar App uses EWS to synchronize calendar events from Exchange Online to the PBX, this feature will stop working from then on.

Microsoft suggests switching to the Graph API for this functionality and since we already have an app that works with the Graph API, we have extended the feature set of the Connector for Microsoft 365.

In addition to the initial functionality of synchronizing line states and presences bi-directionally between the Azure Portal (Teams) and the PBX, the Connector for Microsoft 365 can now also retrieve calendar events and integrate them into the PBX.

The Connector for Microsoft 365 requires a valid licence for each user.

The Exchange Online functionality of the Calendar App will no longer be enhanced or improved, but the current functionality will be included for as long as Microsoft continues to support EWS for Exchange Online.

The on-premise functionality is not affected by this and will remain in the Calendar App.

''As both apps integrate Exchange Online calendar events in the same way, it is not recommended or supported to use both calendar integrations at the same time.''

''However, you can use the Connector for Microsoft 365 for presence and line state synchronization and the Calendar App for calendar event integration.''

=== Federation ===
Beginning with 15r1 the certificate or CA of the certificate of the client device '''must''' be in the trust list of the RP/gateway or else, federation doesn't work anymore.

=== Devices App: Evaluation of PBX User Rights ===
When a PBX user with [[Reference9:PBX/Objects/Edit_Rights|administrative rights]] accesses the Devices App, their PBX rights are enforced. As a result, only the PBX-related pages permitted by the user's rights can be modified.
However, PBX rights do not apply to other modules (e.g. IP configuration). This means that users retain full administrative access to non-PBX-related functions within the Devices App, regardless of their PBX rights.
Additionally, in the syslog the administrative changes now also contain a user ID and the remote IP address if the Devices App is used.
‎</onlyinclude>

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

* running an App Platform on the CF card of an IPxx10 gateway (Removed, migrate to a gateway with an SSD or a Virtual Machine to run the App Platform)
* Audio codec software transcoding to G.729 removed on: IP11x, IP10x, myApps, DECT-Radios. Only the conversion to G.729 has been removed, not the playback of already converted g.729 audio files such as an MOH or voicemail announcements. These can still be played.

== 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. 
See: [[Howto14r2:Firmware_Upgrade_V14r1_V14r2#Deprecated]] 
We strongly recommend migrating to our successor products.

* iQM (innovaphone Queue Monitor) - Migrate to the [[Howto:Queueboard - MediaRunway - Partner App|Queueboard App]]. For existing innovaphone QueueMonitor licences, the corresponding MediaRunway Queueboard licences can be downloaded via portal.innovaphone.

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

===App Platform doesn't boot after Upgrade===
If you didn't upgrade the AP Image before upgrading the apps like describe [[#AP_Upgrade_to_Image_130006|here]] and the AP isn't reachable via http(s), but still via ssh, please follow these [[Reference14r2:Concept_App_Platform#It_still_doesn't_start|instructions]] to get the AP work correct again.

===Downgrade of Devices App from 15r1 to 14r2===
The database schema for update jobs in the Devices App has changed between versions 14r2 and 15r1. If you need to downgrade from 15r1 back to 14r2, you must delete all 15r1 update jobs before.

Failing to do so will cause the 14r2 Devices App to crash on startup. In that case, you will need to restore a 14r2 backup of the Devices App.

== Resources Considerations ==
New firmware always has more features which in turn requires more resources. Growing firmware will thus consume both more flash and RAM for sure. A given system configuration will run flawlessly after a firmware largely only if there is still enough memory left after boot.

Standard configurations which are according the specs will run on all supported hardware. However, unusual configurations may not. It is a good idea to examine both flash and RAM memory left on high load situations in your existing configuration to see if there is enough resources left for an upgrade. Please find details in Reference:Device Health Check.

=== RAM ===
As a rough rule of thumb, a 15r1 release will consume the same amount of RAM compared to a v14r2 firmware.

=== Flash Memory ===
As a rough rule of thumb, a v15r1 release will consume ~ 64KB flash memory compared to a v14r2 firmware.
New firmware comes with new code for new features which consumes more flash memory for the firmware image. For this reason, devices may run out of flash memory during upgrade to v15r1. Here is the recommended procedure for upgrade on such devices:

* save entire configuration
* reset to factory defaults
* load saved configuration (this will reorganize the flash memory usage)
* upgrade to new firmware

When there is still not enough flash memory available to store the new firmware (Web GUI ends up in a ''Firmwareupdate failed:no space'' / Update client end in a ''Error 0x00130001 Major FLASHMAN0 no space'' event) please open a support case with your current configuration file.

== Related Articles ==
*[[Howto:Firmware_Upgrade]]
* [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]
* [[Howto16r1:Firmware_Upgrade_V15r1_V16r1]]
[[Category:Howto|{{PAGENAME}}]]

Reference14r2:MyApps Plugin for Virtual Desktops

2025-10-08T09:35:55Z

Sga: /* Known issues */

[[Category:Concept|Apps]]
== Description ==
A softphone running at a terminal server (Citrix, Windows, ...) has the problem that audio and video streams start and terminate at the server.
Received audio from remote peer at the server must be transmitted to the local client for playback and audio delivered by the audio device must be also transmitted from the local client to the server for transmission to remote peer.
This transmission of the audio stream between server and client adds a delay which makes the communication impossible.
Video suffers from the same limitations.
 
A new innovaphone product called myApps Plugin is being developed to provide offloading of the media data to the local client.

== Applies To ==
* innovaphone PBX from version 14r2
* Client OS: Windows, Linux (Ubuntu 22 or 23, RangeeOS<ref>RangeeOS is listed due to a customer testimonial. No tests have been conducted by innovaphone. Tests were done using myapps 14r2sr3, RangeeOS Firmware 12.00 build 203 ff and Citrix Workspace 2311. (Workspace version 2402 & 2405 have a bug with USB redirection and 2408 is not starting reliably)</ref>, IGEL OS<ref>IGEL OS: available at [https://app.igel.com/myAppsPlugin/15.1.455+1 IGEL App Portal]</ref>) or MacOS operating systems
* Hypervisor OS: Citrix, Windows Terminal Server environments and VMWare Horizon<ref>VMWare Horizon OS is listed due to a customer testimonial. No tests have been conducted by innovaphone.</ref> 
<references/>

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

== Concept ==

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

* start or stop an audio/video device
* gathering of the ICE candidates
* connect to a remote peer with the ICE protocol
* start a ringing device
* rendering of video

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

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

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

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

=== Call signaling ===

The VDI Plugin has no connection to the PBX. Signaling is still done at the terminal server by the myApps client.

== Configuration ==

'''Citrix Workspace app must first be installed on all platforms. This is necessary because the myApps plugin must copy a .dll (Windows) / .so (MacOS/Linux) into the Citrix installation directory. '''
For this to work, the Citrix installation directory must be in the %ProgramFiles(x86)% or %ProgramFiles% directory.
 

=== Windows ===

The myApps Plugin .msi must be installed or deployed at the Thin-Client and does not require any configuration.

=== MacOS ===

Install the myAppsPlugin.dmg or .pkg at the Thin-Client and does not require any configuration.

=== Linux ===

Update your Linux PC first:

'''sudo apt-get update'''

Download latest Citrix Workspace App (Mar 7, 2024) for Debian and x86_64 platform:

'''https://www.citrix.com/downloads/workspace-app/linux/workspace-app-for-linux-latest.html'''

Citrix Workspace app needs '''libwebkit2gtk-4.0-37''' packet and this packet is not available in Ubuntu-24.04 version.

Install it at your Linux PC:

https://docs.citrix.com/en-us/citrix-workspace-app-for-linux/install.html

'''sudo apt install -f ./icaclient_<version>._amd64.deb'''

Install (or update) now the myApps Plugin:

'''sudo apt install -f ./myAppsPlugin.deb'''

Headset Buttons:

*Jabra: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-java.rules
**Add <code>ATTRS{idVendor}=="0b0e", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Epos: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-epos.rules
** Add <code>ATTRS{idVendor}=="1395", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
*Plantronics: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-plantronics.rules
** Add <code>ATTRS{idVendor}=="047f", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Snom: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-snom.rules
** Add <code>ATTRS{idVendor}=="251c", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>
* Yealink: Create a file sudo <your-favorite-text-editor> /etc/udev/rules.d/50-udev-yealink.rules
** Add <code>ATTRS{idVendor}=="6993", MODE="0666", GROUP="users"</code> as content. After creating the udev file (as root), reload the udev rules using: <code>sudo udevadm control --reload</code>

No additional configuration required.

=== Configuration on the Terminalserver ===
The Softphone App at the terminal server does not require any additional configuration.

== How it works ==

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

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

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

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

== Licensing ==

== Known issues ==
* The audio module in the MyApps Plugin for Linux/IgelOS has no echo cancellation. It is therefore recommended to use a headset, as headsets usually have their own echo cancellers.
* Webcam and remote videos must be rendered over the Softphone App but for the time being a native window is opened at the terminal client (only for the Windows Plugin)

* Connecting to a conference or 3rd party conference does not transmit video as video starts in the Javascript code of the Softphone App and Javascript has no access to the local webcam at the remote server.
**Video is displayed but with delay due to the rendering process.
**Citrix may provide access to the local webcam internally and the webcam may be available but remote peer will probably experience delay of the received video.
* When MyApps is used as a Citrix Published App, notification pop-ups cannot be displayed. This is because Citrix does not recognize the notifications as part of MyApps and therefore does not show them as part of the published app. If the full desktop is used in Citrix, the notifications function correctly.
* Start of AppSharing remains at the terminal server but the transmission of the media now starts at the local client.
* The MyApps Plugin for macOS supports only Citrix Workspace, the "Windows-App" from Microsoft is currently not supported
 We need to implement an exception for appSharing in the future as the transmission must happen at the server.
 For the time being the appSharing is transmitted to the client and forwarded to the remote peer adding some delay due to this tranmission between server and client (only for the Windows Plugin)

==Troubleshooting==
If the problem still exists after trying the OS-specific hints below, open a support ticket and send a trace from the myApps client (remote) with App and Browser option. Please send also all myAppsPlugin-x.txt and myAppsRemote-x.txt trace files from the myApps-plugin on the local PC.

=== Troubleshooting Windows ===

If Citrix is used as a terminal server environment:

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

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

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

"VirtualDriverEx" must be there with the value: InnovaphoneCitrixPlugin

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

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

'''Remote desktop (Windows)'''

After installing the plugin, check this registry folder:

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

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

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

=== Troubleshooting Linux ===

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

Innovaphone Plugin is installed under /opt/innovaphone/'''myAppsPlugin''' and in /opt/Citrix/ICAClient/'''myAppsCitrixPlugin.so'''

myAppsCitrixPlugin.so library is called by the Citrix Workspace App and this library opens the myAppsPlugin.

There is a file in the Citrix installation called module.ini (/opt/Citrix/ICAClient/config/module.ini). Inside this file the myApps Citrix Plugin library is included:

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with '''myAppsCitrixPlugin=On''' must exist and

Following directory '''/var/log/apps/myAppsPlugin/''' must also exist for the log files with write permission for everyone (drwxrwxrwx)

=== Troubleshooting MacOS ===

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

In /Library/Application Support/Citrix/PlugIns

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

under:

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

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

- VirtualDriver entry must contain myAppsCitrixPlugin

- a line with myAppsCitrixPlugin=On must exist

- and another line with [myAppsCitrixPlugin] too

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

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

=== Troubleshooting Citrix ===
A Virtual Channel Policy must be added to the Registry at the '''Citrix Server''':

Create '''VCPolicies''' folder under '''HKLM/Software/Policies/Citrix''' if it does not exist.

Create '''VCPolicies''' folder under '''HKLM/Software/WOW6432Node/Policies/Citrix''' if it does not exist.

Create a REG_MULTI_SZ entry with the name '''VirtualChannelWhiteList'''. This entry must contain as value: '''INNOHDX,C:\Program Files (x86)\innovaphone\myApps\myApps.exe'''

== Related Articles ==

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

Reference14r1:MyApps Plugin for Virtual Desktops

2025-10-01T13:11:56Z

Sga: /* Configuration */