innovaphone wiki - User contributions [en]

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

Reference14r2:MyApps Plugin for Virtual Desktops

2025-10-01T13:10:55Z

Sga: /* Configuration */

[[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 ==
* 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

Howto:Setup new push.innovaphone.com certificate

2025-08-12T07:28:22Z

Sga:

==Applies To==
This information applies to
* All innovaphone PBXs from V12 which use the Push service

==More Information==

===Problem Details===
On 01.09.2025 we will change the certificate used in our push infrastructure. Currently, we use <code>*.innovaphone.com</code> which expires annually and requires updating. This certificate is used in the PBX trust list to establish an encrypted connection between your PBX and the innovaphone push service. To simplify this process in the future, we will replace the certificate with one signed by our <code>innovaphone Device Certification Authority 2</code>.

To ensure that push will continues to work for your customers after 01.09.2025, please verify that either the CA-Certificate <code>innovaphone Device Certification Authority 2</code> or the single certificate <code>push.innovaphone.com</code> is present in the trust list of the relevant PBXes.
This certificate is only relevant on PBXes with a Push Object.
During the transition period up to and including 02.09.2025, both <code>*.innovaphone.com</code> and one of the above named certificates are required in the trustlist.

The CA certificate <code>innovaphone Device Certification Authority 2</code> is included in the trust list of new devices (gateways and IPVAs) by default, so unless you removed it, no action should be needed.

===Resolution===
Use the [[Reference15r1:Concept App Service Devices#Certificates configuration|Devices - certificate trustlist concept]] and the certificate will be installed automatically.

==== manually ====
If you cannot do this and want to do it manually, you can use one of these ways:

1. The certificate can be added manually on the PBX. It can be downloaded [https://download.innovaphone.com/certificates/innovaphone.pem here] and then be uploaded on the PBX under [[Reference15r1:General/Certificates|General/Certificates/Trust list]].

2. The new certificate can be added via commands (which can be sent using an update server or the [[Reference15r1:Concept App Service Devices#Expert configuration| Expert configuration]] in ''Devices''). This needs a reboot of the device.
Save the new certificate in the trust list:
!vars create X509/TRUSTED pba 6239515b5008c67cbcd66f07a539f4107dc48348e69a0382aabe640a5a2b62b5b63079bcb9a826819bb71518c8cd9d5e365f6a1059d6b6854781e61239108fb0eacacba6166843ed1973e0b268c3b5ba44b8efcd243032999af9a7f8cd375915b854ceca843a340f60be747a66200abb9eddbfd5ba204a1e1dabbc6fceb61e05243e4f191e7ff20bcc6cb29852f568437eeeb51d7657da1f9b245441a72dd42b4e8e80f916154b009c564ba3b79c9e20f40bef8cd84317bd0a9ceccd3ce312ec5fd350f9d366dd5f6f09119669383efbf580cdca3f7524da153984cec62f14e372d8324256302b7e567c0ca051d4c30023ee5bbd241ddfd6e75711a6018d12d7

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

Howto14r1:Firmware Upgrade V13r3 V14r1

2025-08-04T08:37:02Z

Sga: /* Licenses */

== Applies To ==
This information applies to:

* All 14r1 capable innovaphone devices
: For a general overview of the upgrade process and a list of supported devices with 14r1, see [[Howto:Firmware Upgrade]]

: If possible after you finish upgrading to v14r1 you should proceed the update to next version v14r2 according the [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]

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

In case of cloud or rental model, don't worry about licenses.

An existing myPBX license is counted by the PBX as one PhoneApp license and one SoftphoneApp license. See also [[Howto14r1:Firmware_Upgrade_V13r3_V14r1#myPBX | section on mypbx]].

== Migration Policy ==
Here is how you upgrade a system to 13r3 from 14r1.

=== Single AP/Single PBX===
* Create a new update job in devices and select 14r1 as major version

===Shared AP/Several PBX'es===
We generally recommend upgrading the entire system (endpoints, PBXs, AP) in ''one shot''.

If this is not possible for any reason, the recommended sequence is:
# update the master PBX
# update the slave PBX and all its endpoints location by location
# '''update the Apps to the last 13r3 SR'''
# update the App Platform to the latest build
# update all Apps to the last 14r1 SR
# perform the configuration changes described below

Note that during the update time frame, some App data such as Reporting and Recording may be incomplete.

We recommend reviewing all the configuration changes described below '''before''' you begin the update.

'''Note: If you upgrade the App Platform image before updating the ManagerAPP to the latest version of v13r3 you can run into issues.'''

== Changes visible to the end customers ==
Listed here are changes that should be communicated by resellers to end users prior to a 14r1 upgrade, as the change will be visible/audible in the behaviour of the application/device.
=== Softphone/Phone App UI changes ===
* Dial-pad is now a new tab in the navigation.
* On Smartphones, the Navigation is in the bottom.
* Call button is removed from the searchbar. Calling only via the search results.
=== IP-Phone Call-Screen ===
* [[ReleaseNotes14r1:Firmware#154045 - New symbols unencrypted, encrypted and verified calls| New symbols for unencrypted, encrypted and verified calls]]
<abbr title="Select active call on phone, check displayed keys with connected party and confirm with green key symbol">Possibility</abbr> to verify and confirm secured end-to-end media encryption through mutual key matching.

=== Configuration of Logo URI ===
* In 13r3 this configuration was done in the advanced UI on the page PBX / Config / myPBX / Logo URI.
* But in 14r1 it can be found on the page PBX / Config / General / Logo URL.
=== Voicemail App ===
Extra features for the users:
* Call the voicemailbox directly from the app.
* PIN-code can be checked (hidden by default; visible with a click) and changed/set back to default.
* Call Forwards to the Voicemailbox can be activated/removed (CFU/CFB/CFNR).
* Number Resolution via the Search Provider.

=== Fax App ===
* While sending an outgoing fax via the fax app, you now can select and configure a fax cover page before sending.
* While configuring a fax app or groupfax via the PBX Manager plugin, you can customize the header line of fax pages and select a language.
* After updating from 13r3 or setting up your device with 14r1, the Fax object has 4 new options, which are enabled by default:
** Modem capability: the supported modem class can be changed if necessary.
** Append user number: if checked, the user number will be appended to the object number.
** ECM: that allows the T.30 connection to use error correction mode.
** Receiving with 400dpi allowed: which allows you to receive 400*400dpi documents.
===AP Manager===
* The AP Manager UI has been reworked. It is now responsive design, improved view of all app services and instance. Rework of statistic of CPU/RAM/used disk. This change is for the IT administrator, not relevant for end users

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

=== Devices App ===
New Device Configurations option to roll out certificates to the trust list of your devices. [[Reference14r1:Concept_App_Service_Devices#Certificates_configuration]]

=== Recordings App ===
New option to add WebDav credentials in RecordingsAdmin. [[Howto14r1:RecordingsApp#Configuring_WebDav_credentials_in_RecordingsAdmin]]

=== Voicemail App ===
* New Setting to configure the automatic deletion of old(er) voicemail-messages per app. [[Reference14r1:Concept_App_Service_Voicemail#Settings]]
* New Option to configure the default PIN per voicemail system. [[Reference14r1:Concept_App_Service_Voicemail#add_voicemail]]
: By configuring a PIN code from a different length, you also configure the length of the PIN code used by the system.

=== Conference App ===
* A new settings is now available under [[Reference14r1:Apps/PbxManager/Conference]] to allow the users within his Conference App to access to the Meetings panel or not. By default Conference room set the Meeting option to '''not allowed'''.
* {{ConferenceRoomPanelRights}}

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

=== Calculator ===
*Although already released in 13r3 sr11, this app is now part of the 14r1 install. This app is explained in [[Reference13r3:Concept App Service Calculator App| the concept article]] and [[Howto14r1:Set up the calculator app| the how to article]].

=== Connect ===
* A microblogging tool. This app is explained in [[Reference14r1:Concept App Service Messages| the concept article]] and [[Howto14r1:Set up Connect| the how to article]].

=== Connector for Let's Encrypt ===
* Automatically creates & renews Let's Encrypt certificates, the App is included in the Install process - however when doing an upgrade it needs to be [[Reference14r1:Concept Let's Encrypt#Configuration| setup manually]].

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

For more details have a look at [[Reference14r1:Concept Contact Widgets| the concept article]].

Customers using the previous Widgets, should change to the new [[#Widgets| Contact Widgets App]]

===Notes===
*Digital notes can be managed with the innovaphone app Notes. The app has a minimalistic feature set and is easy to use. The notes are saved on the server and available on all devices of the users. More infos available in the [[Reference14r1:Concept App Service Notes App| Reference article]]

===PBX Manager - AP app installer===
*in the PBX manager you will find a new coloured plugin. this new plugin give access to the App store in order to ease the installation of an App service and its instance. You basically do not need to go to the AP platform when you want to install a new application. Idea is to have the further installed app done by this plugin, this also ease the way to discover new applications. More infos available in the [[Reference14r1:Concept App Platform#App Installer PBX Manager Plugin| Reference article]]

=== Search App ===
* The app is immediately available on the PBX (no configuration is needed). In a new V14r1 configuration the Install provides all Users with this Search App via the "Config User"-Template. If the same configuration is required on an upgraded config, the Search App ("search") can be ticked in the "Config User" template. For details refer to [[Reference14r1:Concept App Search| the concept article]].

=== TechAssist ===
* Application for quality assurance and improvement of systems by collecting static and runtime information. For details refer to [[Reference14r1:Concept App Service TechAssist| the concept article]].

== Needed configuration changes ==


=== Virtual Appliance on VMWare ===
After deploying the new firmware modify the guest configuration file (stemming from ipva.vmx) for all network cards as such:
Modify e.g. <code>ethernet0.virtualDev = "vlance"</code> to become <code>ethernet0.virtualDev = "vmxnet3"</code>

== IPVA certificates ==
IPVA certificates are no longer signed by '''innovaphone Device Certification Authority 2'''.
Instead they will be now signed by '''innovaphone Unverified Device CA''', as innovaphone cannot control the serial numbers and thus the certificate creation of IPVAs. 

In a 14r1 install you'll be asked whether you want to always trust this new CA or not. If you decide not to trust this CA, you have to manually trust newly created IPVA certificates. 
Note that this is not neccessary for local registrations inside the IPVA itself and doesn't affect hardware phone registrations.

You can download the innovaphone Unverified Device CA here: https://download.innovaphone.com/certificates/ca-unverified.pem 
If you want to trust this new CA or your own IPVA certificates, you can use the Devices App to roll out certificates to the trust list of your devices.

== Removed in 14r1 ==
The following software is no longer included in 14r1.
=== myPBX ===
This includes the following components
* myPBX webclient
* myPBX for Windows
* myPBX for iOS
* myPBX for Android
Please migrate to '''innovaphone myApps'''.

===Widgets===
The Widgets were based on the myPBX interfaces that have been removed. Please migrate to the [[Reference14r1:Concept Contact Widgets| the Contacts Widget App]].

===WebRTC toolkit===
The WebRTC toolkit was based on the myPBX interfaces that have been removed.
Please use the current interfaces and libraries described in the '''[https://sdk.innovaphone.com innovaphone SDK]'''.
=== Windows Softwarephone ===
Please migrate to '''innovaphone myApps for Windows''' and the '''Softphone App'''.
===PBX Object Settings ===
The object provided the PBX Settings App that was used to configure dynamic group memberships in myPBX.
Please use the '''Profile App''' instead.

===PBX Object ICP ===
Please use the integrated presence features of the '''innovaphone PBX''' instead.

The ICP object will be restored since 14r1 SR5 and can be then used again!

===Service Call-Lists ===
This service implemented call lists for myPBX on the local CF card.
Please use the '''Reports App''' instead.

== Deprecated in 14r1 ==
The following software is based on legacy technology with no further development and limited maintenance and support.
We strongly recommend migrating to our successor products that are fully compatible with 14r1 and myApps technology.

=== Linux Application Platform (v10) ===
Please migrate to the '''innovaphone App Platform''' for 14r1 installations.

=== innovaphone Faxserver (v10) ===
Please migrate to the '''Fax App''' for 14r1 installations.
=== innovaphone Reporting (v10) ===
Please migrate to the '''Reports App''' for 14r1 installations.
=== innovaphone Exchange (v10) ===
Please migrate to the '''Calendar App''' for 14r1 installations.
=== Operator (v9) ===
Please migrate to the '''Switchboard App''' for 14r1 installations.
=== innovaphone Voice Recording 2014 ===
Please migrate to the '''Recordings App''' for 14r1 installations.
=== PBX Object External UC ===
Existing configurations still work. But new configurations can't be done using the advanced UI anymore.

Please use the integrated '''UC''' and '''federation''' features of the '''innovaphone PBX'''.

For presence synchronization with other systems we recommend using
* '''innovaphone myApps Connector for Microsoft 365'''
* '''Connector for kuando®'''
* '''Calendar App'''
==Known Problems==
===Long Update-duration===
When you update, it can be up to 10 minutes before you have access to your app platform again.
===Fax from 14r1 to 13r3 App===
14r1 faxes are sent with 400dpi by default, which the 13r3 app doesn't support and you will see a [[Reference14r1:Concept App Service Fax#Known Issues|non working incoming fax]]. The second try with lower resolution will work.
===new Connect App shows false Badgecount===
If you've upgraded from a V13 Installation and Install Connect, it could be, that there is a high Badgecount even if Connect is empty. 
This Badgecount comes from old chats stored in the Messages App. To get rid of it, the user have to open connect, click on the tree dots in the personal feed and click on "complete all messages".

== 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 14r1 release will consume the same amount of RAM compared to a v13r3 firmware.

=== Flash Memory ===
As a rough rule of thumb, a v14r1 release will consume ~ 1.8 MB more flash memory compared to a v13r3 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 v14r1. 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]]
* [[Howto:V13 Firmware Upgrade V13r2 V13r3]]
* [[Howto14r2:Firmware_Upgrade_V14r1_V14r2]]
[[Category:Howto|{{PAGENAME}}]]

Main Page

2025-08-04T07:14:09Z

Sga: /* Remote Support */

__NOTOC__

<div style="margin:0px; margin-right:10px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0em 1em;">
== Remote Support ==
[[Image:RemoteControl-click.png|left|60px|RemoteControl.png/|Download Remote Control|link=https://store.innovaphone.com/alpha/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe]]
innovaphone only carries out scheduled remote maintenance via our ticket system by prior consultation. 
As Remote Support Tool, we use our own product Remote Control ([https://www.innovaphone.com/en/all-apps/apps-to-work-with/remote-control-app.html more info]).

You can '''[https://store.innovaphone.com/alpha/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe download]''' the Remote Control client already or use the support link received from our support team. 
After installing and opening the client you can '''pass the shown ID''' or '''use the received link''' to request the support session.

== Searching ==
Searching in wiki works, but is sometimes cumbersome. However, you can have Google do the job for you. Try [https://www.google.de/search?q=site%3Ainnovaphone.com+xml+documentation <code>site:innovaphone.com your search terms</code>] to search the innovaphone sites for matches!

If you still don't find what you are looking for, [mailto:presales@innovaphone.com drop us a message]
</div>


<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">



== Latest News ==

[[User:Kse|Kse]] ([[User talk:Kse|talk]]) 08:36, 23 July 2025 (CEST)[[Support:Firmware V15r1 product/15r1/firmware 1510536 (sr 4) available | Version 15r1 Service Release 4]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Kse|Kse]] ([[User talk:Kse|talk]]) 08:36, 23 July 2025 (CEST)[[Support:Firmware V14r2 product/14r2/firmware 1420530 (sr 12) available | Version 14r2 Service Release 12]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Kse|Kse]] ([[User talk:Kse|talk]]) 08:36, 23 July 2025 (CEST)[[Support:Firmware V13r3 product/13r3/firmware 138029 (sr 29) available | Version 13r3 Service Release 29]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Tfu|Tfu]] ([[User talk:Tfu&action=edit&redlink=1|talk]]) 15:28, 13 March 2025 (CEST)
[[Support:Wireless Handset Firmware IP73 1012 (6.1.13) released| Wireless Handset Firmware IP73 1012 (6.1.13) released]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2) released| Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware D83 10002 (2.0.5) released| Wireless Handset Firmware D83 10002 (2.0.5)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 15:38, 6 February 2023 (CET)
[[Support:Wireless Handset Firmware IP62 3040621 (6.2.7) released| Wireless Handset Firmware IP62 3040621 (6.2.7)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 13:13, 6 February 2023 (CET)
[[Support:WinPDM Software 3130113 (4.1.8) released| WinPDM Software 3130113 (4.1.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 12:46, 16 June 2021 (CEST))
[[Support:TAPI Service Provider 8188 (hotfix21) available|TAPI Service Provider 8188 (hotfix21)]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 18:21, 12 October 2020 (CEST)
[[Support:Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8) released| Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 21:30, 27 March 2020 (CET)
[[Support:Wireless Handset Firmware and Management Software product/9.00/wireless 100037 (hotfix19) available| Wireless Package hotfix 19]] is now available from the [http://download.innovaphone.com/ice/9.00#wireless V9 download area].

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">

== New Articles ==

{{Special:Newestpages/all/20}}
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em; font-size:1">
== More innovaphone Ressources ==
* [http://www.innovaphone.com Home Page]
* [http://download.innovaphone.com Download Site ]
* [http://my.innovaphone.com my.innovaphone ]
* [http://mantis.innovaphone.com/ Ticketing System ]
</div>

File:RemoteControl-click.png

2025-08-04T07:12:57Z

Sga:

Main Page

2025-08-04T06:48:21Z

Sga: /* Remote Support */

__NOTOC__

<div style="margin:0px; margin-right:10px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0em 1em;">
== Remote Support ==
[[Image:RemoteControl.png|left|60px|RemoteControl.png/|Remote Control|link=https://store.innovaphone.com/alpha/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe]]
innovaphone only carries out scheduled remote maintenance via our ticket system by prior consultation. 
As Remote Support Tool, we use our own product Remote Control ([https://www.innovaphone.com/en/all-apps/apps-to-work-with/remote-control-app.html more info]).

You can '''[https://store.innovaphone.com/alpha/download/software/remotecontrolwindowsportable/16r1/remoteControl.exe download]''' the Remote Control client already or use the support link received from our support team. 
After installing and opening the client you can '''pass the shown ID''' or '''use the received link''' to request the support session.

== Searching ==
Searching in wiki works, but is sometimes cumbersome. However, you can have Google do the job for you. Try [https://www.google.de/search?q=site%3Ainnovaphone.com+xml+documentation <code>site:innovaphone.com your search terms</code>] to search the innovaphone sites for matches!

If you still don't find what you are looking for, [mailto:presales@innovaphone.com drop us a message]
</div>


<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">



== Latest News ==

[[User:Kse|Kse]] ([[User talk:Kse|talk]]) 08:36, 23 July 2025 (CEST)[[Support:Firmware V15r1 product/15r1/firmware 1510536 (sr 4) available | Version 15r1 Service Release 4]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Kse|Kse]] ([[User talk:Kse|talk]]) 08:36, 23 July 2025 (CEST)[[Support:Firmware V14r2 product/14r2/firmware 1420530 (sr 12) available | Version 14r2 Service Release 12]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Kse|Kse]] ([[User talk:Kse|talk]]) 08:36, 23 July 2025 (CEST)[[Support:Firmware V13r3 product/13r3/firmware 138029 (sr 29) available | Version 13r3 Service Release 29]] is now available from the [http://store.innovaphone.com/release/download.htm App Store].

[[User:Tfu|Tfu]] ([[User talk:Tfu&action=edit&redlink=1|talk]]) 15:28, 13 March 2025 (CEST)
[[Support:Wireless Handset Firmware IP73 1012 (6.1.13) released| Wireless Handset Firmware IP73 1012 (6.1.13) released]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2) released| Wireless Handset Firmware IP64 10317 (4.3.2)/IP65 10122 (4.3.2)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Msu|Msu]] ([[User talk:Msu&action=edit&redlink=1|talk]]) 15:54, 18 February 2025 (CEST)
[[Support:Wireless Handset Firmware D83 10002 (2.0.5) released| Wireless Handset Firmware D83 10002 (2.0.5)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 15:38, 6 February 2023 (CET)
[[Support:Wireless Handset Firmware IP62 3040621 (6.2.7) released| Wireless Handset Firmware IP62 3040621 (6.2.7)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 13:13, 6 February 2023 (CET)
[[Support:WinPDM Software 3130113 (4.1.8) released| WinPDM Software 3130113 (4.1.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 12:46, 16 June 2021 (CEST))
[[Support:TAPI Service Provider 8188 (hotfix21) available|TAPI Service Provider 8188 (hotfix21)]] is now available from [https://store.innovaphone.com/release/download.htm the Software download area].

[[User:Afi|Afi]] 18:21, 12 October 2020 (CEST)
[[Support:Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8) released| Wireless Handset Firmware IP61 3022811 (4.7.8)/IP63 3022912 (4.7.8)]] is now available from the [https://store.innovaphone.com/release/download.htm App store].

[[User:Afi|Afi]] 21:30, 27 March 2020 (CET)
[[Support:Wireless Handset Firmware and Management Software product/9.00/wireless 100037 (hotfix19) available| Wireless Package hotfix 19]] is now available from the [http://download.innovaphone.com/ice/9.00#wireless V9 download area].

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em;">

== New Articles ==

{{Special:Newestpages/all/20}}
</div>

<div style="margin:0px; margin-right:10px; margin-top:15px; border:1px solid #58C4C3; background-color:#F4F4F4; padding:0em 1em 0.5em 1em; font-size:1">
== More innovaphone Ressources ==
* [http://www.innovaphone.com Home Page]
* [http://download.innovaphone.com Download Site ]
* [http://my.innovaphone.com my.innovaphone ]
* [http://mantis.innovaphone.com/ Ticketing System ]
</div>

Template:IP-DECT External Antennas

2025-06-11T11:59:05Z

Sga:

'''IP1202e/IP1203e''' includes two dipole omni directional antennas.
For special use cases, optionally different directional antenna types are offered for separate order. They are connected to the external MCX-connectors of IP1202e/IP1203e:
*[https://www.innovaphone.com/content/downloads/DualDirectionalAntenna.pdf Directional dual antenna] (50-01202-004)
*[https://www.innovaphone.com/content/downloads/DirectionalSingleAntenna.pdf Directional single antenna] (50-01202-005)
*[https://www.innovaphone.com/content/downloads/OmniDirectionalSingleAntenna.pdf Omnidirectional single antenna] (50-01202-006)

Reference14r2:MyApps Plugin for Virtual Desktops

2025-06-04T10:02:21Z

Sga: /* Applies To */

[[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. '''
 

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

Reference15r1:Gateway/Interfaces/Media Properties

2025-05-22T10:00:54Z

Sga:

=== Media Properties ===

The physical interface may be registered using H.323 or SIP. For the VOIP call the media properties can be configured.

;General Coder Preference: The coder preference (Coder, Framesize, Silence Compression) to be used if a non-local media address is detected. If the preference is marked as exclusive no other coder is offered.

;Local Network Coder: The coder preference if a local media address is detected.

;Enable T.38: Switches on Fax detection and switchover to T.38

;Audio FAX support: Switches on voice coder e.g. G.711 for the FAX interface. This feature requires two free DSP channels and is '''not available''' on IP2x, IP302, IP305, IP800, IP0011, IP311 gateways and IPVA.

;No DTMF Detection: Special mode to switch off DTMF detection during a call. If checked DTMF is transferred inband during a call. Use G711 coder and a link with no packet loss to transfer DTMF inband. This option can be used to transfer continuous DTMF tones for some special applications. Out of band DTMF tones have a fixed length of approx 150ms.

;Enable PCM: Enable the media to be connected using the local timeslot switch if the call is between physical interfaces of the same gateway.

;Media-Relay:
:;Off: No Media Relay is performed for calls thru this interface
:;On: If the interface of one call leg is set to Media-Relay On, Media relay is performed
:;Auto: If the interfaces of both call legs are set to Media-Relay Auto, Media Relay is performed if the call is between a private an a public network, based on the private network configurations under IP4/General/Settings

;Video: If this checkmark is set, Video Media Relay is also done.

;RTT: If this checkmark is set, RealTime-Text(RTT) Media Relay is also done.

;No ICE: ICE is turned off for calls routed through this interface

;No RTCP-MUX: RTCP-MUX(RTP and RTCP share the same port/connection, instead of using two separate connections) is turned off for calls routed through this interface

;TURN Only: Do not offer real local RTP address (a.k.a. HOST candidate). Offer remote RTP address only (a.k.a. RELAY candidate). You may enable this option for "Topology Hiding" purposes. '''Note: This can cause 'no-audio' calls if the remote peer does not support ICE (RFC 5245)'''

;MOH Mode: Special mode to use a physical interface as Music on Hold Source. The media is one way only and multiple calls are connected to the same channel on the physical interface. In this case the configured coder is used exclusively, even if not marked as exclusive.

;Record to (URL): HTTP URL where the recording file is to be stored. HTTP server must allow write access (PUT) at this location. One PCAP file is written for every call via this interface containing both RTP streams. Audio streams can be played using Wireshark. PCAP file can be converted into WAV file using pcap2wav tool. The filename of the recording file has the form <conference ID>-<mac>-<seq>.pcap
:;conference ID: A guid identifying the call across different hops. It is forwarded within the signaling. The CDRs generated by the PBX contain this conference ID.
:;mac: The Mac address of the device recording the call. Together with '''seq''' it is used to make sure the filename is unique if seperate devices record the same call.
:;seq: A sequence number of the record starting with 0 after power up of the recording device. Together with '''mac''' it is used to make shure the filename is unique, especially to cover the case, that one device records the same call multiple times (e.g. incoming and outgoing)

;SRTP Cipher: The encryption mode for RTP

;SRTP Key Exchange:
:;SDES-DTLS: SDES and DTLS are supported. The preference is SDES
:;DTLS-SDES: SDES and DTLS are supported. The preference is DTLS
:;SDES: SDES only
:;DTLS: DTLS only
:;None: No encryption

Reference15r1:Gateway/Interfaces/Media Properties

2025-05-22T09:59:49Z

Sga: same version as 13r1

=== Media Properties ===

The physical interface may be registered using H.323 or SIP. For the VOIP call the media properties can be configured.

;General Coder Preference: The coder preference (Coder, Framesize, Silence Compression) to be used if a non-local media address is detected. If the preference is marked as exclusive no other coder is offered.

;Local Network Coder: The coder preference if a local media address is detected.

;Enable T.38: Switches on Fax detection and switchover to T.38

;Audio FAX support: Switches on voice coder e.g. G.711 for the FAX interface. This feature requires two free DSP channels and is '''not available''' on IP2x, IP302, IP305, IP800, IP0011, IP311 gateways and IPVA.

;No DTMF Detection: Special mode to switch off DTMF detection during a call. If checked DTMF is transferred inband during a call. Use G711 coder and a link with no packet loss to transfer DTMF inband. This option can be used to transfer continuous DTMF tones for some special applications. Out of band DTMF tones have a fixed length of approx 150ms.

;Enable PCM: Enable the media to be connected using the local timeslot switch if the call is between physical interfaces of the same gateway.

;Media-Relay:
:;Off: No Media Relay is performed for calls thru this interface
:;On: If the interface of one call leg is set to Media-Relay On, Media relay is performed
:;Auto: If the interfaces of both call legs are set to Media-Relay Auto, Media Relay is performed if the call is between a private an a public network, based on the private network configurations under IP4/General/Settings

;Video: If this checkmark is set, Video Media Relay is also done.

;No ICE: ICE is turned off for calls routed through this interface

;No RTCP-MUX: RTCP-MUX(RTP and RTCP share the same port/connection, instead of using two separate connections) is turned off for calls routed through this interface

;TURN Only: Do not offer real local RTP address (a.k.a. HOST candidate). Offer remote RTP address only (a.k.a. RELAY candidate). You may enable this option for "Topology Hiding" purposes. '''Note: This can cause 'no-audio' calls if the remote peer does not support ICE (RFC 5245)'''

;MOH Mode: Special mode to use a physical interface as Music on Hold Source. The media is one way only and multiple calls are connected to the same channel on the physical interface. In this case the configured coder is used exclusively, even if not marked as exclusive.

;Record to (URL): HTTP URL where the recording file is to be stored. HTTP server must allow write access (PUT) at this location. One PCAP file is written for every call via this interface containing both RTP streams. Audio streams can be played using Wireshark. PCAP file can be converted into WAV file using pcap2wav tool. The filename of the recording file has the form <conference ID>-<mac>-<seq>.pcap
:;conference ID: A guid identifying the call across different hops. It is forwarded within the signaling. The CDRs generated by the PBX contain this conference ID.
:;mac: The Mac address of the device recording the call. Together with '''seq''' it is used to make sure the filename is unique if seperate devices record the same call.
:;seq: A sequence number of the record starting with 0 after power up of the recording device. Together with '''mac''' it is used to make shure the filename is unique, especially to cover the case, that one device records the same call multiple times (e.g. incoming and outgoing)

;SRTP Cipher: The encryption mode for RTP

;SRTP Key Exchange:
:;SDES-DTLS: SDES and DTLS are supported. The preference is SDES
:;DTLS-SDES: SDES and DTLS are supported. The preference is DTLS
:;SDES: SDES only
:;DTLS: DTLS only
:;None: No encryption

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-05-09T08:56:19Z

Sga: /* Devices App: Evaluation of PBX User Rights */

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

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

== 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]]
[[Category:Howto|{{PAGENAME}}]]

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-05-09T08:55:11Z

Sga: /* Devices App: Evaluation of PBX User Rights */

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

=== 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 [[Reference15: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.

== 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]]
[[Category:Howto|{{PAGENAME}}]]

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-05-09T08:54:40Z

Sga: /* Devices App: Evaluation of PBX User Rights */

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

=== 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 [[Reference16: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.

== 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]]
[[Category:Howto|{{PAGENAME}}]]

Howto15r1:Firmware Upgrade V14r2 V15r1

2025-05-09T08:42:28Z

Sga: /* Good2Know */

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

=== 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 [[{{NAMESPACE}}: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.

== 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]]
[[Category:Howto|{{PAGENAME}}]]

Reference15r1:Concept myApps platform services

2025-05-07T14:27:25Z

Sga: Created page with "myApps myApps platform services provide various operating system specific services which can be used by other ''Apps'' running in the myApps client. Those services typically are not available in the browser's JavaScript environment and hence must be implemented in native platform code. Therefore, the platform services are installed as native executable on the respective platform. When myApps is started in a web brow..."

[[Category:Concept|myApps]]

myApps platform services provide various operating system specific services which can be used by other ''Apps'' running in the [[{{NAMESPACE}}:Concept myApps|myApps client]]. Those services typically are not available in the browser's JavaScript environment and hence must be implemented in native platform code. Therefore, the platform services are installed as native executable on the respective platform.

When myApps is started in a web browser (and hence has no access to the platform services), some Apps will use [https://en.wikipedia.org/wiki/WebRTC WebRTC] services implemented by the browser instead. For ease of reference, features available in this scenario are also described here.

On windows, the platform services also come with their own web browser in which the myApps web App will be started then. This browser is based on google's [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium] open source software.
= Applies To =

* [[{{NAMESPACE}}:Concept myApps|myApps]]
* myApps for Windows
* myApps for macOS
* myApps for iOS
* myApps for Android

* myApps Web App (WebRTC)
version 14r2

=Features=
Not all features are available or required on all platforms.
{|
! style="text-align: left; font-weight: bold" | Feature

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold"| Availability
|-

| || || Windows || iOS || Android || macOS || Browser<ref>This refers to the myApps web application running in a browser with no platform services available</ref>

|-
| audio || manage local audio devices to record and playback audio conversations || ✔ || ✔ || ✔ || ✔ || ✔ (audio available but devices managed by web browser)
|-

| video || manage local displays and cameras to capture and render video live stream || ✔ || ✔ || ✔ || ✔ || ✔ (video available but devices managed by web browser)

|-

| ringer || manage local ringing device || ✔ || ✔ || ✔ || ✔ || ✔
|-

| application sharing

|-

|   presenter || share an application || ✔ || ✗ || ✔ || ✔ || ✔
|-

|   consumer || view an application shared by the peer || ✔ || ✔ || ✔ || ✔ || ✔

|-

| hot keys || capture key presses for quick invocation of phone apps (e.g. dial selected number) || ✔ || ✗ || ✗ || ✔ || ✗
|-
| tel: and sip: URI handler || intercept clicks on tel: and sip: links in web sites to invoke phone apps || ✔ || ✔ || ✔ || ✔ || ✗

|-
| user activity || set presence state according to user activity || ✔ || ✗ || ✗ || ✔ || ✔<ref>limited, see [[#User activity|User activity]] below</ref>

|-

| docking || myApps can be docked persistently to the right or left edge of your screens || ✔ || ✗ || ✗ || ✗ || ✗

|-

| multi-windowing|| Apps can be launched in separate windows|| ✔ || ✗ || ✗ || ✔ || ✗

|-

| recording|| Calls can be recorded to recording app|| ✔ || ✔ || ✔ || ✔ || ✗

|-
| notifications || ||
|-
|   display notifications || display notifications with OS standard mechanism || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   push notifications || receive push notifications while myApps is not running || ✗ || ✔ || ✔ || ✔ || ✔<ref>The browser needs to be running in order to receive push notifications.</ref>
|-
|   chat and apps || display notifications for chat and other apps || ✔ || ✔ || ✔ || ✔ || ✔
|-
|   calls || display notifications for incoming calls || ✔ || ✔ || ✔ || ✔ || ✗<ref>Call notifications are only displayed locally while the phone or softphone app is started.</ref>
|-

| phone book access || access local phone book || ✔ || ✔ || ✔ || ✔ || ✗
|-
| office presence provider || maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗ || ✗
|-

| external application start || start arbitrary external applications for calls || ✔ || ✗ || ✗ || ✔ || ✗

|-

| app proxy|| a caching proxy that provides app persistence || ✔ || ✔ || ✔ || ✔ || ✗

|-

| auto update || automatically updates myApps platform services to the same version the PBX has || ✔ || ✔ || ✗ || ✔ || ✔<ref>The then-current web app is always loaded from the PBX upon startup and hence up-to-date by definition</ref>
|-

| three party conference || initiate 3-pty-conference using Softphone-App || ✔ || ✔ || ✔ || ✔ || ✗

|-
| exclude VPN || disable use of VPN connections for audio/video/appsharing || ✔ || ✔ || ✔ || ✔ || ✗

|}

<references/>

=Requirements=
* innovaphone PBX 14r2 and up

== Hardware ==
Recommended hardware requirements
* Processor: Dual-core 2Ghz or higher
* RAM: 4 Gb

== myApps for Windows ==
* Windows 10 and up
* Windows Server 2016 and later versions

=== 32 & 64 bit Windows ===
* 32 bit Windows: install the myAppsSetup32.msi from the App Store
* 64 bit Windows: install the myAppsSetup.msi from the App Store
** the 64 bit variant still installs into Program Files (x86), as the main myApps.exe is still a 32bit application
** the 64 bit variant just contains an additional 64 bit binary for the outlook search

=== Windows N editions ===

Windows N editions are missing the ''Media Feature Pack'' which is pre installed on other Windows versions.

Please install the pack from [https://www.microsoft.com/en-us/software-download/mediafeaturepack Microsoft (Windows 10 pack)] before you install myApps. The installer will check if the file <code>C:\Windows\SysWOW64\mfplat.dll</code> exist on your system.

Make sure to install the correct pack depending on your Windows version! There are different packs for Windows 10 1703, 1803, 1809 and 32bit or 64bit etc.

NB: Sometimes the myApps installation will not work even though the media pack is already installed. This is because the installer has no read access to check if the package is already installed. If the above-mentioned file exists and the installer asks to install the Windows Media Feature Pack nevertheless, you have to start the myApps install with administrative rights.

=== Terminal Server environments ===

Audio driver was removed if myApps discovers that it is running in a terminal server environment like Citrix.

The audio driver is needed for the Softphone App but the Softphone App should not use an audio driver at the server side because the audio devices are plugged locally and there would be a delay sending and receiving audio data with the server.

If a customer wants to use the Softphone App at the server side he needs to make use of the myApps Plugin for virtual desktops solution:

[[{{NAMESPACE}}:MyApps_Plugin_for_Virtual_Desktops]]

== myApps for macOS ==
* macOS 10.13 or higher

== myApps for iOS ==
* iOS 12 or higher

== myApps for Android ==
* Android 6.0 or higher. Android 6.x may need an update of the Chrome browser.

= Licenses =
* No license needed for myApps platform services

= Overview =
myApps platform services is a native executable that is installed using the standard mechanisms on the respective operating system. It provides various advanced services which can be used by the myApps web client code as well as the Apps running in the myApps context.

Also, on Windows, the platform services come with their own, dedicated browser to run myApps in. This browser is based on [https://en.wikipedia.org/wiki/Chromium_(web_browser) Chromium]. On iOS, macOS and Android, it is based upon native embedded web view facilities (such as WKWebView) instead.
== Components ==

=== RTP service for audio, video and data ===
The RTP service provides audio, video and data (app sharing) VoIP RTP endpoints (e.g. for softphones). It supports STUN, TURN, ICE, SRTP, DTLS. Note however that unlike WebRTC, these endpoints do not ''require'' ICE and DTLS. In other words, they can communicate also with non-compliant (i.e. older) VoIP devices.

Note that the available capabilities when not running the myApps platform services depend on the used browser's WebRTC implementation. See your browser documentation for details.

Apps can request RTP channels using the [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol]'s ''AllocChannel'' message.

===== RTP ports=====

{|

| audio || 50000 -> 50099

|-

| video || 50100 -> 50199

|-

| data || 50200 -> 50299

|}

The RTP service will enumerate all local interfaces and create local HOST candidates for ICE. There is an option however to disregard VPN interfaces (more precisely such interfaces with type of ''IF_TYPE_PPP'' or ''IF_TYPE_TUNNEL''). This can eliminate quality issues when RTP data is transmitted through TCP based VPN tunnels.

SRFLX and RELAY candidates are obtained using the STUN and TURN server configuration passed by the App (e.g the ''softphone'' App) as part of the ''AllocChannel'' request.
<code>{"mt":"AllocChannel","channel":"81429cba-396d-43de-8a76-ec020ba8796e","iceServers":[{"urls":"turn:myturn.domaincom:4077?transport=udp","username":"turnuser","credential":"pwd","credentialType":"password"},{"urls":"stun:mystun.domain.com:4077"}],"dn":"Foo Bar","type":"RemoteRtp","kind":"video"}</code>

===== Codecs =====

The installed myApps launchers provide codecs that can be used by softphone apps for media streams. When running in a web browser the codecs depend on the browser version and operating system. See the documentation of your browser for details.

The following codecs are supported:

{|
!style="text-align:left;width:100px;"|Codec
!style="width:100px"|Windows-Launcher
!style="width:100px"|Android
!style="width:100px"|iOS
!style="width:100px"|macOS
!style="width:100px"|Firefox (Browser)
!style="width:100px"|Chrome (Browser)
!style="width:100px"|Edge (Browser)
!style="width:100px"|Safari (Browser)
!style="width:100px"|Opera (Browser)
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Audio
|-
|G711A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G711u
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G722
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|G729
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729A
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729B
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|G729AB
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|-
|[https://caniuse.com/#search=Opus OPUS-NB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|[https://caniuse.com/#search=Opus OPUS-WB]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Video
|-
|[https://caniuse.com/#search=VP8 VP8]
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|-
|[https://caniuse.com/#search=VP9 VP9]
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔**
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔**
|-
|[https://caniuse.com/#search=H264 H264]
|style="color:green;text-align:center"|✔**
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|-
|style="text-align:left; background-color:lightgray" colspan="10"|Application Sharing
|-
|Share
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|-
|Watch
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔*
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:green;text-align:center"|✔
|style="color:red;text-align:center;font-weight:bold;"|X
|style="color:green;text-align:center"|✔
|}

''* small presentation only'' 
''** only for 1:1 calls, not for conferences

===== Video capture =====

The default resolution for video capture is 1280x720 if available. Otherwise, 640x480, 352x288 or 320x240 will be used. The frame rate is 30 fps if available, otherwise 15 fps. The resulting average bandwidth could reach 1 Mbps.

===== Application sharing =====

Screen content will be transmitted by the presenter.

===== Device handling =====

The RTP service enumerates microphones, loudspeaker, cameras and ringing devices and notifies apps when devices come and go. It is up to the apps using the devices to store preferences.

The RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app. 

For this to work, the following vendor specific development kits are integrated in our myApps client. Be aware that the SDK are updated within our Service release :

{| class="wikitable"
|-
! SDK Vendor !! Supported OS !! SDK Version !! innovaphone Service Release
|-
| Jabra|| MacOS || 1.12.2.0 || 13r3sr9
|-
||| Windows || 1.12.2.0 || 13r3sr10
|-
| Epos ''(formerly Sennheiser)'' || MacOS || 12.4.0.5478 || 14r1sr3
|-
||| Windows || n.a. - [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|to be installed separately]]|| 13r3sr10
|-
| Poly ''(formerly Plantronics)'' || MacOS || 3.25.53799.37131 || 13r3sr9
|-
||| Windows || 3.25.53800.37131 || 13r3sr10
|-
| Yealink || MacOS || 3.1.1.20 || 14r1sr3
|-
||| Windows || 3.1.1.20 || 14r1sr3
|}

Notes:
* It is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI Parameters and install options| MSI parameters]] below).

* Starting with V13r3sr10, the Epos-SDK needs to be installed separately using the Epos Connect software to ensure full compatibility between current Epos headset models and native myApps-Windows client. For details [[Support:13r3 sr10 MyApps Windows Client - Epos/Sennheiser-Headsets require installed Epos-Connect Software|refer to this article]].


===== Ring tones =====

Ring tones can be played. Apps can choose the tone from a pre-defined list of ring tones.

On Windows, custom ring tones can be uploaded as .mp3 files to the <code>ringtones</code> sub-directory of myApps' roaming directory (which usually is in <code>C:\Users\...\AppData\Roaming\innovaphone\myApps\ringtones</code>).

On Android, custom ring tones can be added to the system via Android settings.

On iOS, custom ring tones can be uploaded as .mp3 files to the <code>Ringtones</code> subdirectory of the myApps file share that is available in iTunes if the iPhone has been connected via USB.

On macOS, custom ring tones can be uploaded as .mp3 files to <code>~/Library/Containers/com.innovaphone.client-macos/Data/Documents/Ringtones</code>.

===== Debugging =====
For extended debugging, turn on the ''Audio'', ''Media'' and ''AppSharing'' traces in myApps.

=== Hot keys ===
On Windows and macOS systems, myApps platform services can listen for hot keys and invoke certain functions. Invocation is done by sending API messages to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function. If you do not want to start the call with "Hotkey+Enter" because you would have to wait for the focus, the hotkey can also be pressed twice and the number is dialled directly.

; dial selected number : Initiates a call using the currently selected text as target.

: A ''PrepareCall'' message with the ''text'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":"mt":"PrepareCall","text":"13","adjust":true}}</code>

; accept call : Accepts a currently alerting call.

: A ''ConnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"ConnectCall"}}</code>

; reject/disconnect call : Rejects a currently alerting call or disconnects an active call.

: A ''DisconnectCall'' message will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].

:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"DisconnectCall"}}</code>

=== URL Handler ===

On Windows systems, two URI-handler are installed with the myApps platform services. Windows will call up this URI handler when a user clicks on an appropriate link, for example in a web site.

The handler will the send an API message to myApps which passes it to an appropriate API provider (in the cases described here, this will be a ''phone'' or ''softphone'' or ''rcc'' App typically. See [[{{NAMESPACE}}:Concept_myApps#Client_APIs_and_default_apps | Client APIs and default apps]] for more details about this mechanism.

; tel URI : call a number, e.g. <code>tel:4711</code>

: A ''PrepareCall'' message with the ''num'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","num":"4711","adjust":true}}</code>
; sip URI : call a SIP name, e.g. <code>sip:zkl@innovaphone.com</code>

: A ''PrepareCall'' message with the ''sip'' argument set to the selected text and the ''adjust'' argument set to <code>true</code> will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm ''com.innovaphone.phone'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.phone","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartCall","sip":"zkl@innovaphone.com","adjust":true}}</code>
; im URI : start chat with SIP name, e.g. <code>im:zkl@innovaphone.com</code>

: A ''StartChat'' message with the ''sip'' argument set to the selected text will be sent to the [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm ''com.innovaphone.chat'' API].
:: <code>{"mt":"ApiRequest","apiId":"com.innovaphone.chat","consumer":"@local-ae2fc2ab74-3f1e-4ab9-b215-d42f213520317","msg":{"mt":"StartChat","sip":"zkl@innovaphone.com"}}</code>

On macOS systems myApps might be made the default application to handle tel URI e.g. <code>tel:4711</code> via Apple FaceTime. Open the "FaceTime" menu "Settings..." and select myApps as "Default for phone calls".

On iOS ''tel'' URIs are always dialed via GSM. Therefore myApps iOS also reacts to URI schemes ''com.innovaphone.tel'', ''com.innovaphone.sip'' and ''com.innovaphone.im'', e.g. <code><nowiki>com.innovaphone.tel:4711</nowiki></code>, <code><nowiki>com.innovaphone.sip:zkl@innovaphone.com</nowiki></code>, <code><nowiki>com.innovaphone.im:zkl@innovaphone.com</nowiki></code>.

=== User activity ===
On Windows and macOS systems, the myApps platform services can monitor user keyboard/mouse activity and change the user's presence state after a certain amount of inactivity. The timeout can be specified using the ''advanced settings'' user interface (see [[#UI elements| UI elements]] below.

myApps will then send a [https://sdk.innovaphone.com/doc/appwebsocket/myApps.htm#SetUserActivity''SetUserActivity''] message to the PBX using the ''myApps'' protocol.

: <code>{"mt":"SetUserActivity","inactive":true}</code>

This will change the ''status'' property of the ''im:'' contact for the user's own presence and hence result in a presence update from the PBX to myApps

: <code>{"mt":"UpdateOwnPresence","presence":[{...},{"contact":"im:","activity":"","status":"closed"}]}</code>
The ''closed'' status is reflected in the grey status color when displaying a contact [[Image:myapps-inactive.png|myapps-inactive.png/]].

On iOS and Android, the state is set to ''inactive'' as soon as the App is brought to background.
When myApps platform services are not available (i.e. when running the web application in a browser solely) a limited user activity monitoring is available: the state is set to active when the web page is not used for more than 5 minutes.

=== Recording ===

The new launcher offers the possibility to record the audio of incoming and outgoing calls. In order to activate that functionality the URL of the recording instance must be configured in either the PBX (PBX->myApps->Config: Recording URL) or the softphone App (Settings->Audio Recording (URL))

[[Image:PBX-Recording-Settings.png|pbx-recording-settings.png/]] [[Image:Recording-Softphone-Settings.png|recording-softphone-settings.png/]].

As long as that URL is configured the audio data of all calls are stored as pcap-files under that URL.
If the URL points to a CF device in the PBX, write access must be granted for that URL (PBX->Services->HTTP->Server:Public compact flash access) and if the URL points to the recording app, the files can be accessed via the recording app [[{{NAMESPACE}}:Concept_App_Service_Recordings|recording]].

Under PBX->myApps the administrator can set a certain default behaviour of the audio recording like whether or not the recording should start automatically at the beginning of the call (Recording by Default ON/OFF), only calls with external numbers should be recorded (Record external calls only) or whether or not the user should be able to start/stop the recording himself (Allow user incall recording control). Except for the last parameter these parameters can also be modified by the user in its softphone settings if the administrator doesn't set the FORCE flag.

If the user was allowed by the admin to control the recording a recording switch is active during the call when the "Media" Panel is opened. There the audio recording may be stopped and continued at will. A red recording notice is shown in the top right corner when the recording actually takes place.

[[Image:Recording-incall-switch.png|recording-incall-switch.png/]]

=== Notifications ===

The myApps platform services can use the OS specific notification mechanism (e.g. ''desktop notifications'' on Windows) to display messages (e.g. ''incoming new chat message'') to the user.

Note that the actual rendering of the notification is under control of the OS. Therefore, myApps must be allowed to show notifications and its appearance can be restricted by OS native settings.

==== Microsoft Windows Notifications ====

Microsoft Windows Server editions (2016, 2019, 2022) are just capable of showing a single ''IncomingCall'' notification at the same time (we couldn't find a workaround for this limitation). 
An ''IncomingCall'' notification is visible the whole time instead of being moved to the action center after a certain time. 
 
A notification about a missed call uses the ''IncomingCall'' type so that this notification is visible until the user returns. 
Due to the above limitation, on a new arriving call such a missed call notification is transformed to a default notification which will be moved to the action center automatically. 
 
On non server editions, you can have multiple IncomingCall notifications at the same time (so two parallel incoming calls will be indeed notified at the same time), but the missed call notification handling is the same on both platforms!

Thus there will be always just '''one''' missed call notification visible and previous missed calls can be found inside your action center!

To see myApps notifications, ensure:
* System -> Notifications
** enable notifications
** disable "Do not disturb" or allow myApps as priority application while "Do not disturb" is active
** enable notifications for myApps in the list of applications
* System -> Focus
** if a focus session is active and the "Do not disturb" is activated during a focus session, make sure that myApps is a priority application (see above)

==== macOS Notifications ====
Notifications are the same as on Windows.
The difference is, that for macOS, notifications need to be allowed in the system settings.
Go to Notifications - myApps, select Banner and enable all check marks.

=== Local phonebook access ===
'''Contact Search:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm ''com.innovaphone.search'' API]]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Search'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{"mt":"Search","type":"contact","search":"john doe"},"apiId":"com.innovaphone.search"}</code>
Search results are delivered as ''SearchInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>

'''Reverse Lookup:''' The myApps platform services implement an ''API provider'' for the [http://sdk.innovaphone.com/web1/com.innovaphone.phonelookup/lib1_api_phonelookup.htm ''com.innovaphone.phonelookup'' API]. They perform search capabilities on the OS' local phone books which can be used by Apps like the ''phoneapp''.

Apps would send a ''Lookup'' request to the API:

: <code>{"mt":"ApiRequest","consumer":"dev:SwPh_zkl_5e42e884","provider":"*","src":"4","msg":{ mt: "Lookup", prefixIntl: "000", prefixNtl: "00", prefixExt:"0", area: "7031", country: "49", lookup: "0004970311234567" },"apiId":"com.innovaphone.lookup"}</code>

Search results are delivered as ''LookupInfo'' messages:

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{mt: "LookupInfo", dn: "Jake Blues", contact: { telephonenumber: ["0004970311234567"], givenname: "Jake", sn: "Blues", company: "Blues Brothers" </code>

==== Windows ====
On Windows, the search and lookup are performed in all of the user's Outlook contact folders. As opposed to the search implemented in the ''Contacts'' and ''Users'' App, all items are returned which match any of the search words (i.e. searching for ''a b'' will return items matching either ''a'' or ''b'').

; searched properties : firstname, lastname
; returned properties : Following Outlook contact phone number properties are returned (if available):

:* OFFICE_TELEPHONE_NUMBER as ''telephonenumber''
:* OFFICE2_TELEPHONE_NUMBER as ''telephonenumber''
:* HOME_TELEPHONE_NUMBER as ''homephone''
:* HOME2_TELEPHONE_NUMBER as ''homephone''
:* MOBILE_TELEPHONE_NUMBER as ''mobile''
:* BUSINESS_FAX_NUMBER as ''facsimiletelephonenumber''
Note that contact information is cached in the search provider. Updated contacts may therefore become effective after a while only.
Outlook search will create its own trace file <code>myAppsOutlookSearch-</code>''date-time''<code>.txt</code> in the standard trace directory.

This search provider is always installed and can be disabled. There is no need (nor possibility) to enable it in the ''Apps'' tab of the PBX's user object. Also, no ''App'' object needs to be created for it.

==== Android/iOS ====
The search and lookup are performed in the contacts.

==== macOS ====
The search and lookup are performed in the contacts. If you wish to disable local contact lookup, go to system settings - Security & Privacy and disable the access to contacts for myapps.

=== Microsoft Office integration ===

The myApps platform services has a ''office presence provider'' that can provide the user's presence state to Office applications. See [[{{NAMESPACE}}:Concept_myApps_Office_Integration|myApps Office Integration]] for details.

This feature is installed by default. However, it can be disabled using the ''OFFICEPRESENCE'' MSI Parameter. Also, a check-mark is available in the setup dialog.

=== Call an external application for calls ===

Phone Apps (such as the phoneapp or softphone) can initiate the start of an external application when a new call appears (either incoming or outgoing). The actual spawning of the application is done by the myApps platform service. Also, the application properties (such as e.g. the executable's path) is configured in the myApps platform services (see [[#UI elements|Advanced settings]] in the ''UI elements'' section below).

A number of arguments can be passed to the application by substituting $-variables in the ''Parameter'' field:

; $n : phone number as dialed (called party number for outgoing calls) or received (calling party number for incoming calls)

; $N : called or calling party number in ''national'' format (e.g. 07031730090)

; $I : called or calling party number in ''international'' format (e.g. +497031730090)

: note that both $N and $I only work if $n includes both subscriber number and area code (e.g. 07031730090). Otherwise they are equal to $n

; $d : display name of peer (if known)

; $u : URI name of the peer (if available eg with a federation call)

; $c : conference id

: this is a globally unique ID for this call and may be used to relate the call to the ''guid'' found in the CallInfo structure in the [http://wiki.innovaphone.com/index.php?title=Reference10:SOAP_API#CallInfo SOAP-API] and [http://sdk.innovaphone.com/doc/appwebsocket/RCC.htm RCC-API ]. Also, corresponding [[Reference10:Call Detail Record CDR PBX|CDRs]] can be related using the ''event'' tag's ''conf'' attribute.
The start of an external application can be requested using the ''com.innovaphone.externalapps'' API.

Some setup examples are [[Howto:Integrate External Apps in innovaphone UC clients|shown here]].

=== Push ===

Mobile operating systems usually inhibit network operation of apps which run in the background or are closed by the user. This is done in order to reduce battery consumption. Unfortunately, this also stops such apps to maintain a registration by regularly sending ''keep alive'' messages to a server (in our case to the PBX). As a result, myApps will be disconnected from the PBX. When the PBX determines that there is an event for the application which needs a response, it needs to wake up the app using a dedicated channel provided by the operating system. This mechanism is know as ''push''. When running on iOS or Android, myApps supports ''push''.

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to be configured in the PBX . Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[{{NAMESPACE}}:Concept_Push_Notifications_for_iOS_and_Android|Reference14r2:Concept_Push_Notifications_for_iOS_and_Android]] for more details.

Also, helpful hints can be found in [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]].

=== App Proxy ===

myApps runs further ''Apps'' (such as e.g. the ''phoneapp'') as a web page in an IFRAME of the browser myApps is running in. The App's page code is loaded either from the PBX or from an ''application platform'' (AP). This however would mean that the App's IFRAME would remain empty (a dead white screen) when the PBX or AP is not available. To make sure the App can start-up anyway, the myApps platform services feature the so-called ''App Proxy''. This is a caching proxy that caches all the App code so it is available even in case of network failure. When myApps runs in the context of the platform services, Apps are therefore not loaded from the App source directly, but from the local App proxy.

The cached files are stored in the PCs local file system in the <code>C:\Users\...\AppData\Local\innovaphone\myApps\appproxy</path></code>. There is no configuration required. However, if myApps seems to run with outdated or corrupt cached copies of the App, you can safely delete the entire directory.

=== Auto update ===

On Windows and on macOS, the myApps platform services can auto-update themselves to a common version. This is controlled by the [[{{NAMESPACE}}:PBX/Config/myApps#Launcher_Software_Update | ''Launcher Software Update'']] settings under ''PBX/Config/myApps'' in the PBX.

When myApps is started or the user logs in or myApps needs to re-connect to the PBX, the platform services will use the [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client API] to learn the desired version (''launcherUpdateBuild'', which is part of the API's ''model''). If this differs from the current version, the platform services will try to download the respective new version.

<code>
{
"mt": "ApiUpdate",
"apis": {
"com.innovaphone.client": {
"@client": {
"title": "innovaphone myApps",
"model": {
"launcher": true,
"launcherUpdateBuild": "134906",
"appStoreUrl": "http://store.innovaphone.com/release/download/"
}
}
}
}
}</code>

The installation of the downloaded version is done by the ''innovaphonemyAppsUpdateService''. This service is installed and enabled during the initial installation of the myApps platform services. To disable auto-update, either leave the ''Launcher Software Update'' settings empty or set the service's start mode to ''disabled'' in the Windows ''services control panel''.

Note that on Windows the update service does not work on terminal servers. Administrators must do myApps base services updates using standard windows mechanisms.

Note that on macOS if myApps has been installed from the Apple Store it is assumed that auto update from the PBX is not desired and disabled therefore.

On Android/iOS/macOS updates can be downloaded from the respective app store.

The ''Devices'' app can not update software installed on Windows PCs directly. However, when the PBX is updated using an ''update job'' in the ''Devices'' App, the ''Launcher Software Update'' settings will be updated accordingly and hence the myApps base services will ultimately also be updated to the same version.

==== Auto update flow on Windows ====

* On start of myApps, myApps checks if an update is available and ready for installation
** if yes, the update is installed directly, without user interaction (a popup is shown during the installation)
** if not, myApps starts
* if an update is available while myApps is already running, an update notification will be shown which let's the user choose to install the update now or later (the notification will then popup again after one hour)

==UI elements ==
There are a few user interfaces provided by the platform services:
===tray-icon (Windows only) ===
::[[Image:myapps-tray.png|myapps-tray.png/]]
:Allows to
:* terminate myApps
:* toggle the ''autostart'' state
:* toggle the ''show in task bar'' state
:* open the trace folder
:
=== PBX connect form===
:: [[Image:myapps-connect.png|myapps-connect.png/]]
: Allows the user to specify the connect data for the PBX (i.e. IP address or DNS name)
:
=== Advanced settings===
::[[Image:myapps-settings0.png|myapps-settings0.png/]]
::[[Image:myapps-settings.png|myapps-settings.png/]] [[Image:myapps-settings2.png|myapps-settings2.png/]] [[Image:myapps-settings3.png|myapps-settings3.png/]]

: Allows to modify various platform dependant settings (such as e.g. the hotkey selection on Windows)

== Interfaces ==
=== Provided APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.search/lib1_api_search.htm com.innovaphone.search] : access to local phone book entries by the [[#Local phonebook access|Local phonebook access]] component.
; [http://sdk.innovaphone.com/web1/com.innovaphone.launcher/com.innovaphone.launcher.htm com.innovaphone.launcher] : display of OS specific user notifications and receipt of related user actions
; com.innovaphone.notificationhandler : reports back click on a notification.
; com.innovaphone.externalapps : to start external applications, see [[#Call an external application for calls|Call an external application for calls]] above

=== Used APIs ===

; [http://sdk.innovaphone.com/web1/com.innovaphone.phone/com.innovaphone.phone.htm com.innovaphone.phone] : used to initiate new or manipulate existing calls by the [[#Hot keys|Hot keys]] and [[#URL handler|URL handler]] components.

; [http://sdk.innovaphone.com/web1/com.innovaphone.chat/com.innovaphone.chat.htm com.innovaphone.chat] : used to start a new chat by the [[#URL handler|URL handler]] component.

; [http://sdk.innovaphone.com/web1/com.innovaphone.client/lib1_api_client.htm com.innovaphone.client] : the model is used to learn the update settings, see [[#Auto update|Auto update]] above

=== Protocols ===

; [https://sdk.innovaphone.com/doc/launcher/Media.htm Media Protocol] : used by apps to allocate RTP channels, see [[#RTP service for audio.2C video and data|RTP service for audio, video and data]] above

== Related App Services ==

none

== Known limitations ==
; Incoming call as banner on myApps for iOS : Since iOS 14 the iOS CallKit presents incoming calls as a banner leaving the original green answer button of myApps visible. Use only the blue button of the banner to accept the call or change iPhone Settings, App "Phone", "Incoming Calls" to "Full Screen" to hide the myApps user interface again during call answering.

; Call answer in speakerphone mode even with active Bluetooth headset on myApps for iOS : This causes unwanted speakerphone operation if the smartphone is used with a Bluetooth car audio system. The behaviour can be changed by selecting ''Bluetooth Headset'' in this setting:
:''iOS Settings->Accessibility->Touch->Call Audio Routing: Automatic / Bluetooth Headset / Speaker''
:''iOS Einstellungen->Bedienungshilfen->Tippen->Anrufaudioausgabe: Automatisch / Bluetooth-Headset / Lautsprecher''

; Windows Server 2016 (Windows 10 Build 1607) : windows just shows the first notification. Further notifications aren't displayed until the previous ones are removed from the notification center. Current windows builds do not show this behaviour anymore.

; Problems on Mac computers with Yealink USB headsets
: we have received reports that myApps quits unexpectedly on some Mac computers when a Yealink headset is plugged in. Unfortunately, we could not find out the cause yet. If you use Yealink USB headsets and have a similar issue, please open a support ticket and send myApps traces.

; Poly / Plantronics headset buttons only functional if myApps is started with Rosetta
: myApps macOS supports Apple M1/M2 hardware natively. However, the Poly / Plantronics headset SDK is only available for Intel platform and thus myApps needs to be started via Apple's Intel emulator Rosetta if a Poly / Plantronics headset is used. This is done with right-click on the myApps executable, ''Information'', ''Open with Rosetta''.

; Windows surface devices may not work correctly
: Chromium does not get touch keyboard events. USB Keyboards may not be recognized either.

= Installation =

== Windows ==

myApps platform services are installed on Windows using the .msi file found in the ''myApps Windows'' package from [https://store.innovaphone.com/release/download.htm store.innovaphone.com].

myApps can update itself automatically, see [[#Auto update|Auto update]] above.

=== MSI Parameters and install options ===

The MSI installer of myApps for Windows supports the following parameters and can be edited with [https://docs.microsoft.com/en-us/windows/win32/msi/orca-exe Microsoft Orca]. You can add your parameters in the table ''property''.

; SERVER (REG_SZ): the PBX's server URL
; OFFICEPRESENCE (REG_DWORD): '''false''' to disable presence integration in Microsoft Office
: this is also available as a check-mark when running the install manually

; DISABLEHEADSETS (REG_DWORD): '''true''' to disable headsets support, see [[#Device handling|Device handling]] above

; EXTERNALAPPS (REG_SZ): pre-define external applications, see [[#Call an external application for calls|Call an external application for calls]] above
: e.g. <code>"{""externalApps"":[{""id"":0,""name"":""Wireshark"",""path"":""C:\\Program Files\\Wireshark\\Wireshark.exe"",""param"":""test $I""}]}"</code>

; FORCERESTART (REG_DWORD): '''true''' (or any string ...) kills myApps during the installation and restarts it for the currently logged in user, if it was running

; DISABLELOCALHOST (REG_DWORD): '''true''' to disable use of '''localhost''' string to access the local webserver. Use '''127.0.0.1''' instead

; EXCLUDEINTERFACES (REG_SZ): some VPN interfaces are not detected by Windows as IF_TYPE_PPP or IF_TYPE_TUNNEL and therefore the '''media outside VPN''' setting is not taking effect. With this option interfaces can be pre-defined that will not be used for media. Interfaces must be comma separated
: e.g. <code>EXCLUDEINTERFACES="172,192.168,10.10"</code>

Current settings are stored in the registry at <code>Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps</code> or at <code>Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\innovaphone\myApps</code>

Boolean values like OfficePresence are stored in registry entries with type REG_DWORD and values 1 or 0. 0 disables the setting and 1 enables it.

== iOS ==

myApps platform services are installed on iOS by loading ''innovaphone myApps'' from the ''App Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<code><plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist></code>

== macOS ==

myApps platform services might be installed directly from the Apple store. An installer package <code>myapps.pkg</code> and a disk image <code>myapps.dmg</code> is also available from the innovaphone app store. Install <code>myapps.pkg</code> by double-click on the file and follow the instructions of the installer. myApps becomes available in the Applications folder and can be opened by double-click. Or download and open <code>myapps.dmg</code> and double klick myApps. If desired integrate it into the app dock by right click, ''Options, Keep in the dock''.

If installed from the innovaphone app store, myApps can update itself automatically, see [[#Auto update|Auto update]] above.

If installed from the Apple store, macOS notifies about updates on the Apple store. myApps [[#Auto update|Auto update]] is disabled then.

If a clean-install of the client is necessary, the folder "/Users/username/Library/Containers/myapps" needs to be deleted. To be on the safe side also delete it from the trash bin.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying this dictionary in the MDM
<code><plist>
<dict>
<key>server</key>
<string>pbx.example.com</string>
</dict>
</plist></code>

=== Preferences ===

macOS supports preference settings that can be set via a shell command or via Mac remote management

<code>> defaults write com.innovaphone.client-ios-14r1 server "PBX-server-URL"</code>

The following parameters and can be set through this method:

; server: the PBX's server URL

=== Setting myApps as Default App for SIP-URLs ===
{| class="wikitable"
|defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add '{
LSHandlerURLScheme = sip;
LSHandlerRoleAll = "<CFBundleIdentifier>";
}'
|}
To find the “CFBundleIdentifier”, proceed as follows:

* In the Finder under “Applications”, search for the desired myApps client that you want to set as the default app.

* Right-click on “Show package contents” -> you will find the “CFBundleIdentifier” in the Info.plist file.

A restart of the MAC is required.

=== Using Sennheiser headsets ===
If you use Sennheiser headsets, you should also install the then-current <code>DSEA_SDK_v</code>''version''<code>.pkg</code> package, after you installed the myApps client. Without that, audio will still work, but not the controls on the headset. You will need to keep that up-to-date yourself, as it is not updated by myApps's auto-update function.

== Android ==

myApps platform services are installed on Android by loading ''innovaphone myApps'' from the ''Play Store''.

=== Configuration via MDM ===

the PBX's server URL can be pre-configured by specifying a property "server" with string value "pbx.example.com" in the MDM.

= Configuration =

== Server configuration ==
When opening myApps for the first time, the user is prompted for the Server. Usually only the hostname (DNS host name or IP address) needs to be configured.

But there are more options for special PBX configurations.

; Non-standard HTTPS port
: If the PBX uses a non-standard HTTPS port, it must be appended to the host name separated by a colon (<code>:</code>).
: Example: <code>pbx.example.com:4444</code> (expands to <code>https://pbx.example.com:4444/PBX0/APPCLIENT/appclient.htm</code>)
; DynPBX module name
: If the PBX is a DynPBX, the module id must be appended to PBX0 separated - (<code>/</code>).
: Example: <code>pbx.example.com/PBX0-1</code> (expands to <code>https://pbx.example.com/PBX0-1/APPCLIENT/appclient.htm</code>)
; Softphone physical location
: If user defined physical location shall be used for softphone, you can append it using a parameter <code>#phys=</code>.
: Example: <code>pbx.example.com#phys=slave</code> (expands to <code>https://pbx.example.com/PBX0/APPCLIENT/appclient.htm#phys=slave</code>)

Example 1: PBX pbx.example.com with standard configuration
pbx.example.com

Example 2: PBX slave.example with DynPBX module ID 1, HTTPS port 4444 and physical location master
slave.example.com:4444/PBX0-1#phys=master

=== HTTP proxy support ===

myApps platform services do support operation via HTTP proxy now. If one or more proxies have been configured in the network settings of the operating system for the active network connection, HTTP CONNECT tunnels are established.

On Windows user name and password can be specified for the tunnel servers as generic credentials in the credentials manager (Anmeldeinformationsverwaltung). The name of the credentials must be the tunnel server hostname.

On Android user name and password can be specified through Android ''Settings, Accounts'' by adding a myApps ''HTTP Proxy Credentials'' account. The name of the account must be the tunnel server hostname.

== Platform specific settings ==
When myApps runs under the myApps platform services, it will show various platform specific settings as part of its ''burger menu'', so the user can set them. See ''Advanced settings'' in [[#UI elements|UI elements]] above.

Some options can also be set globally for all myApps clients in the PBX's [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps ''Client Settings'']]
{|
! style="text-align: left; font-weight: bold" | Option

! style="text-align: left; font-weight: bold" | Description

! style="text-align: left; font-weight: bold" | Where to set

!
! style="text-align: left; font-weight: bold"| Availability
|-

| || || User menu || PBX ''Client Settings'' || Windows || iOS || Android || macOS

|-
| Autostart || Launch myApps on login || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Appear offline after || controls after which idle time a user is considered ''inactive''. See [[#User activity|User activity]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔
|-

| Hotkeys || Hotkeys for call dial, accept, reject. See [[#Hot keys|Hot keys]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| Docking || Docking mode (left, right, none). See [[#???|??]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✗

|-

| Desktop notifications|| Turn on/off platform notifications. See [[#Notifications| Notifications]] above || ✔ ||✔ ||✔ || ✗ || ✗ || ✔

|-

| VPN || Disable VPN address for ICE candidate selection. See [[#RTP ports| RTP ports]] above || ✔ ||✔ ||✔ || ✗ || ✔ || ✔

|-

| Show in taskbar|| Show myApps in the taskbar in addition to it's tray icon. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗

|-

| Log flags || turn on/off certain trace levels. See [[#Troubleshooting|Troubleshooting]] below. || ✔ ||✔ ||✔ || ✔ || ✔ || ✔

|-

| External applications || define the applications available for Apps to be started. See [[#Call an external application for calls|Call an external application for calls]] above. || ✔ ||✗ ||✔ || ✗ || ✗ || ✔

|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker. || ✔ ||✗ ||✔ || ✗ || ✗ || ✗
|}
== Start parameters for Windows ==

On Windows, it is not possible to pass start parameters from the [https://www.chromium.org/developers Chromium documentation] to the myApps process.

== OS Settings for Windows ==
Windows settings can influence the display of ''Desktop notifications''. See [https://support.microsoft.com/en-us/help/4028678/windows-10-change-notification-settings Change notification settings in Windows 10/11] for details.

=== Windows 11 ===

* Windows 11 has a feature "do not disturb". This hides notifications if enabled.
* Windows 11 has a feature "focus". This enables "do not disturb" and thus hides notifications too.
* Windows 11 has priority settings for notifications. Ensure that VoIP notifications for calls are allowed any maybe also include myApps as an App which is allowed to show notifications.

== OS settings for Android ==
; Events : The appearance of notifications can be controlled here.

; Call accounts : For proper incoming call signaling, the call account ''myApps'' needs to be enabled. Note that on Samsung smartphones the call account switch likely toggles back and a few tries may need to be done until it persists. Please double-check the state.

; Preferred Calling Account : Choose which calling account (myApps/SIM/..) should be used for outgoing calls initiated from within the native phone app / phone book.

; Background data, unlimited data usage : Grant background data use to enable ''myApps'' to connect to the PBX immediately on an incoming call.

; Overlaying : This setting is not needed if call account ''myApps'' has been enabled. Should there be a reason for not enabling call account ''myApps'', the permission for overlaying needs to be granted on Android 10 or higher for proper call signaling.

Note: If no SIM card is installed some Android smartphones exhibit a problem dialing from the smartphone contacts. The contacts app shows a choice ''Select SIM card for this call'' but all possible dialers are greyed out. In this case make myApps the default phone app in Android settings ''Apps, Default apps, Telephony''.

== OS settings for iOS ==
; Notifications : The appearance of notifications can be controlled in iOS ''Settings, myApps''.

== OS settings for macOS ==

; Notifications : The appearance of notifications can be controlled in macOS ''Preferences, Notifications, myApps''.

=Troubleshooting=

myApps platform services can write various traces for debugging. Trace can be turned on and off selectively in the [[#Advanced settings|Advanced settings]].

The following trace flags can be set:

(''Recommended trace options are: '''App, Browser, ICE, TURN, Signaling and Audio'''. Please do not activate other flags unless innovaphone support says otherwise'')

{|
!style="text-align: left; font-weight: bold" | Abbreviation

!style="text-align: left; font-weight: bold" |code

!style="text-align: left; font-weight: bold" | description

|-
| App||0x000000001|| logs from the App Service itself
|-
| DNS||0x000000008|| logs DNS requests and results
|-
| HTTP client||0x000000080|| http client logs
|-
| TLS||0x000000400|| TLS logs
|-
| TCP||0x000000800|| TCP logs
|-
| LDS||0x000001000|| local domain sockets
|-
| WebSocket client||0x000004000|| logs outgoing websocket connections
|-
| App WebSocket||0x000008000|| logs app websocket connections (e.g. from PBX objects to an App Service or from the UI to the App Service)
|-
| UDP||0x000200000|| UDP logs
|-
| DTLS||0x000400000|| logs DTLS handshake and messages
|-
| Media||0x000800000|| logs media events
|-
| Media channel||0x001000000|| logs RTP/SCTP media connections
|-
| ICE||0x002000000|| logs ICE messages between peers
|-
| TURN||0x004000000|| logs TURN messages between peers
|-
| AppSharing||0x008000000|| logs AppSharing connection
|-
| Audio||0x010000000|| logs Audio connection and headset events
|-
| Video||0x020000000|| logs video connection and webcam events
|-
| Browser||0x040000000|| logs Chromium events
|-
| AppProxy||0x080000000|| logs requests which are proxied between the local webserver and the remote server
|-
| Webserver ||0x200000000|| enables webserver specific logs
|-
| Browser Console ||0x400000000|| logs browser console events
|-
| Signaling||0x800000000|| enables logs in the signaling module for debugging calls
|}
''code'' can be or'ed and used as value for the ''Log flags'' field in [[{{NAMESPACE}}:PBX/Config/myApps#Client_Settings|PBX/Config/myApps/Client Settings]].

; Windows :On Windows, traces are written to the <code>C:\Users\[UserName]\AppData\Local\innovaphone\myApps</code> directory. If you start myApps with --log-size as parameter, you can define the maximum size of a log file (e.g. --log-size=100000000 would be 100MB for each file)

:* myApps-''date-time''.txt : main log file for the platform services

:* myAppsOutlookSearch-''date-time''.txt : log file for the Outlook phone book access

:* myAppsHookController-''date-time''.txt : log file for the hot-key interceptor (see [[#Hot keys|Hot keys]])

; :myApps update installation traces are written to the <code>%windir%\temp\</code> directory.
:* myAppsInstall.txt: MSI installation file

; :myApps update service traces are written to the <code>%ALLUSERSPROFILE%\innovaphone\myAppsUpdateService</code> directory.
:* myAppsUpdateService-''date-time''.txt: myApps update service traces

;Android : traces can be sent by e-mail.

: also, an Android device might also be connected to a PC via an USB cable to get the traces. The files can be found in <code>Android/data/com.innovaphone.clientandroid/files</code>

; iOS : traces can be sent by e-mail.

; macOS : traces can be sent by e-mail.

: also, the files can be found in <code>~/Library/Containers/com.innovaphone.client-ios/Data/Documents/</code>. Press ''Alt+N'' followed by space to get tilde ''~''.

= Known Problems =
[[:Category:Problem myApps platform services|Known Problems]]

= Related Articles =
* [[{{NAMESPACE}}:Concept_myApps]]
* [[{{NAMESPACE}}:Concept_myApps_Redundancy|Reference14r2:Concept_myApps_Redundancy]]
* [[{{NAMESPACE}}:Concept_myApps_Office_Integration|Reference14r2:Concept_myApps_Office_Integration]]
* [[{{NAMESPACE}}:Concept_myAPPs_Search_in_local-Outlook_Contacts|Reference14r2:Concept_myAPPs_Search_in_local-Outlook_Contacts]]
* [[{{NAMESPACE}}:Call_Detail_Record_CDR_PBX|Reference14r2:Call_Detail_Record_CDR_PBX]]
* [[{{NAMESPACE}}:Concept Push Notifications for myPBX iOS and Android|Reference14r2:Concept Push Notifications for myPBX iOS and Android]]
* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]
* [[{{NAMESPACE}}:PBX/Config/myApps]]

[[Category:Concept myApps platform services]]

Reference13r3:Unite/SMS

2025-05-06T07:35:13Z

Sga:

'''Configure Messaging/SMS'''

Note: This SMS tab is only accessible if the Master mode is activated

* '''Multicast''': enable to send messages to multicast groups
**Multicast groups are created in the Unite CM or in the Unite CS
**In a Multiple Master System all users to be reached by a Multicast message must exist in the PARI Master
**To support Multicast only Worf (KRCNB 30x , BS3x0) and DB1 RFPs shall be used.
* '''Encryption''': enable encrypted communication between the Master and the Unite module
**When selecting or clearing the Encryption check box, it may take up to a couple of minutes until the Unite module is fully operational.
**The Unite module support for encryption is depending on the Unite module software version.
* '''IP Address''': IP address of the Unite module to be used in the IP-DECT system

Note: If the phonebook functionality in the device is enabled, then the SMS feature in the Unite is disabled. If an Unite server is connected, the central phonebook should be located in the Unite instead.

{{Template:Disclaimer - Ascom UNITE Integration}}

Reference15r1:IP1202/IP1203 DECT System

2025-05-05T14:46:04Z

Sga: /* Mixed Ascom/innovaphone Environments */

This article describes the IP1202/IP1203 DECT system and provides further helpful information.

==Applies To==
This information applies to:
*IP1202, IP1202/4, IP1202/4s, IP1202e
*IP1203, IP1203/4, IP1203e
*IP64
*IP65
*Ascom d83
*Firmware Version 15

==Product Availability==
===IP-DECT base stations===
* '''[[Datasheet IP1203|IP1202/4s]]''': Singlecell DECT basestation, offering up to 4 concurrent DECT-channels. Minimum required firmware 13r1sr8.
* '''[[Datasheet IP1203|IP1203]]''': Multicell capable DECT basestation, offering up to 8 concurrent DECT-channels. Successor of IP1202.
* '''[[Datasheet IP1203|IP1203/4]]''': Multicell capable DECT basestation, offering up to 4 concurrent DECT-channels. Successor if IP1202/4.
* '''[[Datasheet IP1203|IP1203e]]''': Multicell capable DECT basestation, offering up to 8 concurrent DECT-channels, two external antenna connectors and two included dipole omni directional antennas. Successor of IP1202e.
===IP-DECT handsets===
Current innovaphone portfolio includes the following DECT devices (as of August 2022):
* '''[[Datasheet IP64|IP64]]''': Entry level handset. Successor of IP61.
* '''[[Datasheet IP65|IP65]]''': Advanced level handset with messaging abilities. Successor of IP63.
* Ascom '''[[Datasheet d83|d83 Talker]]''': DECT phone for rough environments. Successor of d81.
* Ascom '''[[Datasheet d83|d83 Messenger]]''': DECT phone for rough environments with messaging functionality
* Ascom '''[[Datasheet d83|d83 Protector]]''': DECT phone for rough environments with alarming and messaging functionality

===IP-DECT Antennas===
{{IP-DECT External Antennas}}
For details about external antennas and their usage, refer to [[Reference:IP1202e DECT base station with external antennas|this article]].
===Base station housings===
{{IP-DECT Outdoor Housings}}
===Accessories===
* simple charger (50-00060-001) for both IP64 and IP65 (DC3-UAAA)
* simple charger (50-00083-019) for d83 (DC3-AAAD)
* programming device (50-00060-021) for both IP64 and IP65 for administration purposes via WinPDM (DP1-UAAA - same as for Wifi-device IP73, no Firmware Update for the device itself is required)
* programming device (50-00083-020) for Ascom d83 for administration purposes via WinPDM (DP1-AAAD)
Remarks:
* Chargers and programming devices are not part of the handset delivery and '''have to be ordered separately'''.
* Any previously available DECT devices are end-of-life and no more supported.
==Firmware==
Firmware for DECT-basestations (IP1202, IP1202e, IP1202/4, IP1202/4s, IP1203, IP1203e, IP1203/4), handsets (IP61, IP63, IP64, IP65) and WinPDM can be downloaded via the [https://store.innovaphone.com/release/134513/download.htm innovaphone AppStore].

IP1203x is supported by major firmware version 13 and higher. It can be operated together with IP1202 devices with the same V13 firmware version.

Starting with 15r1, the VARs flash space for IP1203 base stations [[ReleaseNotes15r1:Firmware#189353_-_ip1203:_increase_VARs_flash_space|was increased]]. If you want to '''downgrade''' an IP1203 base station to prior 15r1 firmware, you have to download the current config, downgrade the IP1203 and upload the config afterward again.

==OTA (Over the Air) Features==
===Important===
If you have your IP120x radios already included in an Ascom Unite system, you can't use these features, since the unite module inside the IP120x configuration is used for the innovaphone OTA features also. 
So either you use a Unite system (which includes paramter configuration and firmware updates) or our OTA features.

A running call won't be affected by the firmware update and the handset will only restart, if the call is ended. But keep in mind, that the update progress will take much longer, since the resources of the IP120x are primary used for running calls.

===Devices App (recommended)===
* You can configure an update job to roll out handset updates: [[{{NAMESPACE}}:Concept_App_Service_Devices#DECT_handsets]].
* You can configure a DECT handset configuration to roll out handset configuration options: [[{{NAMESPACE}}:Concept_App_Service_Devices#DECT_handsets_2]].
* See [[{{NAMESPACE}}:Concept_App_Service_Devices#Supported_DECT_handsets | Supported DECT handsets]].

===Firmware update (manual configuration)===
Firmware of IP64, IP65 and Ascom d81 and d83 handsets can be updated via parameter definition on the dect master.

Upon registering of the handsets, they give the dect master their current firmware version information. If this version differs from the configured firmware version parameter, the base station on which the handset is registered on, starts a download of the firmware. 
After the download is completed, the handsets restarts automatically with the new firmware.

The following config lines need to be added to the IP120x configuration, to update all registered IP64 and IP65 handsets, for example to firmware 3.0.16:

<code>
!config change DEVMANBW /hs-param-url 
!config change DEVMANPP /firm-dh7 3.0.16 /firm-dh7-url http://<PATH to Webserver>/IP65/DH7-M_v3.0.16.bin /firm-dh6 3.0.16 /firm-dh6-url http://<PATH to Webserver>/IP64/DH6_v3.0.16.bin 
!config write 
!config activate
</code>

====Explanation of the parameters====

'''''/hs-param-url''''' enables the over-the-air feature in the '''DEVMANBW''' module. The firmware parameters need to be configured in the '''DEVMANPP''' module.

'''''/firm-dh7''''' sets the firmware value for IP65 handsets to the wanted firmware version. If the handset already have that firmware, no update is executed. 
'''''/firm-dh7-url''''' URL where the firmware binary for IP65 handsets can be downloaded. 
'''''/firm-dh6''''' sets the firmware value for IP64 handsets to the wanted firmware version. If the handset already have that firmware, no update is executed. 
'''''/firm-dh6-url''''' URL where the firmware binary for IP64 handsets can be downloaded. 

====More information====
* Only the .bin files can be used as download. If you've downloaded the firmware via our store, it is in .pkg format and includes more data. You need to unpack the .pkg (for example via 7zip or WinRAR) to get the .bin file.
* For each handset, a separate download of the firmware will be executed. So if you have three IP65 handsets registered on the same IP120x, three downloads will be started.
** The DEVMANPP module in the master will limit it to max 10 downloads in parallel. There are also some limitations in the handset that will make sure that there are not more than 5 downloads per radio.
* If a handset is shut down or deregistered while the download is running, the download is cancelled and will be started again, the next time the handset is registered.

===Configuration of Handset parameters ===
'''Important:''' This Feature is available with firmware version '''4.3.2''' onwards for IP64 and IP65 Handsets.

IP64 and IP65 handsets can receive different configurations via a parameter .xml-file from the base station.

The following config lines need to be added to the IP120x configuration:

!config change DEVMANBW /hs-param-url http://<PATH to Webserver>/<parameter-file>.xml
!config write
!config activate

The base station will retrieve the parameter file on restart of the base itself or on the configured timeout value (default is 60 minutes). 
You can adjust the default timeout to a lower value, e.g. 1 minute, by adding the following config:

!config add DEVMANBW /cfg-poll-interval 1
!config write
!config activate

For the handsets to get the parameters, they need to be restarted. After connecting to the base station, the handsets will retrieve the parameters.

An example .xml-file can be downloaded [[Media:Parameter.zip|here]]. 
This file will set the following parameters on the handset:
* Language = German
* Date format = DD/MM/YYYY
* Voicemail number = 99

A list with all available parameters can be found [[Media:Parameter id.pdf|here]].

====Explanation of the parameter list====

Parameter id range 4-7 is for configuring the call menu options, which comes in pairs. So even numbers define the menu text and odd numbers the action (4 and 5, 6 and 7 etc.). Typically used for defining feature access codes.

==== Troubleshooting OTA ====
If the handset is not updated, please send us (support@innovaphone.com) a trace with following options:

'''All IPv4 TCP/UDP Traffic'''

'''All IPv4 TLS Traffic'''

Also enable further trace options, via commands on the base station:
!config add CUNITE /trace /module-trace verbose
!config add CUNITE FILEGET /trace /module-trace verbose
!config add DEVMANPP /trace /module-trace verbose
!config add DEVMANBW /trace /module-trace verbose
!config add MATP /trace /module-trace verbose
!config write
!reset

==Licensing==
innovaphone DECT devices are only operational with innovaphone PBX licenses. Operation without innovaphone PBX is not possible.

==Compatibility Statements==
IP1202 and IP1203 base stations are compatible to each other and can be used in mixed systems in V12 and V13 innovaphone PBX environments (with most recent FW version). When adding an IP1203 to an IP1202 installation, an update of the DECT devices to a V13 firmware is required (PBX can remain on V12 firmware).

===No Base Station and No Handset Compatibility===
The IP1202/IP1203-based IP-DECT solution is '''not compatible''' to IP1200 based IP-DECT solution.

The ''old'' DECT handset IP50, IP52, IP54, IP55, IP56 will '''not operate''' on ''new'' IP1202/IP1203-based IP-DECT system, since not only GAP compliance is required, but also CAP compliance (DECT external handover CAP-N.1).

The DECT handset '''must support GAP and CAP''' for operation on IP1202/IP1203 based DECT system.

The ''new'' DECT handsets IP61, IP63, IP64 and IP65 will '''not operate''' on ''old'' IP1200 based IP-DECT system.

The ''new'' DECT base stations IP1202/IP1203 and IP1202e/IP1203e '''can not be used''' to extend an existing ''old'' IP1200 based IP-DECT system.

=> This means '''NO HANDOVER''' between different systems (move with active call on a specific handset from an IP1200-system to an IP1202/IP1203-based-system or vice versa)

=> This means '''NO ROAMING''' between different systems (usage of a specific handset in a non-compatible IP-DECT system - see above)


=== Mixed Ascom/innovaphone Environments ===
It is generally not supported to mix Ascom (or any of their OEM-products) and innovaphone DECT products in a single installation, e.g.

* Combination of IP120x and Ascom IPBSx base stations is neither allowed nor supported
* Usage of IP61/IP63/IP64/IP65 with Ascom IPBSx based networks is not supported
* Usage of non-innovaphone handsets in IP120x based networks is not supported
* Usage of innovaphone firmware at Ascom devices (bases and/or handsets) is neither allowed nor supported
Exception: Operation of Ascom d8x in an IP1202/IP1203 environment is supported. 
Exception: Usage of IP61/IP63/IP64/IP65 with Ascom UNITE Alarm/Messaging Server is supported. Pay attention to special [[Reference13r3:Unite/|terms and conditions]] for usage.

===No Multicell License Required===

The Multicell License is obsolete for IP1202-based IP-DECT systems.

For IP1202/IP1203-based IP-DECT systems a SARI (Secondary Access Right Identity for DECT) certificate is required. The SARI activates an IP-DECT Master based on IP1202/IP1203. One single SARI certificate is required for a single IP-DECT system, regardless how many base stations are used. Also for IP-DECT systems with one single base station and single-cell base stations a SARI certificate is required. The SARI certificate is not an innovaphone license and only required to make sure the DECT Radio Fixed Part Identity used in the DECT system is worldwide unique one.

A Multicell License can not be converted to a SARI certificate (and there is also no need to do so).

'''Note''': Multicell capability does not apply to IP1202/4s. IP1202/4s is a single cell basestation without expansion capability for another base station. It does not offer handover and roaming capabilities.

===Certifications and Test Reports===
The innovaphone PBX was tested and certified by Ascom Wireless Solutions with Ascom IPBS based IP-DECT System, on which IP1202 is based (but is not the same product). A [[Index.php?title=Media:Innovaphone PBX and Ascom IP-DECT certified by Ascom.pdf&action=edit&redlink=1|Certificate]] and a [[Index.php?title=Media:Innovaphone and ascom DECT Report.pdf&action=edit&redlink=1|Test Report]] of this certification are available for download.

===Wired Headset Support for IP64/IP65===

The IP64 and IP65 DECT handsets offer a 4-pole 3.5mm phone jack for headset connection.

Following headsets are tested by the manufacturer:
* in-ear headset, incl. cable with phone jack - order no. 50-00060-29
* headset with mic on boom, quick disconnect - order no. 50-00060-30 (needs additional adapter for QD to 3.5mm phone jack - order no. 50-00060-032)

There's no technical support in case of issues for use of other headsets.

====3rd party products====
Partner reports successful testing of following products:
* Sennheiser 506090 CMB 01 CRTL - 4-pole 3.5mm adapter to connect Sennheiser headsets at IP64
* Apple iPhone Headset with 4-pole 3.5mm jack, Tested answer and disconnect by pressing button in headset cord.

Note though, that innovaphone gives no technical support in case of malfunction.

===Bluetooth Headset Support for IP63 / IP65===
IP63 and IP65 DECT handsets support handsfree and headset profiles for Bluetooth.

Following headsets are tested by the manufacturer - for some models restrictions have been reported to us (as of 11/20/18):
* Jabra EVOLVE 65 MS Stereo
* Jabra EVOLVE 75
* Jabra MOTION UC+ MS
* Jabra STEALTH
* Jabra SUPREME UC MS (audio not working correct on outgoing calls with various CTI clients)
* Peltor WS Headset XP (MT H7 WS5)
* Plantronics B825-M Voyager Focus
* Plantronics BackBeat GO 2
* Plantronics Blackwire 710
* Plantronics Explorer 500 Bluetooth Headset Black
* Plantronics ML20 (not for IP65)
* Plantronics M70
* Plantronics M90
* Plantronics Voyager 5200 BT Headset EU
* Plantronics Voyager Edge
* Plantronics Voyager Legend UC (audio not working correct on outgoing calls with various CTI clients)

== DECT In-Call Features ==
IP1202 and IP61/63/64/65 handsets offer In-Call features by R-Key handling accoring to [[Howto:How to use the R-key handling|this description]].

== 3PTY (3 party conference) ==
Starting with version 9 firmware, the IP1202 DECT system supports 3PTY (3 party conference) on DECT phones. However, be aware that this ''requires innovaphone CONF/SCNF interfaces'' as part of the system. Such CONF/SCNF interfaces may or may not be present on a gateway device running the PBX, depending on the model used. See [[Technical Data|respective gateway datasheets]] for ''voice/audio conference channels'' provided by the device. Note that the CONF/SCNF interface used does not need to be present in the PBX device, it can be provided by just any gateway platform available in the system. There are no conference channels available in the IP1202/IP1203 though.

For details about configuration please refer to [[Courseware:IT_Plus_-_Conferencing_and_DECT#3-way DECT conference|the relevant training document]].

== Usage in non-EU countries ==
innovaphone DECT prodcuts of type IP1202x, IP1203x, IP64 and IP65 can technically be operated in most countries of the world, as the hardware supports all relevant DECT frequencies (software configurable).

However, the devices are approved in EU/EFTA states only! Use in other countries will probably be illegal thus.

== Test-SARI ==

DECT Systems are using a worldwide unique system identification (SARI) to be separated from each other.

For test and training purposes, innovaphone offers the following SARI:

31100422072149

This SARI is intended for use in test/training systems only!

'''Usage within productive systems is prohibited and not recommended.'''

If the SARI is changed, all handsets have to be subscribed again.

DECT systems which are near to each other and are using the same test-SARI, may disturb each other.

==DECT Service Codes==
===IP64===
*#34# - Displays the Device Info
*#06# - Displays the IPEI/IPDI
===IP65===
*#34# - Displays the Device Info
*#06# - Displays the IPEI/IPDI
*#77# - Site Survey Tool

==Admin Menu==
The handset has a hidden menu for system administrators. The Admin menu contains:
*Software and hardware information, IPEI/IPDI, and User ID
*DECT link and system information
*Site survey tool
*Fault logging
*Enhanced system menu with ability to alter protection
*Factory reset option

To activate the Admin Menu, enter the Call time screen via "Menu->Call list->Call time" and press <code>> * < < * <</code>

<code>> or <</code> means pressing the rocker key in the indicated direction ;-)

==Status indication LED==
The IP1202/IP1203 has one RGB LED to indicate its current status.

Each blink pattern is represented by a number of blocks where each block is 100 ms. Light grey blocks means that the LED is off. Whenever the indication is changed the new pattern always starts from the first block.

Following status are indicated:

* Idle/OK "Solid blue"
[[image:solidblue.png|solidblue.png/|solidblue.png/]]

IP1202 operational and no traffic on the IP1202/IP1203.

* Starting up/ searching "100 ms blue, 100 ms off"
[[Image:100blue100off.png|100blue100off.png/|100blue100off.png/]]

The IP1202 is in start-up phase, e.g. waiting for parameters from PARI Master, or is searching for air synchronization.

* Active traffic "400 ms off, 2000 ms blue"
[[Image:400ms_off_200ms_blue.png|400ms_off_200ms_blue.png/|400ms_off_200ms_blue.png/]]

IP1202/IP1203 operational and traffic on the IP1202/IP1203.

* Fully occupied "400 ms red, 2000 ms blue"
[[Image:400ms_red_2000ms_blue.png|400ms_red_2000ms_blue.png/|400ms_red_2000ms_blue.png/]]

Fully occupied with speech traffic.

* Software download "400 ms blue, 600 ms off"
[[Image:400ms_blue_600ms_off.png|400ms_blue_600ms_off.png/|400ms_blue_600ms_off.png/]]

Firmware download in progress.

* Mini firmware "100 ms yellow, 100 ms off"
[[Image:100ms_yellow_100ms_off.png|100ms_yellow_100ms_off.png/|100ms_yellow_100ms_off.png/]]

The IP1202 is in mini firmware mode.

* TFTP mode "Solid yellow"
[[Image:solid_yellow.png|solid_yellow.png/|solid_yellow.png/]]

TFTP mode.

*Error "100 ms red, 100 ms off"
[[Image:100ms_red_100ms_off.png|100ms_red_100ms_off.png/|100ms_red_100ms_off.png/]]

No Ethernet connection.

*Fatal error "Solid red"
[[Image:solid_red.png|solid_red.png/|solid_red.png/]]

Fatal hardware error.

*Deployment: Good sync "2000 ms blue, 400 ms yellow"
[[Image:2000ms_blue_400ms_yellow.png|2000ms_blue_400ms_yellow.png/|2000ms_blue_400ms_yellow.png/]]

The IP1202/IP1203 is in deployment mode and has good air sync coverage.

*Deployment: Bad sync "400 ms blue, 600 ms off, 400 ms blue, 600 ms off, 400 ms yellow"
[[Image:bad_sync.png|bad_sync.png/|bad_sync.png/]]

The IP1202/IP1203 is in deployment mode and does not have adequate air sync coverage.

*Deployment: No sync "2000 ms red, 400 ms yellow"
[[Image:2000ms_red_400ms_yellow.png|2000ms_red_400ms_yellow.png/|2000ms_red_400ms_yellow.png/]]

The IP1202/IP1203 is in deployment mode and has no air sync coverage

==Known Problems==
=== H.323/TLS Registrations ===
If you want to use H.323/TLS as Registration Protocol for the Dect-Handsets on an IP1202/IP1203, there are a few things to consider. Using the [[Reference13r1:PBX/Objects#Device Config Flags|''TLS only'']] Flag in the corresponding User Object will not work, because the CN (Common Name) of the IP1202/IP1203-Certificate doesn't match, with the Username and therefore the Registration at the PBX will fail.

If you still want to use a H.323/TLS Connection between IP1202 and PBX, you have to use other Mechanics to authenticate the DECT-Handsets. This can be done either by using the User Objects Password (not recommended) or activate the Flag [[Reference13r1:PBX/Objects#Device Config Flags|''PBX Pwd'']] at the corresponding User Object (recommended). You have to enable [[Reference11r1:DECT2/Config/Master|Registration with system password]] at the IP1202/IP1203

With this Setup, you have H.323/TLS based communication between the IP1202/IP1203 and your PBX and the user himself is authenticated via the [[Reference9:PBX/Config/Security#PBX password|PBX Password]].

=== incoming calls limited to number of radio/DSP channels ===
Each incoming call towards a radio base station (IP1202/IP1203 or IP1202/4,IP1203/4) allocates a DSP channel during the alert state.

If more DECT-handsets are subscribed to this base than DSP/radio channels are available, call setup will fail for surplus devices, and result in no audio (just noise).

Example: Call Broadcast to 5 DECT users subscribed in a IP1202/4,IP1203/4. One out of these 5 users will alert but without any DSP allocation (random). Answering such a call results in no audio for this user.

=== Blind Transfer ===
Internal ring tone after external call is blind-transferred to C, which does not save external
number in call list (per IPBS design)

=== No number resolution from local contacts ===
In case numbers of local contacts are not resolved in incoming call screen but in call list only, adjust display management settings via WinPDM:

[[image:dect_call_list.png|dect_call_list.png/|dect_call_list.png/]]

=== Firmware Compatibility ===
Newer IP1202 hardware (such with product code ''IPBS2-M3A '', ''IPBS2-M4A '' or ''IPBS2-M5A'' on the back, introduced 2Q2015) need at least firmware V11r1 SR3 or V10 SR22. Older versions are not supported!

=== Choppy voice on handsets in noisy environments ===
If DECT handsets are used in noisy environments (e.g. industry), gaps in the voice can appear, the syllables appear to be dropped from time to time.

This is caused by the echo canceller on the radio (IP1202) serving the connection for the DECT handset.

A config switch for noise optimised echo canceller mode can be used in this case:

config add MSP0 /ec-type 1

This config switch should be distributed to the base stations serving the radio connections for the DECT handsets in noisy environments only.

The ''ec-type'' parameter can be configured with values ''0-2'', 2 being currently (12r2SR14) the default value.

According a report from a customer, setting the ec-type value to 0 (i.e. disable the echo canceller) at the base-stations in the noisy environment (and only there) helped. So if setting <code>ec-type 1</code> doesn't help, you can try <code>ec-type 0</code>.

===Phone book search of users with * or # is not possible===
The phone book search is realized via SMS messages. This protocol defines and works with digits only. Therefore, this function cannot be used by users who contain a * or # in their number. In other words, users who perform the phonebook search cannot use * or # in their number.

===Remarks===
For a successful registration to the PBX, it is mandatory that an entry with the user's ''Name'' as ''Hardware Id'' value exists in the ''Devices'' section of the PBX user.



==Related Articles==
*[[Datasheet_IP1203]]
*[[Datasheet_IP64]]
*[[Datasheet_IP65]]
*[[Datasheet_d83]]
*[[Reference:IP1202e DECT base station with external antennas]]
*[[Courseware:IT_Plus_-_IP-DECT]]
*[[Courseware:IT_Plus_-_Conferencing_and_DECT]]
*[[Howto:How_to_use_the_R-key_handling]]

Template:Disclaimer - Ascom UNITE Integration

2025-05-05T14:24:16Z

Sga:

'''Disclaimer for UNITE integrations:'''

Mixed operation between Ascom base stations and innovaphone base stations is currently not supported.
According to our understanding, the UNITE integration on the innovaphone base stations is the same as that used in the Ascom base stations. Technical operation should therefore be possible without any problems.

The sales process for Ascom IMS3 and Ascom Unite software is handled by the regional Ascom contact. Support for modules ordered from Ascom is also provided by Ascom. The configuration of the Unite-module in the innovaphone base station, is also done by/in responsibility of Ascom.

Template:Disclaimer - Ascom UNITE Integration

2025-05-05T14:23:29Z

Sga:

Reference10:Concept SOAP API

2025-04-15T07:38:29Z

Sga: /* Initialize(string user, string appl, bool $v, bool $v501, bool v700, bool v800, bool vx1000, out int key) */

innovaphone®'s PBX web services, also known as SOAP API, while no longer actively extended, remains available and functional. A transition to WebSocket API, specifically the RCC API (https://sdk.innovaphone.com/13r3/doc/appwebsocket/RCC.htm), was introduced with version 13 firmware.

For ongoing development, we recommend utilizing [http://www.innovaphone.com/wsdl/pbx10_00.wsdl WSDL version 10 ''pbx10_00.wsdl''] (also available on the gateway <code>http://xx.xx.xx.xx/pbx10_00.wsdl</code>) in conjunction with this Wiki article. It's advisable to disregard the higher versions of WSDL for your development.

For upcoming developments the WebSocket API should be used, as it represents the current and future direction of our API development.

==Overview==

For an overview of the basic architecture, see the [[Reference:SOAP_API_%28pbx501.wsdl%29#Overview|corresponding chapter in the pbx501.wsdl related article]].

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

== Definition of PBX object (WSDL) ==
Within the SOAP framework there is a mechanism to formally decribe the definition of remote objects. This is done by so called WSDL (Web Service Description Language) files. This [[http://www.innovaphone.com/wsdl/pbx10_00.wsdl wsdl file]] defines the PBX web services described in this document.

NB: while you can access and retrieve the WSDL file through this URL on runtime of your application, we'd rather recommend to install a local copy with your application and use this on runtime. This way, your application will be immune against failures of www.innovaphone.com.

There is also an [[http://www.innovaphone.com/wsdl/pbx900.wsdl old version of the wsdl]] available which has less interface functions. This interface can still be accessed by legacy applications and is activated on the PBX by calling the '''Initialize''' Function with fewer arguments ('''Integer Initialize(string user, string appl, out key)'''). It should not be used for new develoments though.

=== SOAP URL ===
The SOAP service URI is '''/PBX0/user.soap''' for the standard PBX and '''/PBX-''id''/user.soap''' for a dynamic PBX (where ''id'' corresponds to the ''Id'' field in the [[Reference10:PBX/Dyn-PBXs]] configuration dialog). SOAP is accessible via plain HTTP or HTTPS, so valid URLs might be <code>http://172.16.0.1/PBX0/user.soap</code> or <code>https://172.16.0.1/PBX0-mydynpbxid/user.soap</code>.

==PBX Objects and Methods==

This section contains a language agnostic description of the PBX API’s object model. Despite of the fact that we are discussing an object model, the PBX API is in fact not an object oriented API. This is because SOAP itself is not really object oriented. In particular, there is no object creation, activation or lifetime concept. This is left up to the service designer. SOAP is more a message exchange mechanism than an object method invocation mechanism. This is reflected in the API structure.

Specifically, objects are represented through handles, which are integers. Objects are created and destroyed using dedicated methods and it’s the users responsibility to manage the lifetime of all objects.

The syntax shown here actually is no valid syntax in any existing language. Please refer to the various sample codes for working syntax.

===Session===

All PBX API methods are executed in the context of a session. A session is created using the '''initialize''' method and is identified by a handle. This handle must be provided to all subsequent method calls.

A session is owned by the PBX API user, i.e. there is no way to have access to a session of another application. Each session has a scope, which defines the view of the PBX the session user has. The scope determines the set of PBX registrations seen by the session.

Scopes are defined and configured in the PBX and are bound to particular PBX users. Thus, a session has a user attribute, which defines the scope. It includes all users which are members of groups '''user''' is active member of. If '''user''' is not an active member of any group, the scope is the user itself.

====Initialize(string user, string appl, bool $v, bool $v501, bool v700, bool v800, bool vx1000, out int key)====

To access the current web services implementation, '''v''', '''v501''', '''v700''', '''v800''' and '''vx1000''' must be present and set to '''true'''.
These parameters actually convey the wsdl version used by the client. Different versions of the interface use different parameter sets for the Initialize call. Applications should always use the wsdl version current at the time of writing the application.

The method creates a session. The session will have the user '''user'''’s scope ('''user''' is the ''Long Name'' of a PBX user). The session handle is returned and is 0 for failure and positive for a valid session handle. '''appl''' specifies the name of the calling application and is used for administrative purposes. The output parameter '''key''' is a random number associated to the session. It may be used in subsequent '''Echo''' operations.

When a session is created, '''UserInfo''' events for all PBX registrations in the scope can be received by the '''Poll''' function. Initially, one '''UserInfo''' per registration within the session’s scope is received (the list is terminated by a '''UserInfo''' with empty '''cn''' and may require multiple '''Poll''' calls to retrieve). Subsequently, '''UserInfo''' events are received when a registrations state changes.

The underlying transport session (HTTP) must authenticate itself either as '''user''' (using the users long name and PBX password) or as the admin user (using the gateway administrator account name and password) to perform an '''Initialize''' and any session related function. Note that if you use a PBX user account, the user needs to have at least ''Group/Call Forwards'' rights.

Note that the method to force the SOAP system you are using to authenticate to the PBX is entirely up to the system itself. Some systems even do not support authentication at all. If your SOAP implementation does not support digest authentication, make sure the gateway accepts basic authentication by setting the “''allow HTTP basic authentication''” in the “''General settings''”.

Note that although many HTTP connections may be used in a single session, at least one HTTP connection must remain open during the lifetime of the session. When the last connection disappears, the logical session is terminated after a short timeout. Some SOAP libraries may per default always close the HTTP connection and reconnect on subsequent SOAP calls, which will not work. The SOAP library should either be configured to keep at least one HTTP connection alive or, if this is not an option, the application should take care to always have a an active request pending (such as '''Poll''').

====Echo(integer session, integer key)====

Verifies a session. You need to supply the ''session'' identifier and ''key'' returned by a previous call to '''Initialize'''. Returns nonzero if successful.

====End(integer session)====

Terminates the session referenced by ''session''. No further events will be received.

====Integer Version(out string gkId, out string location, out string firmware, out string serial)====

Returns the version number of the WSDL file the PBX supports. The first released WSDL file had version number 500. The version described by this document has version number 501. Also delivers information about the connected PBX (in ''gkId'', ''location'', ''firmware'' and ''serial'').

====AnyInfo Poll(integer session)====

Returns pending events for the session referenced by ''session''. ''AnyInfo'' is a struct with four arrays as members: ''user'', ''call'', ''reg'' and ''info''. ''user'' is an array of type ''UserInfo'' and call is an array of type CallInfo. The other two arrays ''reg'' and ''info'' are currently not used.

After a successful '''Initialize()'' there will be a ''UserInfo'' event for each defined and visible user in the system. This allows the application to synchronize on the state of all visible users. The list will be terminated by an ''UserInfo'' event for a user with an empty ''cn'' which normally cannot happen since a user entry must have a cn.

===User===

A user represents a configured object within the PBX (a “PBX user”). The PBX API provides the '''UserInitialize''' method to obtain a handle to the user.

====UserInfo====
The user’s properties are stored in a ''UserInfo'' structure, which has the following elements:

*'''boolean active'''

true if the user exists. The only case where active can be false is when a user is moved out of the session context. This may happen if the users group assignment is changed or the user is deleted. A single UserInfo event will be posted with active set to false then.

*'''integer state'''

1 if the user is registered, 0 otherwise.

*'''integer channel'''

number of current calls.

*'''integer alert'''

number of alerting calls

*'''string type'''

the type of the users device. Currently defined are “'''ep'''” (it is an endpoint), “'''gw'''” (it is a gateway, for example a trunk line), “'''waiting'''” (a call queue) or “'''broadcast'''” (a group). Others may be defined over time.

*'''string guid'''

the users GUID. This is a globally unique identifier for the user.

*'''string cn'''

the common name of the user. This is what the PBX’s LDAP server recognizes as the CN of this user. The user’s name in the PBX configuration applet.

*'''string e164'''

the extension number the user is registered with.

*'''string h323'''

the alias the user is registered with.

*'''string dn'''

the users display name.

*'''string domain'''

the PBX domain if the Gatekeeper ID is used as domain

*'''boolean h323email'''

If true, the h323 name shall be used as primary email address when sending emails to this user.

*'''string email[]'''

email addresses of the user. If 'h323email' is not set, the first address in this list shall be used as primary email address when sending emails to this user.

*'''Group groups'''

An array of '''Group''' records (see below).

*'''Presence presence'''

An array of '''Presence''' records (see below).

*'''boolean cfg'''

If set to true indicates that the config of the user has changed

*'''string object'''

The type of the user object

*'''string loc'''

If the object described is not local to the PBX the '''UserInfo''' is sent from, the name of the location the object is homed in is given in this element. See '''LocationUrl''' to find out how to proceed further.

*'''string node'''

The node of the object.

*'''string nodenum'''

The object nodes node number (prefix).

*'''Info'''
An '''Info''' record describing various aspects of the user. The type of the information described in an individual '''Info''' record is determined by the value of its ''type'' member. Currently defined values for ''type'' are:

:*'''fake'''
: The value configured as 'Send Number'

*'''groups'''

The users group memberships are stored in a '''Group''' record which has the following elements:

:*'''string group'''

: the name of the group the user is a member of

:*'''bool active'''

: true if the user is an active member of the group

*'''presence'''

The users presence status is stored in a '''Presence''' record which has the following elements:

:*'''string status'''

: either '''open''' or '''closed'''

:*'''string activity'''

: The users current activity (optional)

:*'''string note'''

: The user provided additional note (optional)

====integer UserInitialize(integer session, string user, bool xfer, bool disc, string hw)====

Returns a handle to the named ''user'' (0 on failure). String <code>user</code> must be a Long Name(cn). Phone number(e164) is not supported. Use FindUser instead, to retrieve cn to specified e164 number.

Once a user handle is obtained with '''UserInitialize''', '''CallInfo''' events will be posted and retrieved via '''Poll''' for all calls related to the user. If '''xfer''' is set to '''true''', '''CallInfo''' events will also be posted for calls which are transferred away from '''user'''. Otherwise, such events will be posted only for the user handle which the call has been transferred to. Thus, without setting follow to true, an application will generally not be able to track calls after a transfer unless it has called '''UserInitialize''' for any PBX object a call may be transferred to and matches the new call on the transferred-to user via the '''conf''' information in the '''Info''' record of the new call (which will be identical to the '''conf''' information for the transferred call).

When '''xfer''' is set to '''true''', transferred calls will show up in the '''CallInfo''' records with a '''No''' element of type '''xfer''' that indicates the number the call has been transferred to.

When '''disc''' is set to '''true''', calls to phones of the monitored user are cleared only after the user hangs up the phone. This way it can be avoided that the SOAP application assumes the phone is free but is still off-hook. This only works with innovaphone H.323 endpoints since the Disconnect message used to do this is not defined in the SIP standard.

When a '''hw''' argument is provided only the device identified by this is monitored. Please note that a valid handle will be returned even if there is no matching device for '''user'''.

Also, the user handle can be used to create and control calls on behalf of the user.

====void UserEnd(integer user)====

Frees the handle ''user'' obtained with '''UserInitialize'''. No events will be posted for this user anymore.

====int SetPresence(inno:Presence presence, bool im, string contact, string guid, string h323)====

Sets the presence of a PBX user.

* '''presence''':
:* '''inno:PresenceStatus''': the status '''closed'''/'''open''' or empty
:* '''inno:PresenceActivity''': the activity like '''busy'''
:* string '''note''': the presence note
* '''im''': from im client?
* '''contact''': the presence contact like '''tel:''', '''calendar:'''...
* '''guid''': the user guid
* '''h323''': the h323 name of the user

You can use '''guid''' or '''h323''' to identify the user! If no guid is known, use '''*''' as guid value.
 
If the setting of the presence was ok, the method returns '''1'''. Otherwise '''0'''.

===Device===

For each User object multiple devices can be configured within the PBX. A device represents the physical endpoint used for calls (e.g. phones). Any registration to the PBX is associated to a configured device by the name/number used for the registration. Even thou it is possible that one configured device in the PBX accepts multiple registrations, it is recommened to configure the PBX in a way that there is one registration to a device. This way an application can control which physical endpoint is used for a call.

====Device[] Devices(int session, string user)====

This function returns an array of devices configured for a user identified by its cn (long name). The '''cfg''' flag in '''UserInfo''' is set when this information is changed. The structure 'Device' contains the following members:

{|
|valign=top nowrap=true|'''hw'''
|The Hardware Id used to identify the device. This string is used to associate any calls to devices.
|-
|valign=top nowrap=true|'''text'''
|A text configured as a description of the device. It can be used to be presented to the user for the user to select a device.
|}

===Call===
A call represents one leg of an existing call in the PBX.

====CallInfo====
The calls attributes are stored in a '''CallInfo''' structure, which has the following elements:

*'''int user'''

the user handle the call belongs to

*'''int call'''
the call handle

*'''int reg'''

currently unused

*'''bool active'''

'''true''' if the call exists, '''false''' if not. The only case where ''active'' can be '''false''' is when a call is terminated. A single '''CallInfo''' event will be posted with ''active'' set to '''false''' then

*'''integer state'''

A calls state. A bit field made up as follows:
{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+
| Value
| Mask
| Meaning
|-
| 1
| 0xF
| setup
|-
| 2 || 0xF || setup-ack
|-
| 3 || 0xF || call-proc
|-
| 4 || 0xF || Alert
|-
| 5 || 0xF || Connect
|-
| 6 || 0xF || disconnect sent
|-
| 7 || 0xF || disconnect received
|-
| 8 || 0xF || parked
|-
| 0 || 0x80 || inbound call
|-
| 128 || 0x80 || outbound call
|-
| 0 || 0x100 || active call
|-
| 256 || 0x100 || call on hold
|-
| 0 || 0x200 || active call
|-
| 512 || 0x200 || active call put on hold by peer
|}

Note that the PBX API is PBX-centric, not terminal centric. As such, it considers a call ''from'' the PBX ''to'' the terminal as ''outbound''.

Refer to the [[Howto:SOAP API PHP5 Sample Code#Working with Call States from CallInfo]] Article to learn how to work with the call state values.

*'''string msg'''
A textual representation of the signalling message causing this event. E.g. “'''x-setup'''”.

*'''No No'''

An array of '''No''' records (see below). This can include information about various peers related to the call itself. The type of the peer described in an individual '''No''' record is determined by the value of its '''type''' member. Currently defined values for '''type''' are:

:*'''peer'''

: The current remote end of the call (the local end is determined by the UserInfo identified through the user handle above)

:*'''leg2'''

: The last diverting user (if any)

:*'''leg2orig'''

: The 1st diverting user (if any, from on v9hf1)

:* '''leg1'''

: Indicates a call-forward/blind-xfer(?) to the calling end

:*'''ct'''

: The last user having transferred the call (if any)

:*'''parked-to'''

: The call was parked to the indicated endpoint. This is sent with the 'r-rel' message indicating the clearing of this call.

:*'''picking'''

: The call was picked by the indicated endpoint. Usually empty because sent with the new call which is created at the picking endpoint, but the fact that it is present indicates that this is a picked up call. The endpoint where this call is picked from is indicated with a ''ct'' No within the same call_info.
*'''Info info'''

An '''Info''' record describing various aspects of the call. The type of the information described in an individual '''Info''' record is determined by the value of its ''type'' member. Currently defined values for ''type'' are:

:*'''conf'''

: A string holding the ''conference id'' (a GUID) of the call the reported call leg (all legs of a certain call share the same ''conference id''). Also, CDRs for a call show this ''conference id'' (''ref'' for [[Reference:Call_Detail_Record_CDR|gateway CDRs]], ''conf'' in the ''<event>'' tag for [[Reference10:Concept_Call_Detail_Record_CDR_PBX|PBX CDRs]]).
:*'''cause'''

: The latest [[Reference:ISDN_Cause_Codes | cause code ]] which has been notified on the call

===== CallInfo for Boolean Objects =====
A ''Boolean'' will send a CallInfo event when it's status changes. From the indicated number, you can derive the status as follows:

00 - Auto-Off
01 - Auto-On
10 - Manual-Off
11 - Manual-On

====No Record====

Peer information is stored in a '''No''' record with the following elements:

*'''string type'''

the type of the peer described by the record

*'''string cn'''

the peer’s PBX’s objects common name (if any)

*'''string e164'''

the peer’s phone number

*'''string h323'''

the peer’s h323 alias

*'''string dn'''

the peer’s display name

====Info record====
Various information is stored in '''Info''' records with the following elements:

*'''string type'''

: the type of the information described by the record. The following values for ''type'' are used (although more may appear at any time):
:; conf : the call conference guid
:; cause : a cause code related to the call, see [[Reference:ISDN Cause Codes]]
:; uui : a user-user-info sent or received on the call. The UUI is conveyed in the ''vals'' member (see below). Note that from 13r3 upwards, the UUI conveyed is url-encoded.

*'''string vals'''

a string value associated with this information (if any, the ''type'' of the element determines if an '''Info''' element has a string or an integer value)

*'''integer vali'''

an integer value associated with this information (if any)

Note that the call related functions do not return a meaningful value. This is because the operations success is reflected in the subsequent CallInfo events.

====integer UserCall(integer user, string cn, string e164, string h323, int reg, InfoArray info, int rc, string srce164)====

Creates an outgoing call from the '''user''' (which is a handle obtained by a call to '''UserInitialize''') to the destination described by ''cn'', ''e164'' and ''h323''. The argument '''srce164''' may be used to override the calling party number (note that this overrides the callers extension, not the full calling party number). Arguments ''reg'' and ''info'' are currently ignored. The argument ''rc'' is usually 0, unless special behavior is required by using other [[Reference8:SOAP_API#Remote_Control_Facilities|Remote Control Facilities]]. Returns a handle to the call (0 on failure).

The called number (''e164'') is interpreted in the context of the user object the call is placed for (''user'').

From V8HF3 on, if the srce164 argument of UserCall starts with 'r' or 'R', the call is sent with CLIR (calling line identification restricted).

Depending on the nature of the device the user is registered with, the device may actually place the call or the PBX may place a call and once it is accepted, it places another call to the destination.

====UserConnect(integer call)====
Connects an existing ''call''. This forces the device the user is registered with to accept the call. It may then go into hands-free mode. Incapable (i.e. non-innovaphone) devices may simply ignore this call.

====UserTransfer (int acall, integer bcall)====
''acall'' and ''bcall'' are both calls a single user currently has active. This method will connect ''acall'' with ''bcall'', leaving the user without both calls.

====UserMediaTransfer (integer acall, integer bcall, boolean user, boolean peer)====

This function establishes a media connection between two parties currently active in a call independent of the signalling connection. ''acall'' and ''bcall'' are both active (connected) calls. If ''user'' is true, the user sides of the calls are connected together, if ''peer'' is set to true the peer sides of the calls are connected together. If neither ''user'' nor ''peer'' is set the calls are connected to their respective signalling peers.

====bool UserRedirect(integer call, string cn, string e164, string h323, InfoArray info, int rc)====
Places a call to the destination described by ''cn'', ''e164'' and ''h323'' and connects ''call'' to this destination. Argument ''info'' is currently ignored. ''rc'' can carry one of the remote control facilities listed in [[Reference:Remote Control Facility]] (see also [[{{NAMESPACE}}:Concept_SOAP_API#UserRc(integer_call,_integer_rc)|UserRc]] below).

Any call forwarding configured for the destination will be ignored. See [[Reference8:SOAP_API#bool_UserReroute.28integer_call.2C_string_cn.2C_string_e164.2C_string_h323.29|UserReroute()]] below.

Note: in 2009, the semantics of UserRedirect has accidentally been changed so that call forwarding will no longer be ignored. From 14r1 Service Release 4, the original behavior can be restored by specifying 999 as ''rc''.

====bool UserReroute(integer call, string cn, string e164, string h323)====
Performs a rerouting of the call. Call forwardings set for the destination will be obeyed.

Note: rerouting calls on a waiting queue or call broadcast object works only if the ''Execute Operator CFB/CFNR'' or ''Execute Group Member Diversions'' option is turned on.

====integer UserPickup(int user, string cn, integer call, string group, int reg, InfoArray info)====
Redirects a call such that it appears as a new call at ''user''. The call to be redirected can be specified by its ''call'' handle. Alternatively, calls can be picked up by a users ''cn'' or by a ''group'' name. If all parameters are null, an implicit pickup is done. The new call handle is returned. Arguments ''reg'' and ''info'' are currently ignored.

====UserClear(integer call, integer cause, InfoArray info)====
Disconnects the ''call'' providing ''cause'' as disconnect reason. For example the cause code ''26 non-selected user clearing'' could be used to disconnect the call immediately on local phone, so no disconnect tone is played.

Cause is coded as a 7bit integer according to the table found in [[Reference:ISDN Cause Codes]].
Argument ''info'' is currently ignored.

====UserCtComplete(integer call, string e164, string h323)====

Sends a notification to the device ''call'' is active on that the remote peer has changed to ''e164'' and ''h323''. This resembles the notification a device may receive if its remote peer transfers the call to the new destination. The device may update its display and/or call data accordingly. This call is often used to force the devices (i.e. telephones) display to show application specific data.

====UserHold(integer call, bool remote)====
Sets the call on hold. The device may or may not display the hold status. In any case, the media channel is disconnected until a UserRetrieve is called.

In ''V8 hotfix23'' an additional parameter '''remote''' was added. If set to '''true''', '''remote''' will force to play MOH only to remote user (who is being held), set to '''false''' maintains the default behaviour (MOH played on remote user and a dialing tone to local user (depending on the pbx firmware, versions prior to v11r2 will play music on hold)). To use this parameter the recent WSDL 8.00 file must be retrieved.

====UserRetrieve(integer call)====
Retrieves the ''call'' on hold. The device may or may not display the new status. In any case, the media channel is reconnected.

====integer UserPark(integer call, string cn, integer position)====
Parks the call at the PBX object '''cn''' and local user on postion '''position'''. A position of -1 means any position is allowed. The return value is the handle of the new call.

To unpark calls, use the returned call handle with the '''UserPickup()''' function.

The '''cn''' argument can be used to identify another object, where the call shall be parked to.

====UserDTMF(integer call, bool recv, string dtmf)====
Sends DTMF digits on behalf of the user. If '''recv''' is set to ''true'' the DTMF is sent to the local user.

====UserUUI(integer call, bool recv, string uui)====
Sends User-User_information on behalf of the user. If '''recv''' is set to ''true'' the uui is sent to the local user.

====UserInfo(integer call, bool recv, string cdpn, string key, string dsp)====
Sends INFO message on behalf of the user. If '''recv''' is set to ''true'' the INFO message is sent to the local user. This function can be used to send overlap dialing information.

====UserRc(integer call, integer rc)====
Sends remote control facility to an innovaphone IP phone. It will be ignored by 3rd-party endpoints.

A remote control facility can be sent to an innovaphone IP phone to activate additional call handling on the device.

The current set of remote control facility function codes actually depends on the firmware used on the telephone, not the WSDL version used for SOAP. The current set is documented in [[Reference:Remote Control Facility]].

This function can be used for example to establish a three-party conference on an innovaphone IP phone. For this use the function UserRc on an active call using the '''rc''' value 4, while a second call is on hold. See also the ''rc'' argument to [[#integer_UserCall.28integer_user.2C_string_cn.2C_string_e164.2C_string_h323.2C_int_reg.2C_InfoArray_info.2C_int_rc.2C_string_srce164.29|UserCall()]].

===Messaging===

====integer UserMessage(integer user, string e164, string h323, string msg, string src_e164, string src_h323 )====
Sends an message from the '''user''' (which is a handle obtained by a call to '''UserInitialize''') to the destination described by ''e164'' and ''h323''. The parameters ''src_e164'' and ''src_h323'' may be used to override the calling party's information, in order to present a different callback information to the recipient of the message. Returns a handle to the call (0 on failure), which can be used to track the delivery of the message. A event of type 'msg-sent' indicates the delivery of the message.

===Status Retrieval===

Instead of monitoring calls using the ''Poll'' mechanics, there are some functions to retrieve the current at a certain point in time.

====CallInfo[] Calls(integer session, string user)====
Returns an array of '''CallInfo''' records for the calls currently active at the registration defined by ''user''. Please note that this function may be called without having called '''UserInitialize ()''' before. Thus, the call handle information in the '''CallInfo''' records returned is meaningless.

====UserInfo[] FindUser(string v501, string v700, string v800, string vx1000, string cn, string h323, string e164, integer count, integer next, boolean nohide)====
Returns an array of at most ''count'' '''UserInfo''' records for the users matching ''cn'', ''h323'' or ''e164''. Only one of ''cn'', ''h323'' and ''e164'' may be specified, except that ''e164'' and ''cn'' may be specified. In this case the number in ''e164'' is interpreted in the Node of the user specified with ''cn''. The search string will be used as a starting point into the alphabetically sorted list of objects, that is, a search for “'''A'''” will yield entries starting with “'''A'''” but also – depending on ''count'' – the following entries. Neither search string may be empty. ''v501'', ''v700'', ''v800'' and ''vx1000'' must be set to a non-empty value. In case ''cn'' is set to the empty value, '''FindUser''' returns results starting from the first object in the PBX.

To call '''FindUser''', no session is required, however, you need a valid HTTP authentication.

Be aware that large values for ''count'' may fail and even crash the PBX. If you need to retrieve the whole user list, you should be using 20 as ''count'', provide the last ''cn'' retrieved as new start cn and loop until '''FindUser''' returns no more results, passing '''true''' as value for ''next'' for all but the first calls.

If the parameter ''nohide'' is true, all objects regardless if marked as ''Hide from LDAP'' or not are returned by the '''FindUser''' function.

====bool UserFindDestination(integer user, string e164, string h323, out UserInfo user)====
This function checks if a destination can be reached from a given user by either a given number or a given name. ''user'' is the user handle from which PBX user the searching is started through all PBX nodes up and down. ''e164'' is the number, ''h323'' is a name.

The function returns '''true''', if the number or name is incomplete, otherwise '''false'''. If a destination is found, a '''UserInfo''' ''user'' is delivered.

No session is required to call '''UserFindDestination''', however, you need a valid HTTP authentication.

====string License(integer session, string name)====
This function is for internal use only.

====string LocationUrl(string v501, string v700, string v800, string vx1000, string location, bool tls)====
Returns a string with the HTTP URL for the PBX named location to which a SOAP session can be created. Typically, ''location'' is retrieved from the ''vals'' element of an '''Info''' record with ''type'' '''loc''' in an '''UserInfo''' record.

''location'' needs to be specified as the '''h323''' attributes value of the PBX node '''UserInfo''' data you are interested in.

If ''tls'' is set to '''true''', a HTTPS URL is returned.

====string UserLocalNum(int user, string num)====
Converts a given number '''num''' into a number diallable from the location of a specific '''user'''. Useful in inter-node scenarios where a destination node number and -extension are known, but the required escape prefix digits are unknown.
;user:The id of the specified user
;num:The number to be localized into the spefified user's location
;result:The localized number, including escape prefixes

===Administration===
The SOAP interface can be used for administrational purposes also. This is done via the Admin call. All kinds of PBX objects can be created, read or modified.

====string Admin(string xml)====

Sends the administrational command ''xml'' to the PBX. The command is executed and any result is returned.

This command allows you to query and modify the PBX object configuration (e.g. to query and set a users call forwarding). The scope and format of the commands valid for ''xml'' is beyond the scope of this document, however, there is a [[Howto:Using the SOAP Admin Function | separate article on that ]].

To call '''Admin''', no session is required. However, you must be authenticated as an admin user on the underlying HTTP layer.

[[Howto:Using the SOAP Admin Function]]

==Typical design of a PBX SOAP Application==
Please refer to the [[Reference:SOAP_API_%28pbx501.wsdl%29#Typical_design_of_a_PBX_SOAP_Application|pbx501.wsdl]] article for a discussion of the typical design of a SOAP application.

==References==
* [http://www.innovaphone.com/wsdl/pbx10_00.wsdl Version10-wsdl].

Applications based on this wsdl will work with V10 PBX firmware (and up) only.

Applications written to the previous pbx501.wsdl, pbx700.wsdl and pbx900.wsdl will continue to work with V10 firmware.

For your reference the old version files are still available:
* [http://www.innovaphone.com/wsdl/pbx501.wsdl Version5-wsdl]
* [http://www.innovaphone.com/wsdl/pbx700.wsdl Version7-wsdl]
* [http://www.innovaphone.com/wsdl/pbx900.wsdl Version9-wsdl]

==Known Problems==
Please read [[Howto:Authentication in the SOAP interface]] in case you have problems to authenticate SOAP access.

==System Requirements==
The PBX SOAP API requires a working PBX.

To work with the PBX API in this version, you must run at least version 7.00 software on your PBX. Also, you must run at least version 5 software on the phones.

==Installation==
There is no specific installation required, as the PBX API is integral part of the PBX (although licenses are required to operate the PBX).

==Configuration==
To prepare an PBX for PBX API testing
*setup a separate PBX
*install current firmware (at least 8.00)
*configure the PBX as usually
*add an user object called '''API''' , define a ''password'' for this object
*create a new group (e.g. called '''all users'''), by adding a group tag to '''API''', make it ''active''
*add a similar group tag to all other test users
*call '''Initialize()''' and use '''API''' as user and '''API''' and its ''password'' as http credentials

==Known Issues==
We have reports that the PBX wsdl is incompatible to some of the contemporary SOAP platforms available in the market. Most notably, Silverlight and Java seem to be affected. These problems are fixed in the v11 implementation of the PBX SOAP interface ''pbx11_00.wsdl'' (available at [http://www.innovaphone.com/wsdl/pbx11_00.wsdl www.innovaphone.com/wsdl/pbx11_00.wsdl ]).

Note: This wdsl file is not available directly from the PBX (e.g. at <code>http://xx.xx.xx.xx/pbx11_00.wsdl</code>)

However, we have had indications that for Java, solutions are possible based on Apache Axis 1.4, Netbeans 6.8 or JAX-RPC.

The PBX does not expect the SOAP client to disconnect the session right after a UserCall. If this is the case (e.g. in a script which merely creates a call on behalf of a user and then terminates), it might happen that the outgoing call from the device will not be created correctly (a matter of timing). In this case, just wait for one second.

==Related Articles==
:[[Howto:Authentication in the SOAP interface]]
:[[Howto:Clear a call completely with SOAP using UserClear]]
:[[Howto:PBX SOAP Api C sample code]]
:[[Howto:SOAP Api VisualBasic.Net Sample Code]]
:[[Support:TAPI or other SOAP Application fails to function properly if PBX users have special characters in their long or short user name]]
:[[Howto:How to monitor configuration changes in the SOAP interface ]]
:[[Howto:SOAP with PHP5 ]]
:[[Howto:SOAP API Java Sample Code ]]
:[[Howto:Using the SOAP Admin Function]]

[http://wiki.innovaphone.com/index.php?search=soap Search for more articles about SOAP]

Reference14r1:Apps/PbxManager/App Connector for Let's Encrypt

2025-04-09T11:31:23Z

Sga:

== Settings ==

;Let's Encrypt Directory URL: a URL to an ACMEv2 compliant certification service directory
;Email address: an email address which is used by Let's Encrypt itself for certificate expiration warning emails
;Client password: innovaphone Let's Encrypt clients must have this password configured to be able to create a certificate with this App. (Access the PBX Manager via https or the native myapps-client to see the ''Copy to Clipboard'' option.)
;Certificate installation before expiry (days): 30 days before the certificate expires, a new certificate from Let's Encrypt is requested and kept on standby. By default, this new certificate is installed 3 days before the old certificate expires. However, in some cases, it may be advisable to install the new certificate earlier.
;Client URL: not configurable, but you can copy this for your innovaphone Let's Encrypt clients
;URL for Let's Encrypt root certificates: not configurable, but you can copy this for your Devices certificates configuration. This URL provides root certificates which are used inside the Let's Encrypt certificates (without authentication, as these certificates can be downloaded directly from Let's Encrypt anway).

==Related Articles==
* [[Reference14r1:Concept_Let%27s_Encrypt]]
* [[Reference14r1:Concept_App_Service_Connector_for_Let%27s_Encrypt]]
* [[Reference14r1:Services/Letsencrypt]]

Reference15r1:Apps/PbxManager/App Connector for Let's Encrypt

2025-04-09T11:30:32Z

Sga: /* Settings */

== Settings ==

;Let's Encrypt Directory URL: a URL to an ACMEv2 compliant certification service directory
;Client password: innovaphone Let's Encrypt clients must have this password configured to be able to create a certificate with this App. (Access the PBX Manager via https or the native myapps-client to see the ''Copy to Clipboard'' option.)
;Certificate installation before expiry (days): 30 days before the certificate expires, a new certificate from Let's Encrypt is requested and kept on standby. By default, this new certificate is installed 3 days before the old certificate expires. However, in some cases, it may be advisable to install the new certificate earlier.
;Client URL: not configurable, but you can copy this for your innovaphone Let's Encrypt clients
;URL for Let's Encrypt root certificates: not configurable, but you can copy this for your Devices certificates configuration. This URL provides root certificates which are used inside the Let's Encrypt certificates (without authentication, as these certificates can be downloaded directly from Let's Encrypt anway).

==Related Articles==
* [[{{NAMESPACE}}:Concept_Let%27s_Encrypt]]
* [[{{NAMESPACE}}:Concept_App_Service_Connector_for_Let%27s_Encrypt]]
* [[{{NAMESPACE}}:Services/Letsencrypt]]

Howto:Supported innovaphone versions

2025-04-08T13:54:05Z

Sga: /* Special exceptions with Firmware 12r2, 13r3 and 14r1 */

As of today (March 2025) we support firmware versions 15r1, 14r2 and 13r3.

This article explains the rule behind this.

==Applies To==
This information applies to all innovaphone products and firmware

== What it means ==
The firmware described here is being supported by us generally (that is, support tickets may be opened, and we provide new service releases). However, on specific devices, firmware support may end earlier due to technical restrictions. See [[Howto:Firmware Upgrade]] for details.

== Basic explanation of the supported versions ==

=== Structure of version numbers ===
Version numbers are composed as followed: (Major Version)r(Minor Version)sr(Service Release) 
This means for example for <code>13r2sr10</code>:
* Major Version: 13
* Minor Version: r2
* Service Release: sr10

=== General rule for supported versions ===

We support the <code>2 latest minor versions in the latest major version</code> '''and''' the <code>latest minor version in the 3 latest major versions</code>

;Examples
:If the latest version is 14r1, we support 14r1 as the <code>2 latest minor versions in the latest major version</code> and 14r1, 13r3, 12r2 as the <code>latest minor version in the 3 latest major versions</code>.
:If the latest version is 14r2, we support 14r2 and 14r1 as the <code>2 latest minor versions in the latest major version</code> and 14r2, 13r3, 12r2 as the <code>latest minor version in the 3 latest major versions</code>.
:If the latest version is 15r1, we support 15r1 as the <code>2 latest minor versions in the latest major version</code> and 15r1, 14r2, 13r3 as the <code>latest minor version in the 3 latest major versions</code>.

==== Special exceptions ====
As is often the case, there are of course exceptions to every rule. In this case, the exceptions to the above rules are as follows.

* V6 firmware on an IP21 in order to take advantage of the AUX or door interface will continue to be supported. (Support will end at latest once a replacement product featuring a door and AUX interface is released.)
* TAPI V8.00, latest release
* Queue Monitor (iQM) V8.00, latest release
* log2pcap V6.00, latest release
* Wireshark DLLs V6.00, latest release

===Problems with old versions===
If you have issues which can not be fixed by changing the configuration, you need to upgrade to a more recent version.

== Related Articles ==
* [[Howto:Firmware Upgrade]]
* [[Support:End of Life for Linux Application Platform V9.00]]

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

Reference15r1:Concept App Service myApps Assistant

2025-03-26T12:18:34Z

Sga: /* Assistant App */

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

* innovaphone from version 15r1

== Overview ==

The myApps Assistant App offers an interface for other apps to access a remote large language model (LLM). This might be a locally hosted open-source model like '''mixtral''' or '''deepseek-r1''' or a model hosted by providers such as openAI (e.g., gpt-3.5-turbo, gpt-4o...) or mistral '''('''https://mistral.ai/''')'''. Other apps can integrate the assistant service via the [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm local assistant JavaScript API] in the client and thus offer the response of the LLM.

The service functions as an intermediary and contains a corresponding backend. Therefore, it is required to self-host an LLM Service or possess an account with an external service provider. In the event of the latter, you can configure your API key in the '''Settings App''' (former PBX Manager Plugin) for this app service, if needed.

Currently, only the openAI API Chat Completions API v1 is implemented (which is also supported by several open source projects e.g. https://ollama.com/), but more API implementations are likely to follow.

== Licensing ==
An appropriate license ''App(innovaphone-assistant)'' must be installed on the PBX to enable the App for specified users.

The License can be assigned directly to a specific User Object or via a Config Template.

== 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 '''"myApps Assistant"''' and click on it
* Select the proper firmware version, for example '''"Version 15r1"''' 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 assistant"''' and click on '''" + Add an App"''' and then on the '''"Assistant 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: Assistant API, SIP: assistant-api''
* Fill in the fields for '''"Remote Service URL"''', '''"LLM Model"''' and if necessary '''"API Key"''' (for more information about these fields see below)
* 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
If you have the license for the Assistant App you should repeat the above mentioned last five steps for that app ('''Assistant''') too.

== Assistant App ==
[[File:Reference15r1ConceptAppServiceMyAppsAssistant-AssistantUI-2.png|thumb|600x600px|/Reference15r1ConceptAppServiceMyAppsAssistant-AssistantUI.png]]
Since version 15r1, the application also offers a user interface, where conversations can be held with the connected large language model. These conversations are stored in a database managed by the service.

There are a few parameters one can manage from within the hamburger menu. These are:

* '''Send on Enter''' - You might choose that option if you want a message to be send to the LLM on pressing ENTER. Alternatively it would be CTRL+ENTER
* '''Don't use an interface to other apps (no system prompt)''' - To allow the application access to myApps resources (such as the contacts and connect databases, call list, or the softphone app), a specially designed system prompt is sent to the model at the beginning of each conversation. If you do not require this feature and wish to reduce costs or processing time, you can disable the system prompt by checking the appropriate box.
* '''Offline mode (Conversations are stored on your device)''' - Normally, all your conversations are stored in the central service's database, which enables you to retrieve them from any device you are logged into. However, if your internet connection is interrupted, you will not be able to access them until the connection is restored. To address this issue, you may choose to store your conversation data on your device, allowing you to access it even without an internet connection. However, you should not enable this feature when using a hardware device that is not your own. If you do, make sure to disable it afterwards to delete any locally stored data. Note that deleting locally stored conversations is not synchronized across all devices if they are all in Offline Mode!

====== Currently implemented myApps features ======
The Assistant App integrates into the myApps platform and offers services from other apps via the [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant.plugin/com.innovaphone.assistant.plugin.htm local assistant.plugin JavaScript API]. This will be extended and improved in future releases. You may try the following prompts:

* Ask for the number of a contact stored in the contacts database "Can you please find the number of Sarah Sample!"
* Get information from Connect and Projects* "Please look up #AI in the '''internal''' '''database'''! Then tell me how we are planning to use it"
* Get your call list "What are my recent calls?"
* Calling someone "Can you please call Sarah Sample!"
* Get the current time and date "What time and data is it right now?"
* Start a new conversation "Please start a new conversation!"

For the above mentioned prompts the following APIs should be available to the user:

* com.innovaphone.assistant.plugin
* com.innovaphone.search
* com.innovaphone.calllist

For now only keyword search is possible. In order to make the LLM understand that you want to search in Connect and Projects Databases you need to mention that you want to use the '''internal databases!''' Better use two sentences to make the LLM understand better. The search results are the same as those you would get from the '''myApps Search App'''. Only the first 40 matches of the keywords are considered and from these only the first 10k characters.
 The prompts mentioned above may or may not work depending on the connected large language model. We cannot guarantee that the results will always be satisfactory, but as the application always sends the entire conversation to the model, it is recommended to start a new conversation if different topics are not directly related to each other.

The prompts were successfully tested on the following models:

* mixtral-q6-8192
* mixtral
* deepseek-r1:14b
* deepseek-r1:32b
* deepseek-r1:70b
* gpt-3.5-turbo
* gpt-4o

There are certainly many more. But currently only models with parameter sizes of more than 14 billion (14b) correctly understood the system prompt. Larger models perform better, but are slower and more expensive.
[[File:Reference15r1 Concept App Service Assistant App-Config-2.png|thumb|/Reference15r1_Concept_App_Service_Assistant_App-Config.png|/Reference15r1_Concept_App_Service_Assistant_App-Config-2.png]]

== myApps Assistant - App Service ==
The App Service performs tasks in the following areas:
* Question relay to an LLM
* Language recognition
* Caching
* Translations using the LLM (not yet fully tested)

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

In order to make the app connect to your LLM model provider you need to configure a few fields.

* '''Remote Service URL''' - The URL where the remote service interacting with the LLM is hosted. If you are using a model hosted by openAI this would probably be: https://api.openai.com/v1/chat/completions
* '''LLM (model)''' - The actual model you intend to use. There are a couple of open source models you could use (mixtral, deepseek-r1:14b...). If you intend to use openAI models this could be something like gpt-3.5-turbo or gpt-4o
* '''API -Key''' - If you are not using a self-hosted model you might need an API-Key in order to make successful HTTP Requests to your provider. This key will be delivered by your LLM provider (e.g. openAI https://platform.openai.com/signup )

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

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

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend, which is the LLM (there is only one) you configured in the '''Settings App''' (former PBX Manager Plugin). After successful translation, the translated version is kept in the cache for future requests. Currently no myApps applications are using the API [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm local assistant JavaScript API] for translations. But developers may use it if a LLM is configured and no extra service provider should be used.

== Troubleshooting ==

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

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm SDK Documentation - Assistant API]
* [[Howto:Setup a LLM Server]]

Reference15r1:Concept App Service myApps Assistant

2025-03-26T12:13:43Z

Sga: /* Licensing */

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

* innovaphone from version 15r1

== Overview ==

The myApps Assistant App offers an interface for other apps to access a remote large language model (LLM). This might be a locally hosted open-source model like '''mixtral''' or '''deepseek-r1''' or a model hosted by providers such as openAI (e.g., gpt-3.5-turbo, gpt-4o...) or mistral '''('''https://mistral.ai/''')'''. Other apps can integrate the assistant service via the [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm local assistant JavaScript API] in the client and thus offer the response of the LLM.

The service functions as an intermediary and contains a corresponding backend. Therefore, it is required to self-host an LLM Service or possess an account with an external service provider. In the event of the latter, you can configure your API key in the '''Settings App''' (former PBX Manager Plugin) for this app service, if needed.

Currently, only the openAI API Chat Completions API v1 is implemented (which is also supported by several open source projects e.g. https://ollama.com/), but more API implementations are likely to follow.

== Licensing ==
An appropriate license ''App(innovaphone-assistant)'' must be installed on the PBX to enable the App for specified users.

The License can be assigned directly to a specific User Object or via a Config Template.

== 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 '''"myApps Assistant"''' and click on it
* Select the proper firmware version, for example '''"Version 15r1"''' 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 assistant"''' and click on '''" + Add an App"''' and then on the '''"Assistant 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: Assistant API, SIP: assistant-api''
* Fill in the fields for '''"Remote Service URL"''', '''"LLM Model"''' and if necessary '''"API Key"''' (for more information about these fields see below)
* 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
If you have the license for the Assistant App you should repeat the above mentioned last five steps for that app ('''Assistant''') too.

== Assistant App ==
[[File:Reference15r1ConceptAppServiceMyAppsAssistant-AssistantUI-2.png|thumb|600x600px|/Reference15r1ConceptAppServiceMyAppsAssistant-AssistantUI.png]]
Since version 15r1, the application also offers a user interface, where conversations can be held with the connected large language model. These conversations are stored in a database managed by the service.

There are a few parameters one can manage from within the hamburger menu. These are:

* '''Send on Enter''' - You might choose that option if you want a message to be send to the LLM on pressing ENTER. Alternatively it would be CTRL+ENTER
* '''Don't use an interface to other apps (no system prompt)''' - To allow the application access to myApps resources (such as the contacts and connect databases, call list, or the softphone app), a specially designed system prompt is sent to the model at the beginning of each conversation. If you do not require this feature and wish to reduce costs or processing time, you can disable the system prompt by checking the appropriate box.
* '''Offline mode (Conversations are stored on your device)''' - Normally, all your conversations are stored in the central service's database, which enables you to retrieve them from any device you are logged into. However, if your internet connection is interrupted, you will not be able to access them until the connection is restored. To address this issue, you may choose to store your conversation data on your device, allowing you to access it even without an internet connection. However, you should not enable this feature when using a hardware device that is not your own. If you do, make sure to disable it afterwards to delete any locally stored data. Note that deleting locally stored conversations is not synchronized across all devices if they are all in Offline Mode!

====== Currently implemented myApps features ======
The Assistant App integrates into the myApps platform and offers services from other apps via the [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant.plugin/com.innovaphone.assistant.plugin.htm local assistant.plugin JavaScript API]. This will be extended and improved in future releases. You may try the following prompts:

* Ask for the number of a contact stored in the contacts database "Can you please find the number of Sarah Sample!"
* Get information from Connect and Projects* "Please look up #AI in the '''internal''' '''database'''! Then tell me how we are planning to use it"
* Get your call list "What are my recent calls?"
* Calling someone "Can you please call Sarah Sample!"
* Get the current time and date "What time and data is it right now?"
* Start a new conversation "Please start a new conversation!"

For the above mentioned prompts the following APIs should be available to the user:

* com.innovaphone.assistant.plugin
* com.innovaphone.search
* com.innovaphone.calllist

For now only keyword search is possible. In order to make the LLM understand that you want to search in Connect and Projects Databases you need to mention that you want to use the '''internal databases!''' Better use two sentences to make the LLM understand better. The search results are the same as those you would get from the '''myApps Search App'''. Only the first 40 matches of the keywords are considered and from these only the first 10k characters. In future versions we will implement a semantic search in order to improve the search performance.
 The prompts mentioned above may or may not work depending on the connected large language model. We cannot guarantee that the results will always be satisfactory, but as the application always sends the entire conversation to the model, it is recommended to start a new conversation if different topics are not directly related to each other.

The prompts were successfully tested on the following models:

* mixtral-q6-8192
* mixtral
* deepseek-r1:14b
* deepseek-r1:32b
* deepseek-r1:70b
* gpt-3.5-turbo
* gpt-4o

There are certainly many more. But currently only models with parameter sizes of more than 14 billion (14b) correctly understood the system prompt. Larger models perform better, but are slower and more expensive.
[[File:Reference15r1 Concept App Service Assistant App-Config-2.png|thumb|/Reference15r1_Concept_App_Service_Assistant_App-Config.png|/Reference15r1_Concept_App_Service_Assistant_App-Config-2.png]]

== myApps Assistant - App Service ==
The App Service performs tasks in the following areas:
* Question relay to an LLM
* Language recognition
* Caching
* Translations using the LLM (not yet fully tested)

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

In order to make the app connect to your LLM model provider you need to configure a few fields.

* '''Remote Service URL''' - The URL where the remote service interacting with the LLM is hosted. If you are using a model hosted by openAI this would probably be: https://api.openai.com/v1/chat/completions
* '''LLM (model)''' - The actual model you intend to use. There are a couple of open source models you could use (mixtral, deepseek-r1:14b...). If you intend to use openAI models this could be something like gpt-3.5-turbo or gpt-4o
* '''API -Key''' - If you are not using a self-hosted model you might need an API-Key in order to make successful HTTP Requests to your provider. This key will be delivered by your LLM provider (e.g. openAI https://platform.openai.com/signup )

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

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

=== Translations against the backend ===
Translation requests that cannot be handled by the local cache are forwarded to the configured translation backend, which is the LLM (there is only one) you configured in the '''Settings App''' (former PBX Manager Plugin). After successful translation, the translated version is kept in the cache for future requests. Currently no myApps applications are using the API [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm local assistant JavaScript API] for translations. But developers may use it if a LLM is configured and no extra service provider should be used.

== Troubleshooting ==

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

== Related Articles ==
* [https://sdk.innovaphone.com/15r1/web1/com.innovaphone.assistant/com.innovaphone.assistant.htm SDK Documentation - Assistant API]
* [[Howto:Setup a LLM Server]]

Reference13r2:Concept Software Rental

2025-03-24T09:12:51Z

Sga: /* Known Issues */

The software rental may include all the innovaphone software licenses indicated in the price list.
The rental fee is charged via the so-called iSC (innovaphone service credits), managed in the respective customer account. iSC can be purchased through an authorized innovaphone partner.

==Applies To==
This information applies to
* innovaphone PBX from version 13r2

==Requirements==
* innovaphone PBX version 13r2
* a running App Platform and access to the Devices App

==Rental program and Payment method==
innovaphone uses iSC (innovaphone Service Credits) as a payment method for the flexible rental program. The iSC are bound on a customer specific account. As soon as a software license is activated for renting, the account balance starts decreasing, in function of the given rental configuration.
* iSC can be ordered via the innovaphone sales channel and are managed through the myApps Platform. The delivery is realized in form of an activation key. Then iSC are loaded through the Devices App to a specific customer account. The customer account is logically connected to the my.innovaphone license portal. The rental licenses however, are managed exclusively via the Devices App.
* iSC are not bound to specific software licenses or devices, but to a customer account. Existing iSC balances can therefore be used flexibly, by the same customer, to rent other licenses or services.
* The rental program is operational, as long as a positive iSC balance is available on the customer account. The rental does terminate immediately when the iSC balance becomes zero. A negative iSC balance is not accepted.
* Starting 7 weeks before a customer will run out of iSC, a weekly alert email will remind the administrator to recharge the customer account with iSC. This feature has to be activated in the domain settings, <Edit> tab, by entering an email address in the field <E-mail address(es) for warning of rental expiration>.

====Software Rental Program====
This program can apply to two different scenarios (with a different pricing):
* software operated on devices at the customer's premises. This could eventually be the innovaphone PBX software, conferencing licenses, etc. installed on innovaphone hardware (a Gateway, such as IP3011) or a private virtual machine (IPVA) on a customer owned server, typically operated at the customers' location.
* software operated within the myApps Cloud Service, a cloud platform operated by innovaphone. In this case an innovaphone PBX software, conferencing licenses, etc. are operated within the innovaphone cloud platform.

====Hardware licenses====
* Eventually needed Hardware licenses (e.g. channel licenses) have to be bound on the specific device in my.innovaphone itself (currently this is not be handled within the Devices App). Those need to be downloaded from my.innovaphone and on the device with the already known methods.

====Technical aspects====
The rental duration is calculated on each license or balance change in the domain. Consequently, after each change in the configuration new licenses, with a new duration are transferred to the gateways and also stored in the Devices App itself.
If the rental expires, the gateway reboots and the licenses are not operational anymore.
The licenses are also transferred after each reconnect of a gateway to the Devices App.
Remarks:
* For license and balance changes, the Devices App must be online and have access to my.innovaphone.com!

====FAQ====
* '''Question:''' Is it possible to divide a given activation key (e.g. containing 1000 iSC) and charge various customer accounts? 
'''Answer:''' YES, this is possible! 
'''Proceed like this:''' 
(1) Open [http://my.innovaphone.com my.innpvaphone.com] and click on the "Licenses" tab. 
(2) Following, select your project under "Projects". 
(3) Press "Add" and paste the given activation key. Then press <Next>. 
(4) The iSC value, contained in the given activation key, is displayed. Press <OK> to bind this iSC value to your own balance. 
(5) Via the tab "Own Activations" followed by "Create", new activation keys can be created, until the balance is zero. 
(6) For further information, please refer to the article [http://wiki.innovaphone.com/index.php?title=Reference:My_Innovaphone Reference:My Innovaphone].

==Activation==
The procedure for the activation of Software Rental is nearly identical, for both previously mentioned scenarios.
* In the devices App, select the domain for which rental will be activated.
* Select the tab “Software Rental”
* If you already have a my.innovaphone account, please enter username and password, and press <Login>.
In case you do not have a my.innovaphone account, please click on the link to the portal my.innovaphone to create a new account.
* If you didn't conclude a software rental contract yet, the Devices App will tell you so and you can conclude such a contract inside the portal my.innovaphone
* After you have concluded a contract, innovaphone must first approve this contract. If the contract is approved, you will receive an email.
* Finally, reopen the software rental tab and you will be able to start renting software.

==Charge iSC Account Balance==
===Charging manually===
* Press the button <Charge Balance>. [[Image:Ref13r1ConceptSwRental Charge01.png]]

* Paste the activation-key and press <Check> to verify its validity. [[Image:Ref13r1ConceptSwRental_Charge03.png]]

* If the activation-key contains the expected iSC value, proceed by charging the value onto your customer account. [[Image:Ref13r1ConceptSwRental_Charge04.png]]

* The new balance appears in the menu. Eventually prior activated software licenses are deducted immediately. [[Image:Ref13r1ConceptSwRental_Charge05.png]]

* An additional information field is indicating the monthly consumption of iSC, based on the rented software licenses (configuration below). In addition, the possible operation period is displayed, calculated on the given iSC balance. [[Image:Ref13r1ConceptSwRental_Charge06.png]]

Remarks:
* The rental costs are deducted in seconds, starting from the moment of activation. If no iSC are loaded into the customer iSC account, the operation of the rented installation will not initiate or be discontinued automatically.

===Charging automatically===
For the convenience of our users, innovaphone implemented an iSC Reloading Service, which will - when necessary - automatically recharge the balance. In this case, automatically an invoice is being generated and sent to the partner.
* Details please check: [http://wiki.innovaphone.com/index.php?title=Howto:V13_Activate_Automatic-iSC-Reloading-Service Howto:V13 Activate Automatic-iSC-Reloading-Service]

==Configuration==
* In the first step, use the drop-down menu, to select the PBX for “software rental” operations, and press <Add to rent>. [[Image:Ref13r1ConceptSwRental_Config01.pngRef13r1ConceptSwRental_Config01.png]]

* Select the required software licenses, jointly with amount of licenses needed (e.g. Port-Lic x 25, UC-Lic x 25, etc.). Beneath each license item, the corresponding charges in iSC per month are displayed. To add this license to the PBX press <Add license>. [[Image:Ref13r1ConceptSwRental_Config01.pngRef13r1ConceptSwRental_Config03.png]]

* The areas and values marked with yellow color indicate the changes, compared to the prior configuration. Thus, it is possible to see the consumption preview per PBX (important, in case there are more than one PBXs) and the total consumption preview for the entire account. - Further licenses can be included by pressing <Add license> [[Image:Ref13r1ConceptSwRental_Config04.png]]

* To finalize the configuration, when all required software licenses have been configured, press <Apply> [[Image:Ref13r1ConceptSwRental_Config05.png]]

* Please verify, the monthly iSC consumption, for the newly created software renting configuration. To accept and activate the charging of the iSC balance, press <Change with costs>. [[Image:Ref13r1ConceptSwRental_Config06.png]]

* The software configuration of this PBX is activated successfully. The new monthly iSC consumption is displayed, beneath the PBX name. The iSC account balance is decreasing, in accordance with the configured iSC charges. The calculation is made on a per second basis. [[Image:Ref13r1ConceptSwRental_Config07.png]]

==Rental history==
Beside the possibility to download the history through the Devices App UI, there is an [[ Reference13r1:Concept_App_Service_Devices#API_to_download_rental_history|API ]] for automated downloads.

==Mix of rental and purchased licenses==
See [[ Reference:My_Innovaphone#Mix_of_rental_and_purchased_licenses|Mix of rental and purchased licenses ]]

==Known Issues==
===Reinstall of the PBX or Devices App===
Currently the leased licenses are bound to the PBX only when clicked on the confirmation button ''"Chargeable change"/"Kostenpflichtig ändern"''. If the PBX has to be reinstalled you need to edit rental licenses and then click on this button to load the rental licenses in the PBX again

===No mixed licenses===
If you have licenses of different versions you can only use the software of the smallest version. As well please be aware if you have software rental licenses of v13 and the PBX receives from another device v12 licenses that this causes problems.

===No Sysclient2===
Devices with Rental-licenses may not be configured with the second (hidden) sysclient-url (AdvancedUI -> Maintenance/Diagnostics/Config show -> config change SYSCLIENT2) as there can only be one source for Rental-licenses.

==Troubleshooting==
If the renewal of the licenses does not work as expected, reproduce the error and create a trace of the Devices-App using App, DNS and Http-Client trace options.
[[Category:Concept|{{PAGENAME}}]]