innovaphone wiki - User contributions [en]

Reference16r1:Concept App Charts

2026-05-05T12:43:41Z

Jbi:

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


== Applies to ==
* Charts App

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Howto:Voconix - Voxelis - Partner App

2026-04-23T09:28:52Z

Jbi: /* Supported languages */

[[Image:Fichier_18@4x.png||200px|right]]

==Product Name==


[[Image:Fichier_18@4x.png|100px]]

[https://voconix.fr Voconix]

==Certification Status==

{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed February 2026.

==Category==

[[Category:Partner_Apps|{{PAGENAME}}]]
{{Category:3rdParty_Music_on_Hold}}
[[Category:3rdParty_Music_on_Hold|{{PAGENAME}}]]

==Vendor==



[[Image:LogoVoxelisPetit.png|150px]]




Voconix is a brand of Voxelis, a French company that provides sound and digital communication services. Its head office is in Bordeaux (33), France.


[https://voxelis.fr/ Voxelis - About us]

==Description==






Voconix is a tool for creating phone messages designed for easy integration with Innovaphone systems.
* Extensive music catalog: Over 8,000 commercial and royalty-free tracks.
* Multilingual AI voices: Available in French, German, English, Spanish, and Italian.
* Optimal compatibility: Downloads available in WAV, MP3, G.XXX, and Opus formats.
The Voconix application described here provides access to the Voconix AppBuilder product via Innovaphone myApps.

==Functions==



Voconix, an AI-powered phone message creation tool, enables the following features:

'''Complete music catalog: over 8,000 commercial and royalty-free tracks
'''
* Automatic mixing on commercial and royalty-free music
* Autonomous retrieval of SACEM SCPA royalty-free music certifications
* Creation of messages without music possible
'''Catalog of AI voices in French, German, English, Spanish, and Italian'''
* Memorization of difficult pronunciations
* Message history tracking
* Management of a list of beneficiaries/employees
* Access to pre-recorded human voice messages.
'''Message Delivery'''
* Download in various integration formats (MP3, WAV, G.XXX, Opus, etc.)
* Notification to the installer when announcements are made available by the end client


===Multi-PBX ready===




There are no known restrictions.

===Cloud ready===

There are no contraindications to using Voconix App in the cloud.

===Supported languages===



Portal available in French, English and German

=== Provided APIs ===



An API is available.

https://voconix.fr/api/


==Licensing==



free

==Prerequisites==


Voconix account

==Versions==


===Compatible innovaphone firmware versions===

15r1 and later

===Application versions used for interop testing===


15r1 and later


==Configuration==












Go to the VOCONIX app in Innovaphone myApps

[[Image:Etape1Voconix.png||500px]]

'''Open an account for your client:'''
* Click the registration button
* Click "'''I am a Telecom integrator on behalf of my client'''"
* Enter the first few letters of your telecom integrator company name and then click "'''Select this integrator'''". If you cannot find your integrator name, click "'''I am not listed, my name is not displayed'''" to submit your listing request to the Voconix directory.

* Fill in your client's account information and then click "'''Validate and submit the request'''"

'''Following this action :'''
Your client will already have an "Essential" Voconix account with their first AI message credits. Your client will receive an email inviting them to complete the registration (password bank) online on the Voconix platform for Innovaphone.

'''As an integrator :'''
You are also associated with your client competencies and are notified of the availability of new AI voice messages when the request has been made.

[[Image:Inscriptionclientfinal.png||1000px]]

==Contact==




{|
| Voconix par Voxelis
|-
| Eric Humier
|-
| 122 Rue de la croix de Seguey
|-
| 33000 Bordeaux, France
|-
| Tel: +33 9 701 708 20
|-
| Mail: [mailto:support@voxelis.fr support@voxelis.fr]
|}

Reference16r1:Apps/PbxManager/App Documents

2026-03-10T10:48:35Z

Jbi: /* Individual Documents App Configuration */

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

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

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

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

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

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

=== Configuration Templates ===
Select configuration templates to be applied for the Documents app object.

Reference13r1:PBX/Objects/Edit Forks

2026-03-09T11:22:18Z

Jbi: /* Properties of Mobility */

With this page call forking can be configured for a user. This means a call for this user is not only sent to endpoints registered to the user object, but also to the forking destination. If a mobility object is configured for the forking, the phone identified by the forking destination can use the mobility functions. A delay can be configured for the call to the mobile endpoint. This delay is not supported for normal call forking without mobility functions. Operator calls from a waiting queue require a UC license to be sent to forking destinations.

;No/Name: Forking destination

;Bool/Not: The forking can be turned on and off by a Boolean object. With the '''Not''' checkmark the state is inverted.

== Properties of Mobility==

For the function of the Mobility features a Mobility license must be installed.

;Object: The [[Reference9:PBX/Objects/Mobility | Mobility]] Object (Long Name) must be set, if the mobile endpoint (GSM Phone) needs to use the [[Reference8:Administration/PBX/Objects/Mobility | mobility features]].
: Mobility license is required

;Device: The Device name of the User should be configured here (e.g. "Smartphone"). This name is used by SOAP (TAPI) to address this device for example when initiating a call, by myPBX to enable/disable Mobility for the User (on the Call Forward settings Screen of myPBX) and for Mobility Client OptiCaller for HTTP CallBack/CallThrough.

;App: Field that is used to configure the rcc app for callback feature available in the user profile App. To call the app just enter "rcc".

;Delay: A Delay in seconds can be configured to call the mobile endpoint.

;Disable: Disabling the Mobility features for the mobile device, this can also be en/disabled via [[Reference8:Administration/PBX/Objects/DTMF_Features#Enable.2Fdisable_mobility |DTMF featurecodes]]

;Call-Waiting: Enable or disable call-waiting for the mobile endpoint, if a mobile endpoint is in a call a call waiting tone will be played from the PBX to the mobile endpoint via the RTP stream. See [[Reference9:PBX/Objects/Mobility | R-Key Functions]] for waiting calls handling options.
: Mobility features are required

;GSM-License: When using the innovaphone GSM client a GSM license is needed and need to be activated. NB: obsolete

;Min-Alert: The minimum time in seconds a call must ring on the mobile phone until it can be accepted. If the call is accepted before this time, the call is rejected by the PBX. This way it can be achieved that the announcement from a mobile provider for phones not available does not accept a call and calls can be accepted on a fixed phone on the same number in case the mobile phone is switched off. The alert time is measured from the alert to the connect signalling. If there is no alert message (e.g. because there is a connect right away), the alert time is counted as null. '''Note: If the carrier doesn't send any Alert/180 Ringing, you may need to enable [[{{NAMESPACE}}:PBX/Objects/Mobility | Carrier w/o Alerting]] .'''
: Mobility features are required

;Max-Alert: Maximum time the mobile phone rings. After this time the PBX terminates the call to the mobile phone. This way it can be avoided that the mobile voicemail accepts the mobility call.
: Mobility features are required

[[Category:Concept_App_RCC|Related]]

Howto:Tested mSata modules

2026-03-05T09:30:56Z

Jbi:

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


==Applies To==
This information applies to

* IPxx11 with '''mSata''' slot (IP311, IP411, IP511, IP811, IP0011, IP3011)
* mSata modules for the IPxx11 should consume less than 2500mW to avoid high temperatures in the gateway.
* The powerconsumption depends on the IO activity of the card, usually it is higher during write.
* Larger mSata modules also need more current.
* Some mSata modules reduce throughput if the temperature is too high.
* Write endurance is another important parameter to consider when selecting a mSata module
* mSata state can be checked with the linux smartmontools package

Note: '''This article DOES NOT APPLY to IP0013 and IP6013 M.2 SSDs!''' For information to those devices, refer to [[Howto:How_to_IPxx13#SSD|this article]].

==More Information==

===Modules tested in 2016===

The modules where tested by writing a 5GByte file with the linux DD command. The write speed and POE current consumption were measured.

;Apacer 32G mSata module APSDM032GM1HN-GTM1 http://www.digikey.de/product-search/en?mpart=APSDM032GM1HN-8TM&v=1582
:datasheet http://eflash.apacerus.com/spec/SATA/mSATA/mSATA_H1-M.pdf
:max power 600mW
:write speed 125Mbyte/s

;Transcend 32G http://www.amazon.de/Transcend-MSA370-interne-mSATA-256GB/dp/B00K64I1ZG
:datasheet http://de.transcend-info.com/products/images/modelpic/576/TSXGMSA370_V13%20Datasheet.pdf
:max power 1050mW
:write speed 45Mbyte/s

;SanDisk Z400 32G ATA-9: SanDisk SD8SFAT032G1122, Z2201000, max UDMA/133
:datasheet https://www.sandisk.com/content/dam/sandisk-main/en_us/assets/resources/enterprise/data-sheets/Z400s_datasheet_mainstream-v1_3.pdf
:max power 950mW
:write speed 44Mbyte/s

===innovaphone mSATAs since 2017 ===

Starting with release of pricelist in June 2017, innovaphone offers following mSATAs listed below.
Those mSATAs correspond to above mentioned specifications and can be ordered via usual ordering process:

*Order-no 03-00010-029 - 64GB
*Order-no 03-00010-010 - 128 GB
*Order-no 03-00010-011 - 256 GB

==Related articles==
[[Howto:MSATA_Placement]]

Howto:Ilink-crm-ext- ilink - Partner App

2026-02-18T09:24:51Z

Jbi: /* Configuration */

[[Image:ilink.jpg|200px|right|/Ilink.jpg]]

==Product Name==


ilink Kommunikationssysteme GmbH [https://www.ilink.de/ilink-crmext/info.html ilink CRM Extensions]

==Certification Status==

{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed March 2023.

==Category==

[[Category:Partner Apps|{{PAGENAME}}]]
{{Category:3rdParty App Development}}
[[Category:3rdParty App Development|{{PAGENAME}}]]

==Vendor==



[[Image:ilink.jpg|150px|/Ilink.jpg]]





[https://www.ilink.de/ ilink - About us]

==Description==






ilink CRM Extensions is a slim and flexible Windows application for inbound caller recognition and for dialing phone numbers through company phones with a click. And it works in home offices, too!

A popup window displays information like caller name, company, location, and phone number for inbound calls. This information is directly taken from your CRM system, from your address book, or from public telephone directories. Using the „Open Contact“ button, the user directly opens the corresponding contact view of his CRM client. Dial with single click from many CRM systems, or use the hotkey to dial from almost all Windows applications.

Supported CRM systems include:Act!, Datev, Goldmine Premium Edition, HCL Connections, HCL Notes, HubSpot, Maximizer CRM, Microsoft Dynamics CRM, Microsoft Outlook + Exchange Public Folder, Netsuite, ODBC databases - customizing through SQL commands, Sage CRM, Salesforce.com, SAP, Sugar CRM, Tigerpaw CRM, vCard / LDAP.

Supported online telephone books: telefonbuch.de (Germany), Das Örtliche (Germany), local.ch (Switzerland), search.ch (Switzerland), herold.at (Austria), whitepages.com (USA).


[https://www.ilink.de/ilink-crmext/info.html ilink - About this application]

==Licensing==



[https://www.ilink.de/ilink-crmext/license.html See ilink crm-ext license conditions]

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V13r2 or higher
===Application versions used for interop testing===


* ilink ilink-crm-ext 1008 final, 27/03/2023

* innovaphone V13r2, 15r1sr3

==Configuration==










[https://www.ilink.de/ilink-crmext/install-configuration.html See ilink configuration (German) guide for innovaphone myApps] 
[https://www.ilink.de/en/products/ilink_crm_extensions/innovaphone/install-configuration.html See ilink configuration (English) guide for innovaphone myApps]

Please note: The name of the PBX object must be spelled exactly: ilink-crmext
Using another name leads to an error message "ilink-crmext" in the log files.

==Contact==




{|
| ilink Kommunikationssysteme GmbH
|-
| Tel: +49 30 28526 1254
|-
|Mob: +49 171 6407377
|-
| Mail: [mailto:info@ilink.de info@ilink.de]
|}
Open Q&A and product demo and discussions: Every Wednesday at 10:00 here: https://sametime.dnug.de/meeting/CRMIntegrationen

For any questions please refer to [https://www.ilink.de/ilink-crmext/support.html our contact page].

Howto:Ilink-crm-ext- ilink - Partner App

2026-02-18T09:24:33Z

Jbi: /* Configuration */

[[Image:ilink.jpg|200px|right|/Ilink.jpg]]

==Product Name==


ilink Kommunikationssysteme GmbH [https://www.ilink.de/ilink-crmext/info.html ilink CRM Extensions]

==Certification Status==

{{Template:Compat_Status_referral_product_new|type=App}}

This App has been listed March 2023.

==Category==

[[Category:Partner Apps|{{PAGENAME}}]]
{{Category:3rdParty App Development}}
[[Category:3rdParty App Development|{{PAGENAME}}]]

==Vendor==



[[Image:ilink.jpg|150px|/Ilink.jpg]]





[https://www.ilink.de/ ilink - About us]

==Description==






ilink CRM Extensions is a slim and flexible Windows application for inbound caller recognition and for dialing phone numbers through company phones with a click. And it works in home offices, too!

A popup window displays information like caller name, company, location, and phone number for inbound calls. This information is directly taken from your CRM system, from your address book, or from public telephone directories. Using the „Open Contact“ button, the user directly opens the corresponding contact view of his CRM client. Dial with single click from many CRM systems, or use the hotkey to dial from almost all Windows applications.

Supported CRM systems include:Act!, Datev, Goldmine Premium Edition, HCL Connections, HCL Notes, HubSpot, Maximizer CRM, Microsoft Dynamics CRM, Microsoft Outlook + Exchange Public Folder, Netsuite, ODBC databases - customizing through SQL commands, Sage CRM, Salesforce.com, SAP, Sugar CRM, Tigerpaw CRM, vCard / LDAP.

Supported online telephone books: telefonbuch.de (Germany), Das Örtliche (Germany), local.ch (Switzerland), search.ch (Switzerland), herold.at (Austria), whitepages.com (USA).


[https://www.ilink.de/ilink-crmext/info.html ilink - About this application]

==Licensing==



[https://www.ilink.de/ilink-crmext/license.html See ilink crm-ext license conditions]

==Versions==


===Compatible innovaphone firmware versions===

* innovaphone V13r2 or higher
===Application versions used for interop testing===


* ilink ilink-crm-ext 1008 final, 27/03/2023

* innovaphone V13r2, 15r1sr3

==Configuration==










[https://www.ilink.de/ilink-crmext/install-configuration.html See ilink configuration (German) guide for innovaphone myApps]
[https://www.ilink.de/en/products/ilink_crm_extensions/innovaphone/install-configuration.html See ilink configuration (English) guide for innovaphone myApps]

Please note: The name of the PBX object must be spelled exactly: ilink-crmext
Using another name leads to an error message "ilink-crmext" in the log files.

==Contact==




{|
| ilink Kommunikationssysteme GmbH
|-
| Tel: +49 30 28526 1254
|-
|Mob: +49 171 6407377
|-
| Mail: [mailto:info@ilink.de info@ilink.de]
|}
Open Q&A and product demo and discussions: Every Wednesday at 10:00 here: https://sametime.dnug.de/meeting/CRMIntegrationen

For any questions please refer to [https://www.ilink.de/ilink-crmext/support.html our contact page].

Reference15r1:Concept Push Notifications for iOS and Android

2026-02-12T14:01:58Z

Jbi:

[[Category:Concept|iOS Softwarephone]]
The PBX is able to send Push notifications to the Apple (APNs) or Android Push Notification services. As a result, incoming calls are also indicated when the myApps application is not started or runs in the background mode. The PBX is using a service provided by innovaphone AG at ''push.innovaphone.com'' to send the push notifications to the vendors Notification Service. No call meta data is transmitted, the push notification is only used to wake up the myApps application. Only one Push object is needed for a system.

== Requirements ==
=== PBX ===
* Firmware version 15r1 or higher
* Internet access via HTTPS
* device certificate (also on '''IPVAs''')
** this device certificate is not an own certificate, which you can upload yourself but which you need to retrieve through my.innovaphone (see [[#Initial configuration| Initial configuration]])!

=== Smartphone ===
* iOS Version 12.0.1 or higher
* Android Version 6.0 or higher

== Configuration ==
=== PBX ===
* verify that each pbx has the certificates <code>innovaphone Device Certification Authority 2</code> or the signed <code>push.innovaphone.com</code> in his local trust list. If you use the [[{{NAMESPACE}}:Concept App Service Devices#Certificates configuration|Devices - certificate trustlist concept]] the certificates will be installed automatically.
* create a PUSH object via the PBX manager,by clicking on the plugin Push (Black and White myApps symbol) The Plugin will create a PBX object in the PBX of type [[{{NAMESPACE}}:PBX/Objects/Push|Push]] per system, even in master/slave scenarios
** Name Push and SIP name push can be freely choosen, but the sip name must be used in the push field of user the objects. We advise leave the pre filled Standard names.
** the App URL must be <code>https://push.innovaphone.com/push/ws</code>
After clicking OK a green checkmark should appear, indicating that the Push object has a valid websocket connection to the innovaphone Push service.

=== User Objects ===
* For each user who is to receive push notifications on his myApps-application, the ''Name'' of the push-object must be entered in his userobject at the ''Push'' field in the ''User'' tab.

=== iOS specific settings ===
* On the iOS device make sure to allow push notifications for the myApps application.

=== Android specific settings ===

==How it works==
*First of all the mobile phone opens a connection to Apple or Google. If the phone is in a restricted Wi-Fi network (and has no GSM/LTE data connection to receive Push notifications), the appropriate ports of the firewall needs to opened as explained in the documentation of [https://support.apple.com/en-us/HT203609 apple] or [https://firebase.google.com/docs/cloud-messaging/concept-options#ports_and_your_firewall google].
*If the app is in the background and the user receives an incoming call, the App needs to be woken.
*Therefore the PBX sends a push request to innovaphones push servers (push.innovaphone.com)
*The communication is done with MTLS and our push servers check the client device certificate of the PBX
** the used certificate is the device certificate provided by innovaphone and not a certificate, which you can upload yourself
*push.innovaphone.com forwards the request to the Apple or Google Push service.
*The respective vendor sends the push request to the mobile phone and uses the ports opened in the first step.
*The app then registers at the PBX via H.323.
*In the last step the incoming call is sent (using the H.323 registration) to the mobile phone.

[[Image:push.gif|push.gif/]]

Note: the services.innovaphone.com in the picture must be replaced with push.innovaphone.com

=== Privacy ===
When using the Push service the PBX will send following data/information to [[Howto:Innovaphones public services|innovaphone]]:

* Notification Type (plain)
** ''call'' or ''notification''

* Detailed informations (enrypted)
** ''call''
*** number
*** name
*** callflow
** ''notification''
*** title
*** content

This information will send from the PBX to the Smartphone via the innovaphone Push-Service and forwarded to the Google/Apple push system. The Smartphone receives a decryption key via websocket or H323 (you have to use the secure version to transmit the key encrypted) from the PBX. Neither the push service at innovaphone nor the Apple / Google push system can read the encrypted information.

== Troubleshooting ==
=== Initial configuration ===
* Check the trust list for the certificate of the innovaphone AG.
* Make sure the PBX can resolve the DNS host ''push.innovaphone.com''.
* Make sure the PBX can reach ''push.innovaphone.com'' via HTTPS.
* Make sure that you have a innovaphone ''device certificate'' - even on '''IPVAs'''. The certificate is signed by ''innovaphone Device Certification Authority 2'' or on IPVAs since V14r1 by ''innovaphone Unverified Device CA''. If not, you can acquire a new one on the Gateway via [[{{NAMESPACE}}:General/License/my.innovaphone#Download_Certificate | General/License/my.innovaphone]]. '''This will not conflict with an existing certificate that you installed yourself on the gateway.'''
* Make sure the myApps application has Push Notifications allowed in the OS settings.
** iOS: Also make sure, the iOS device has a valid GSM data connection or a WiFi connection with the internet, especially TCP port 5223 (see [https://developer.apple.com/library/archive/technotes/tn2265/_index.html Troubleshooting Push Notifications] article by Apple).

=== Push looses connected state ===
* If the push object was already connected, and for some reason (after a firmware update or network connection problems), the object is not connected anymore, please check that PBX can reach and resolve "push.innovaphone.com" and the innovaphone AG certificate is still in the trust list.

===myApps for Android push configuration checks ===

[[Image:Troubleshoot_v13_Push_with_myApps_for_Android and iOS_1.jpg|troubleshoot_v13_push_with_myapps_for_android_and_ios_1.jpg/]]

Open myApps, and check you have a softphone app configured. Then tap on the "burger" menu on the top right, and check your default app is the softphone app.

Scroll down and tap on "More"
# Tap on "myApps events" and enable notification on the smartphone for myApps
# Tap on "Calling account" and enable myApps as call account
# Tap on "Data saver" and enable background data for myApps on the smartphone
# Tap on "Overlaying" and enable them on the smartphone

===myApps for iOS push configuration checks ===
Go through the following steps, to check that in your iPhone, Push is configured correctly.
#Open your iOS Settings app on your iPhone
#Go to the ''Notifications'' (German: Mitteilungen) section
#Find the myApps app and make sure notifications are allowed and that LockScreen, Notification Center and Banners are selected as Alerts 
For more information on howto enable Push notifications for an iOS-app, see also [https://support.apple.com/en-us/HT201925#If%20you%20don't%20see%20notifications%20for%20a%20specific%20app this Apple support page, section If you don't see notifications for a specific app]
===innovaphone Push Service check===
Consult [https://status.innovaphone.com/ innovaphone services overview] to check if any unexpected service outage concerning push exists

== Known limitations ==
=== Number to Name resolution on Android Push Notifications could be missing ===
On incoming call Push Notification to Android the caller number will be included, if the Number to name resolution it's not yet finished no name will be included in this Push notification just the number. The Android doesn't allow a number/name update of that call afterwards so it will remain displaying only the number till we terminate the call. On iOS we don't have such issue since the system allows update of the number/name during call.

=== Push does work even when the myApps app is switched off ===
The Push mechanism will also work when the myApps app is turned off. This can lead to complains about receiving calls after working ours or during holidays.
With myApps as client, you can set the status to DND Do Not Disturb. Then close the myApps.
This will prevent the App to be started by the Push mechanism.
To receive calls again, open the myApps clients and set the status back to available.

You can disable the Push to the myApps by just ending the session for this device by logging out of the myApps application or Alternative you can go to the Hamburger Menu, Account Security and logout the active session.
You can also remove a session from another device for example a myApps Session from another Smartphone or browser.
Deselecting a default Softphone app, will also prevent the Push mechanism.

=== Customer uses HTTP-Proxy for Internet access ===
The WebSocket client does not support HTTP-Proxy connections, more specific HTTP Tunneling using HTTP CONNECT - therefore Push notifications will not work. See also: [[{{NAMESPACE}}:Services/HTTP/Client#Proxy_Servers|Reference15r1:Services/HTTP/Client#Proxy_Servers]]

==Known issues==

===Cloning IPVAs===
If you clone an IPVA with an existing device certificate, you'll also clone this certificate, so you'll have a wrong serial number inside the certificate afterwards. 
So '''do not clone''' IPVAs but setup a new VM and upload a modified configuration file afterwards and create a new certificate for the new machine.

Currently it is not possible to update or delete the device certificate.

== Related Articles ==
* [[Howto:Innovaphones_public_services]]

Reference14r2:Concept App Remote Control

2025-12-01T16:40:48Z

Jbi:

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
== Applies to ==
* innovaphone PBX from version 14r2

== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 120004)
* V14r2
* Windows 10 and up
* Windows Server 2016 and later versions
* myApps for Windows. '''Note : in v14r2 Remote Control App is only supporting remote sessions between myApps Windows Client !'''

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

== Licensing ==

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

== Installation ==
=== For new v14r2 installation ===
The Remote Control App is automatically installed by the installer and will be deployed in the '''Config User''' template
=== With the PBX manager AP app installer plug-in ===
[[File:Ap_app_installer.png]]

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

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

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

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

Here are the features available in the Remote Control App

;Included features
:
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support from viewer to sharer
* Support for different keyboard layouts
;Licensed features
:
* Launch the Remote Control App and start a session with a URL: to use the URL feature you have to create a hyperlink of ''"com.innovaphone.myapps:remotecontrol?action=start_session_with&sip='''username'''"'' where '''username''' is the name field of a user object, this link will then be handled by the myAppsUrlHandler.

* Multiple sessions: If you need more than one session (e.g many viewers for one sharer, more than one parallel session)

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

=== Technical data ===
* The maximum bitrate is 1.2Mbits for the users who is sending its desktop UI. The viewer just sends mouse and keyboards events
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature

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

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

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

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

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

Reference15r1:Concept App Remote Control

2025-12-01T16:40:27Z

Jbi:

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
== Applies to ==
* innovaphone PBX from version 15r1
== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 130006)
* V15r1
* Windows 10 and up
* Windows Server 2016 and later versions
* myApps for Windows.
* Remote Control Client for external participants '''Note : in v15r1 the Remote Control Client is only available for Windows'''

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

== Licensing ==

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

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

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

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

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

A user (viewer) sends a request to another user (sharer) to access the sharer's PC, the sharer accepts the session and begins to share their desktop with the viewer.
 The viewer is also automatically given control of the mouse and keyboard. Remote sessions are also possible between companies using myApps or not.

=== Features ===

Here are the features available in the Remote Control App

;Included features
:
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support in both directions
* Support for different keyboard layouts

;Licensed features
:
* Support with participants outside your organisation
** Between 2 different myApps installation using Remote Control App ''(e.g 2 different companies)'' via a session link.
** Without myApps with the [[Reference15r1:Concept_App_Remote_Control#With_the_Remote_Control_Client_msi_application|Remote Control Client]].
* Share/Join session
** Generate a session link from Remote Control App and share it
** Join a session by entering a link
* Multiple sessions:
**If you need more than one session (e.g many viewers for one sharer, more than one parallel session)

=== Remote Control with participants outside your organisation ===
====With the Remote Control Client external application====
The Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. ''E.g. : external participants such as your customers''. External participants see the myApps user's screen sharing.
* Client compatible with Windows only
* Easy to install, download client via a session link:
**Open the shared session link in a web browser and get the ''remoteControl.exe''
**Open the previously downloaded file on your computer
**Enter your name, info and session link ''(same link that is used to download the client)''
**Click on Join Session
''Note : from 15r1sr2 we introduced a new, lighter client that requires less effort to install and use. The new client also offers a new possibility of joining sessions with elevated admin rights for users who are not admins on their computers. ''

====With your myApps Remote Control App====
It is possible to establish a remote session between 2 organisations using myApps and having the Remote Control App installed. In the App you can also join/share a session with a link.
*Compatible only between myApps Windows clients
*Easy to use:
**User A from company "xyz.com" opens his Remote Control App in myApps and clicks on '''Share session'''
**User A copies the link and sends it to User B
**User B from company "abc.com" opens his Remote Control App in myApps, clicks on '''Join session''' and pastes the link received from User A into the '''Session link text field'''
**User A will receive a Join Session notification to accept
**User A will see User B shared session

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

=== Technical data ===
* The maximum bitrate is 1.2Mbits for the users who is sending its desktop UI. The viewer just sends mouse and keyboards events
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature
*Same port range is used by the Remote Control Client msi application

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

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

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

=== Trace of the Remote Control Client ===
Do a right click on the app try icon and click on ''open trace folder'' (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference16r1:Concept App Remote Control

2025-12-01T16:40:13Z

Jbi:

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Howto:Pcap

2025-11-19T10:07:25Z

Jbi:

With remote PCAP, network traffic can be captured directly from another network device, instead of capturing the network traffic from the own device.

==Remote PCAP==
===Requirements===

* You should have installed the latest wireshark Stable release 4.4.x - [http://www.wireshark.org/download.html Wireshark Download]
: You may also use newer builds, but make sure they are supported by our plugin DLL. See [[#Versions | Versions ]] below for a list of supported versions
* To view the standard debug output of ISDN LAPD/Q.931 packets, you have to install the ''innovaphone plugin'' (<code>innovaphone_win32.dll</code> or <code>innovaphone_win64.dll</code>, depending on your installed wireshark version, 32 bit or 64 bit). To convert text log output (from the ''Maintenance/Tracing'' page) you can use ''log2pcap.exe''.
*To download both items, go to the [http://store.innovaphone.com innovaphone AppStore] under the tab '''Software''' , select the latest version of '''log2pcap''' and '''Wireshark DLLs''' .
: Again, if you use newer builds, make sure you download the DLLs from the appropriate ''apps'' package (see [[#Versions | Versions ]] below)
: To '''install''' a DLL version '''1059''' or previous, just copy it to your wireshark plugin directory and pay attention on your currently used version (e.g.: c:\programme\wireshark\plugins\1.12.0\). Note that you need to re-install the DLL each time you update wireshark
: To '''install''' a DLL version '''1060''' or later, just copy it to your wireshark plugin '''epan''' directory and pay attention on your currently used version (e.g.: c:\programme\wireshark\plugins\4.4\epan\). Note that you need to re-install the DLL each time you update wireshark
* Open the [http://wiki.innovaphone.com/index.php?title=Image:Pcap_example_isdn.zip example pcap file with lapd and q.931 packets] to check your current installation. It should look like this, if you have the innovaphone_winXX.dll correctly installed:

[[Image:Pcap_sample_isdn.jpg|center|thumb|200px|PCAP ISDN example]]

==== Using Wireshark ''Legacy'' ====
Starting with version 2, wireshark has a new user interface. Unfortunately, we found this to be sluggish and buggy. For that reason, we strongly recommend to use wireshark's ''legacy'' version. It is available as an option (''Wireshark 1, The classic user interface'') in the installer's item selection. You also may want to associate the trace file extensions (.pcap, .pcapng etc.) with ''Wireshark Legacy'' instead of the standard version (also available in the setup dialogue).

===Setting up the rpcap server===

* The rpcap server can be any innovaphone device.
* The remote pcap server is disabled per default. To enable it, just go to Diagnostics->Tracing and check the "Enable" flag in the "Remote PCAP" group. If you are experiencing problems, also enable the trace flag with "config add PCAP /trace".
* To capture all ip traffic (udp and tcp), enable the "IP (all tcp/udp traffic)" flag in the group "IP". Otherwise just enable all the trace flags on the modules you want to capture.

===Capturing with wireshark===

===1.x.x - 1.7.x===
Open your wireshark and the capture options dialogue. Choose "remote" from the dropdown list and
Type "<IP-ADDRESS>/TRACE" into the host field.

It should look like this: (Screenshot from older Wireshark, v.1.2.2)
[[Image:Wireshark_1.2.2_trace_settings.PNG|center|thumb|200px|Wireshark capture options]]

Then just click on "Start" to start capturing.
 

=== >= 1.8.x ===

Open your wireshark and „Capture Options“->“Manage Interfaces“->“Remote Interfaces“. Add the IP address of your device. 
The remote interface will be listed in your interface now and you can select it for capturing data.

[[Image:Wireshark_1.8.6_settings.png|center|thumb|200px|Wireshark capture options]]
 

=== >= 2.0.0 ===

[[Image:Wireshark_2.0.0_settings.jpg|center|thumb|200px|Wireshark capture options]]

=== >= 3.0.0 ===

With the latest innovaphone Firmware (e.g. 13r1 SR11), Wireshark is supported again if you use the latest wireshark DLL. 
 
If you're running older firmware versions: 

The innovaphone.dll is not supported currently with this Wireshark-version. Please do not upgrade to Wireshark 3.0 or up.

RCAP does not currently work with innovaphone devices in newer Wireshark versions. If you only want to pull general remote PCAPs with it, you can also try the Wireshark Pipe feature. For this you have to create a new pipe interface in Wireshark in the following format.
<syntaxhighlight lang="bash">
rpcap://[ip-address]/trace
</syntaxhighlight>

During our tests we experienced some problems with it. Alternatively, you can add the pipe interface via the command line. First change to the Wireshark directory and replace [ip-address] with the innovaphone IP address.
<syntaxhighlight lang="bash">
C:\Program Files\Wireshark>wireshark -ni rpcap://[ip-address]/trace
</syntaxhighlight>

=== >= 4.0.7 ===
Wireshark doesn't support 32bit Windows builds anymore, so there is just a 64bit version of the DLL now.

===Supported protocols===

* ISDN: LAPD L2/L3 with dissector innovaphone.dll (enable Diagnostics->Tracing TELX/PRIX/PPP)
* AC DSP: dsp with dissector Ac49xPacketRecording.dll (enable Diagnostics->Tracing->VOIP DSP)
* PPPoE: flag "/pcap" on module(s) PPPOE0/PPPOE1 enables pcap tracing

* All TCP/UDP protocols which are supported by native wireshark dissectors or other dissectors which can be found searching the internet.
e.g.:
SIP
H.323
H.245

Enable the corresponding flags under Diagnostics->Tracing, if you only want to see specific UDP/TCP protocols. To see all, enable the "All TCP/UDP Traffic" flag under Diagnostics->Tracing.

==PCAP Log==

Another possibility to get a pcap log file is to open http://IP/log.pcap
This file has a limited size just as the normal log file.

==log2pcap==

You need the tool log2pcap from the tools package, if you have a log.txt file, which contains pcap packets and you want to view them in wireshark. You can find the tool in the apps tool package (see above).

Usage:
# log2pcap.exe input1 input2 ... inputX
# drag&drop one or more files on the log2pcap.exe
# use an asterisk like "log2pcap c:\*.txt" to convert all txt files into pcap files. Things like c:\test*.txt are not supported.

* The resulting file name is always inputx.pcap (e.g. log.txt is converted into log.txt.pcap).

Note: if you have a trace of a little endian box (e.g. IP3000, IP21) with V6 SR1 or SR2, you have to use the "-srlefix" switch (available since 08-1007):

log2pcap.exe input1 -srlefix

==General Informations==

===Reading PCAP Traces===

====Non-IP Pcap packets====
It will nevertheless show source and destination IP addresses. 127.0.0.1 stand in for the traced device. So if for example a Q.931 SETUP messages is sent from 127.0.0.0 to 127.0.0.1, then it is an incoming setup.

====MAC: 00:90:33:00:00:00====
Sometimes people wonder why a pcap ''00:90:33:00:00:00'' appears as source or destination mac address.
The direction of the packets can be analyzed based on the Mac address.
: We use the devices MAC adress as source only if a packet '''is sent'''
: We use the devices MAC adress as destination only if a packet '''is received'''
The other field will be filled with ''00:90:33:00:00:00''

===Disabling PCAP traces===

You can disable the whole pcap tracing. Just configure a /disable-pcap to the CMD0 module. This can be useful if you do not want to see pcap traces in your log file.

===Used ports===

* The debug traces are encapsulated in UDP packets with port 4.
* The isdn traces are encapsulated in UDP packets with port 4.
* The ac dsp traces are encapsulated in UDP packets with port 50001.
* Wireshark uses port 2002 to connect to the running rpcap-server
* rpcap packets are transfered over a dynamically assigned port between server and client

===Additional Remote PCAP trace===

You can trace the remote pcap protocol with adding the trace flag by "config add PCAP /trace" if you are experiencing connection issues.

===Timestamps===

Since V7 Hotfix 26 and V8 Hotfix 13, the ntp timestamp is used instead of the uptime in rpcap packages. In converted log files with log2pcap, uptime is still used.

===Decode TURN Traffic as RTP===
RTP Traffic encapsulated in TURN and encoded as STUN per default. You can change this behaviour as global setting in your Wireshark. 
To activate RTP heuristic for TURN traffic go to "''Analyze::Enabled Protocols''" and enable the "''rtp_stun''" dissector.

==Versions==
Older versions can be downloaded from the respective [http://download.innovaphone.com/ice/download/p/6.00/apps/ ''tools'' package]:
* Wireshark 1.6.8: DLL Version 1043 - V6 6000043 Application Packet
* Wireshark 1.11.1: DLL Version 1049
* Wireshark 1.12.2: DLL Version 1055 - V6 6000054 Application Packet
* Wireshark 2.0.x: DLL Version 1057 - V6 6000055 Application Packet
* Wireshark 2.2.x: DLL Version 1058 - V6 6000056 Application Packet
* Wireshark 2.4.x: DLL Version 1059 - V6 6000059 Application Packet
* Wireshark 2.6.1: DLL Version 1060 - V6 6000061 Application Packet

Newer versions can be downloaded from [https://store.innovaphone.com the store] (look for ''Wireshark DLLs'' in the ''Software'' tab):
* Wireshark 3.2.x: DLL Version 1061
* Wireshark 3.4.x: DLL Version 1066
* Wireshark 4.0.x: DLL Version 1068
* Wireshark 4.2.x: DLL Version 1069
* Wireshark 4.4.x: DLL Version 1070
* Wireshark 4.6.x: DLL Version 1071

== Offline generation of PCAP Files ==
In version v12r1 and up, you can capture and store PCAP files without running Wireshark. This is done by setting the [[Reference12r1:Maintenance/Diagnostics/Tracing | ''Write PCAP to URL'' property ]] in ''Maintenance/Diagnostics/Tracing'' to an URL which points to a writeable WebDAV folder.

This is useful if you need to trace a device for a long time or if you cannot run Wireshark to capture the trace. However, it is not useful if the traced device restarts, as the last trace file will be incomplete then (due to buffered IO when writing the file).

When you remove the URL, the current trace file will be flushed and no further one will be created.

=== Using V13 File App ===
*create a folder in the File App
*share this folder with username and password
*copy the URL from this folder
*go to services/http/client on the innovaphone device for which you need a pcap and store the URL and access data here
*store the same URL as "Write PCAP to URL" at maintenance/diagnostic/tracing

Attention:
As soon as the URL was successfully deposited and "OK" was pressed, the trace is written into the folder.
To end the trace, the URL can simply be removed and confirmed again with "OK".

==Known Problems==

* Converting a log from a little endian box (like IP3000 and IP21) with firmware V6 SR1 or SR2 with the tool log2pcap will only work with log2pcap 08-1007 or higher and the switch "-srlefix", see [[:#log2pcap|log2pcap]].
* Ac49xPacketRecording.dll works only with 0.99.7. Higher versions of wireshark won't start, if this dll was copied to the dll folder!
* Also some other dlls, contained in the tools package, won't work with each wireshark version. Just innovaphone.dll is always working.
* Even though ''All TCP/UDP Traffic'' is turned on, packets sent to the box acting as rpcap provider to a port that is not handled by the box (that is, where no listening socket is active) will currently not be shown
* If you use a 64-bit Windows Pc then you will need another innovaphone.dll, which is also contained in the latest tool package.
* The custom IP header from captured innovaphone packets contains dummy values for TOS (0), id (0), fragment offset (0) and TTL (128)
* After version 1.8.6 of wireshark the h225 packets are listed as malformed. So higher versions of wireshark could give troubles debugging the h.323 calls.
* '''Couldn't set the capture buffer size!''': if you're experiencing this error message, please start wireshark with the option "-B 1" to set the buffer size to 1 MB

* Wrong time stamp when using PCAP-to-URL:
** open the first frame of the trace and expand the 'innovaphone: DEBUG'-section
** last line shows the correct time: 'Debug: YYYY-MM-DD HH:MM:SS' in this case
** Click on 'Edit -> Time Shift...' in the menu or use the shortcut Ctrl+Shift+T
** Tick 'Set the time for packet 1 to ...' and fill in the time found in the first frame
** Click 'Apply'

===Missing msvcr120.dll or "module not found"/"Das angegebene Modul wurde nicht gefunden"===
You have to install the Visual C++ Redistributable Packages für Visual Studio 2013: http://www.microsoft.com/de-de/download/details.aspx?id=40784

===Inconsistent timestamps with Write PCAP to URL===
There are sporadically inconsistent timestamps where a newer packet might have an older timestamp than the previous packet (a fraction of a second). 
This issue just happens with Write PCAP to URL and the default configuration. This issue has been [[ReleaseNotes14r1:Firmware#157768_-_Firmware:_fixed_wrong_timestamps_in_%22Write_PCAP_to_URL%22_feature | fixed]] in the 14r1 release, so the workaround below is no longer needed. 
 
If you use Wireshark for jitter analysis and consistent timestamps are important, you may do a configuration change:
* disable the epoch-ts option on the PCAP module:
** !config add PCAP /epoch-ts false
** !config write
** !reset
* now the PCAP trace just contains the uptime beginning from 1970-01-01 but without any wrong timestamps
* Wireshark offers an option to set the time on the first packet, so the time can be manually set to the file creation time (right click first packet -> move time -> second option and enter e.g. "2023-01-03 13:30:00")

==Related Articles==
* [[Reference12r1:Maintenance/Diagnostics/Tracing]]

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

Reference16r1:Concept App Remote Control

2025-11-18T13:55:49Z

Jbi: /* Known issues */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Reference16r1:Concept App Remote Control

2025-11-12T16:30:44Z

Jbi: /* Central ID service server */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Known issues ==
*Push notifications on sharer's smartphone : if a viewer wants to start a remote session with a sharer who does not have the Remote Control App open on their PC, a push notification is triggered on the sharer's myApps mobile phone (if installed).
*The usage of the Remote Control App in myApps browser works at the moment only with Chrome
== Known limitations ==
*The language of the Remote Control Windows client is based on your operating system's language.
*Keyboards with different layouts are not supported yet (e.g. QWERTZ to QWERTY).

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

Reference16r1:Concept App Remote Control

2025-11-06T11:28:16Z

Jbi:

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Known issues ==
*Push notifications on sharer's smartphone : if a viewer wants to start a remote session with a sharer who does not have the Remote Control App open on their PC, a push notification is triggered on the sharer's myApps mobile phone (if installed).
*The usage of the Remote Control App in myApps browser works at the moment only with Chrome
== Known limitations ==
*The language of the Remote Control Windows client is based on your operating system's language.
*Keyboards with different layouts are not supported yet (e.g. QWERTZ to QWERTY).

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

Reference16r1:Concept App Remote Control

2025-10-30T15:21:59Z

Jbi: added store link for the installable version

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Reference16r1:Concept App Remote Control

2025-10-30T15:06:05Z

Jbi: update of the remote control client section

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Reference16r1:Apps/PbxManager/App Charts

2025-10-28T16:26:43Z

Jbi:

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

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

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

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

Reference16r1:Apps/PbxManager/App RemoteControl

2025-10-28T16:26:07Z

Jbi:

The Remote Control Settings plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. Services licences can also be configured. 
There is a new admin configuration panel that allows you to activate service IDs and specify which users are allowed to start a session

== Configuration ==
;IDs service
:Disabled
:Enabled ''(set by default)''
:Central ID management server (DNS name) -> ''remotecontrol.innovaphone.com (set by default)''

;Users allowed to start sessions (Fill in the "name" field, separated by a comma)
: List of users starting sessions
''Note: The &h323 name field of the user object, which is also referred to as the SIP field''

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

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

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

;Licences
:Number of purchased licences to configure (leave empty if no licenses purchased)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Remote Control]]

[[Category:Concept App Remote Control]]

Reference16r1:Apps/PbxManager/App Charts

2025-10-28T16:25:13Z

Jbi: /* Add an App */

This PBX Manager Plugin contains 1 section:
* Add, edit or delete Charts App Objects on the PBX.

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

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

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

Reference16r1:Apps/PbxManager/App RemoteControl

2025-10-28T16:24:51Z

Jbi: /* Add an App */

The Remote Control PBX Manager plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. Services licences can also be configured. 
There is a new admin configuration panel that allows you to activate service IDs and specify which users are allowed to start a session

== Configuration ==
;IDs service
:Disabled
:Enabled ''(set by default)''
:Central ID management server (DNS name) -> ''remotecontrol.innovaphone.com (set by default)''

;Users allowed to start sessions (Fill in the "name" field, separated by a comma)
: List of users starting sessions
''Note: The &h323 name field of the user object, which is also referred to as the SIP field''

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

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

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

;Licences
:Number of purchased licences to configure (leave empty if no licenses purchased)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Remote Control]]

[[Category:Concept App Remote Control]]

Reference16r1:Concept App Charts

2025-10-28T16:21:41Z

Jbi: Created page with "Apps Category:Concept App Charts {{FIXME|reason=This product is in the beta phase and is not yet finished}}  == Applies to == * Charts App == Requirements == * innovaphone PBX * innovaphone Application Platform 1300xx * v16r1 == Overview == The Charts App allows the centralised display of decentralised data — that is, data provided through the Statistics API and implemented by other ap..."

[[Category:Concept|Apps]]
[[Category:Concept App Charts]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}


== Applies to ==
* Charts App

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Reference16r1:Concept App Remote Control

2025-10-28T15:19:00Z

Jbi: /* With the Settings App - AP app installer plug-in */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference16r1:Concept App Remote Control

2025-10-28T15:17:47Z

Jbi: /* Installation */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

File:ChartsUI.png

2025-10-28T15:05:43Z

Jbi:

Reference16r1:Concept App Remote Control

2025-10-16T10:16:30Z

Jbi: /* Related Articles */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference16r1:Concept App Remote Control

2025-10-16T10:08:56Z

Jbi: /* Central ID service server */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference16r1:Concept App Remote Control

2025-10-16T09:18:17Z

Jbi: /* Included features */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference16r1:Concept App Remote Control

2025-10-16T09:06:09Z

Jbi: /* Parameters available in the UI */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Howto16r1:Firmware Upgrade V15r1 V16r1

2025-10-13T08:06:25Z

Jbi: /* Manual steps needed after upgrade */

== Applies To ==
This information applies to:

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

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

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. 

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

=== New TLS Profile ===
Please note that we have changed our TLS profiles ([[Reference16r1:IP4/General/TLS]]). The new ''Normal'' setting, which is the default value, now only allows TLS 1.3 and TLS 1.2.

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

* ''Nothing''

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

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

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

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

* App Polls: [[Reference16r1:Concept App Polls]]
* App Service Conference Transcriptions [[Reference16r1:Concept_App_Service_myApps_Assistant]]

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

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

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

* ''Nothing''

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

* ''Nothing''

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

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

Howto16r1:Firmware Upgrade V15r1 V16r1

2025-10-13T08:05:45Z

Jbi: Reverted edit by Jbi (talk) to last revision by Tfu

== Applies To ==
This information applies to:

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

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

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. 

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

=== New TLS Profile ===
Please note that we have changed our TLS profiles ([[Reference16r1:IP4/General/TLS]]). The new ''Normal'' setting, which is the default value, now only allows TLS 1.3 and TLS 1.2.

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

* ''Nothing''

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

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

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

* App Polls: [[Reference16r1:Concept App Polls]]
* App Service Conference Transcriptions [[Reference16r1:Concept_App_Service_myApps_Assistant]]

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

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

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

* ''Nothing''

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

* ''Nothing''

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

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

Howto16r1:Firmware Upgrade V15r1 V16r1

2025-10-13T08:05:01Z

Jbi: /* Manual steps needed after upgrade */

== Applies To ==
This information applies to:

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

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

== Migration Policy ==
Before you begin, be sure that your whole installation is running the latest 15r1 service release. 

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

=== New TLS Profile ===
Please note that we have changed our TLS profiles ([[Reference16r1:IP4/General/TLS]]). The new ''Normal'' setting, which is the default value, now only allows TLS 1.3 and TLS 1.2.

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

* ''Nothing''

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

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

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

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

* App Polls: [[Reference16r1:Concept App Polls]]
* App Service Conference Transcriptions [[Reference16r1:Concept_App_Service_myApps_Assistant]]

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

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

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

* ''Nothing''

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

* ''Nothing''

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

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

Reference16r1:Apps/PbxManager/App RemoteControl

2025-10-10T12:06:59Z

Jbi: /* Configuration */

The Remote Control PBX Manager plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. Services licences can also be configured. 
There is a new admin configuration panel that allows you to activate service IDs and specify which users are allowed to start a session

== Configuration ==
;IDs service
:Disabled
:Enabled ''(set by default)''
:Central ID management server (DNS name) -> ''remotecontrol.innovaphone.com (set by default)''

;Users allowed to start sessions (Fill in the "name" field, separated by a comma)
: List of users starting sessions
''Note: The &h323 name field of the user object, which is also referred to as the SIP field''

== Add an App ==
;Name
:The ''name'' displayed for the App object which must be unique. ''(The field is prefilled with "Remote Control", you can leave it as it is)''

;SIP
:The ''sip'' of the App object which must be unique.The sip-id for the App Object, which must be unique. ''(The field is prefilled with "remotecontrol", you can leave it as it is)''

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

;Licences
:Number of purchased licences to configure (leave empty if no licenses purchased)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Remote Control]]

[[Category:Concept App Remote Control]]

Reference16r1:Apps/PbxManager/App RemoteControl

2025-10-10T10:27:29Z

Jbi:

The Remote Control PBX Manager plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. Services licences can also be configured. 
There is a new admin configuration panel that allows you to activate service IDs and specify which users are allowed to start a session

== Configuration ==
;IDs service
:Disabled
:Enabled ''(set by default)''
:Central ID management server (DNS name) -> ''remotecontrol.innovaphone.com (set by default)''

;Users allowed to start sessions (Fill in the "name" field, separated by a comma)
: List of users starting sessions
''Note: The name field &h323 of the user object, which is also referred to as the SIP field''

== Add an App ==
;Name
:The ''name'' displayed for the App object which must be unique. ''(The field is prefilled with "Remote Control", you can leave it as it is)''

;SIP
:The ''sip'' of the App object which must be unique.The sip-id for the App Object, which must be unique. ''(The field is prefilled with "remotecontrol", you can leave it as it is)''

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

;Licences
:Number of purchased licences to configure (leave empty if no licenses purchased)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Remote Control]]

[[Category:Concept App Remote Control]]

Howto:Innovaphones public services

2025-10-10T10:01:20Z

Jbi:

==Applies To==
This information applies to

* All versions

==Services==
Some services or products use a data connection to the vendor system. Innovaphone will provide his services from the following IP-networks:

46.232.228.0/26
213.144.10.192/29
141.95.57.16/28
2a0f:ff00:2001:366::21/128
45.133.189.205/32

To configure your firewall accordingly, allow those entire networks as shown above.

=== STUN ===
[[Reference12r2:IP4/General/STUN|STUN Service]] for all customers
stun.innovaphone.com (udp/3478)

''Note: [http://wiki.innovaphone.com/index.php?title=Course13:IT_Advanced_2_-_07_Public_access_to_PBX_resources_%28practice%29#Media_data It is not a good idea to use innovaphone's STUN server. Although this server would yield the same results, there is no guarantee of availability. Your ISP or SIP provider's STUN should do better]''

=== TURN ===
[[Reference13r3:IP4/General/STUN#TURN_Extern |TURN fallback service ]] on port 443 for all customers
turn-fallback.innovaphone.com (tcp/443)

''Note: This TURN server shall only be used as 443 fallback server. It is not intended to be used as your [[Reference13r3:IP4/General/STUN#TURN_Servers | regular TURN server ]] as it is not designed as a primary TURN server. Do not use turn.innovaphone.com either.''

=== Provisioning ===
[[Reference13r1:Concept Provisioning|Provisioning System]] for all devices
config.innovaphone.com (tcp/http/https)

=== Push ===
[[Reference13r2:Concept_Push_Notifications_for_iOS_and_Android|Push]] for iOS, Android, Huawei and Browser Clients
push.innovaphone.com (tcp/https/wss)

=== Push legacy ===
[[Reference12r2:Concept_Push_Notifications_for_myPBX_iOS_and_Android|Legacy Push]] for iOS, Android and Huawei Clients
services.innovaphone.com (tcp/http/https/ws/wss)

''Note: [[Howto13r2:12r2/13r1 legacy push server will be migrated to push.innovaphone.com|Please migrate to the new Push Concept!]]''

=== Store ===
store.innovaphone.com (tcp/http/https)

=== Devices/Rental ===
my-app.innovaphone.com (tcp/https)

=== NTP ===
[[Reference13r1:Services/NTP|NTP Service]] for all customers
ntp.innovaphone.com (udp/123)

=== Remote Control Central ID service ===
[[Reference16r1:Concept_App_Remote_Control#Central_ID_service_server| Central ID service server]]
remotecontrol.innovaphone.com

==Certificates==
innovaphone provides a public certificate download for used public keys.

* https://download.innovaphone.com/certificates/innovaphone.pem (the current innovaphone public key which will used for example for our push service)
* https://download.innovaphone.com/certificates/ca.pem (all innovaphone Device Certification Authority public keys)
* https://download.innovaphone.com/certificates/ca-unverified.pem (all innovaphone Unverified Device Certification Authority public keys)
** The Unverified CA is used for non hardware devices, e.g. IPVAs, which are not shipped with an official innovaphone Device Certification Authority certificate, as innovaphone has no control over the serial number here.

If needed, you can trust them manually or distribute them via [[Reference14r1:Concept_App_Service_Devices#Certificates_configuration|device's configuration]].

== Related Articles ==
* [[Reference13r2:Concept_Push_Notifications_for_iOS_and_Android]]
* [[Concept Status innovaphone Services]]
* [[Reference13r1:Concept_Provisioning]]
* [[Howto:Update_innovaphone.com_Wildcard-Certificate_in_a_Device_Trustlist]]

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

Reference16r1:Concept App Remote Control

2025-10-10T09:55:25Z

Jbi:

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
{{FIXME|reason=This product is in the beta phase and is not yet finished}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=== Trace of the Remote Control Client (portable client) ===
Trace are available under (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference14r2:Apps/PbxManager/App RemoteControl

2025-10-10T09:54:25Z

Jbi:

The Remote Control PBX Manager plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. Services licences can also be configured

== Add an App ==
;Name
:The ''name'' displayed for the App object which must be unique. ''(The field is prefilled with "Remote Control", you can leave it as it is)''

;SIP
:The ''sip'' of the App object which must be unique.The sip-id for the App Object, which must be unique. ''(The field is prefilled with "remotecontrol", you can leave it as it is)''

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

;Licences
:Number of purchased licences to configure (leave empty if no licenses purchased)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Remote Control]]

[[Category:Concept App Remote Control]]

Reference14r2:Apps/PbxManager/App RemoteControl

2025-10-10T09:53:58Z

Jbi:

The Remote Control PBX Manager plug-in can be used to create and configure the required App object. In addition, the App object can be assigned to specific configuration templates, if any exist. Services licences can also be configured
There is a new admin configuration panel that allows you to activate service IDs and specify which users are allowed to start a session

== Configuration ==
;IDs service
:Disabled
:Enabled ''(set by default)''
:Central ID management server (DNS name) -> ''remotecontrol.innovaphone.com (set by default)''

;Users allowed to start sessions (Fill in the "name" field, separated by a comma)
: List of users starting sessions
''Note: The name field &h323 of the user object, which is also referred to as the SIP field''
== Add an App ==
;Name
:The ''name'' displayed for the App object which must be unique. ''(The field is prefilled with "Remote Control", you can leave it as it is)''

;SIP
:The ''sip'' of the App object which must be unique.The sip-id for the App Object, which must be unique. ''(The field is prefilled with "remotecontrol", you can leave it as it is)''

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

;Licences
:Number of purchased licences to configure (leave empty if no licenses purchased)

==Related Articles==
* [[{{NAMESPACE}}:Concept App Remote Control]]

[[Category:Concept App Remote Control]]

Howto15r1:Configure Calendar Presence Sync by Connector for Microsoft365

2025-09-18T08:37:34Z

Jbi: /* Add the admin app to a user or a template */

Howto15r1:Configure Calendar Presence Sync by Connector for Microsoft365

2025-09-18T08:34:12Z

Jbi: /* Installing and configuring App Platform and PBX */

Howto15r1:Configure User Presence Sync by Connector for Microsoft365

2025-09-18T08:34:11Z

Jbi: /* Installing and configuring App Platform and PBX */

==Applies To==
This information applies to
Connector for Microsoft 365 from version 15r1

==More Information==

This article outlines a configuration scheme for Connector for Microsoft365 functionality. 
In preparation, you first will need to configure two Applications in your Azure Portal (one for each direction). 
After that, you will install the App in your Application Platform, and configure everything.

===System Requirements===

* Licenses '''innovaphone Connector for Microsoft 365''' per user who wants to use the innovaphone myApps Connector for Microsoft 365.
* '''account in Azure Portal of Microsoft''' (for each of the technical communication users, no permission role needed) 
** Each communication user must have a Teams license applied, more infos can be found [https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/eligible-teams-licenses here] 
** Each communication user can be used to subscribe the presence of up to 650 users. (If you want to synchronize more than 650 users, you will need a multitude of communication users)
** Must '''not''' have multi factor authentication activated
* Must have access from the internet to your App Platform
** This can be done by using a reverse proxy or other firewall
* The public endpoint '''must have ''' a '''valid, public signed certificate''' (in order to make a trusted SSL connection from the Azure cloud to the Application Platform possible)
** A valid certificate is required in all involved network entities - at least in the App Platform and if used in the Reverse Proxy; to ensure transmission of MS365 HTTPS POST requests to the app service in order to send notifications.
* Admin account for Azure Portal (only necessary for granting needed permission for registered app during setup)

==Installation==

===Configuration in Azure Portal===
====Create an App for syncing Teams to PBX====

* '''In the Azure Portal of Microsoft you have to add an app registration'''
* '''You only have to give a name for the app'''

[[Image:App_Registration_Connector_for_Microsoft365.png|thumb|none|600px|App Registration]]

* '''Switch to the authentication on the left'''
* '''You only have to configure allow public client flow'''

[[Image:Authentication_Connector_for_Microsoft365.png|thumb|none|600px]]

* '''Switch to api permissions on the left'''
* '''You have to configure delegated permissions (User.Read.All and Presence.Read.All) as shown in the picture'''
* '''Grant access to the api permissions, if not possible you have to ask an admin'''

[[Image:Azure_Select_Api-Permission.png|thumb|none|600px]]

[[Image:Azure_Select_Api-Permission_Delegated.png|thumb|none|600px]]

[[Image:APIPermission_Connector_for_Microsoft365.png|thumb|none|600px]]

With these configurations you can configure the Connector for Microsoft365

* '''Client ID as shown in the picture'''
* '''Tenant ID as shown in the picture'''
* '''User'''
* '''Password'''

[[Image:Overview_Connector_for_Microsoft365.png|thumb|none|600px]]

====Create an App for syncing PBX to Teams====

* '''In the Azure Portal of Microsoft you have to add a new app registration'''
* '''In the picture you can see that we have 2 values after that which we can use for the configuration of the app'''

[[Image:Overview_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px]]

* '''Switch to Certificates & Secrets on the left'''
* '''You only have to configure a client secret and save the value for the configuration of the app'''

[[Image:Authentication_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px]]

* '''Switch to api permissions on the left'''
* '''You have to configure application permission (Presence.ReadWrite.All) as shown in the picture'''
* '''Grant access to the api permissions, if not possible you have to ask an admin'''

[[Image:Azure_Select_Api-Permission.png|thumb|none|600px]]

[[Image:Azure_Select_Api-Permission_Application.png|thumb|none|600px]]

[[Image:APIPermission_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px]]

===installation and configuration of the App ===
==== Install the App with the Settings App - AP app installer plug-in ====
[[File:Ap_app_installer.png]]

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

====Add the admin app to a user or a template====
To be able to configure the connector app, you need users to have access to the admin app. 
You can achieve this by adding the app to a user, or to a template. 
In this Howto - as an example - we will add the app to the <code>Config Admin</code> template. 
* In the Settings App
# select the <code>Templates</code> tile
# click on the <code>Config Admin</code> template
[[Image:Microsoft365_template_1.png|thumb|none|600px]]
* In the <code>Config Admin</code> template
# open Apps
# Check the <code>app name</code> checkbox
# Save the changes
[[Image:Microsoft365_template_2.png|thumb|none|600px]]

====Configure the connector with the admin app====
Now your admins (designated groups or configured user) should have access to the connector admin app. 
* A user with access to the app can now see a new tile in the '''All Apps''' area
* The name depends on the configured <code>app name</code> from the PBX Manager plugin
[[Image:Microsoft365_admin_app_1.png|thumb|none|600px]]
=====Synchronization from Teams to the PBX=====
* First you will need to configure the inbound sync from Teams to PBX
** Configuration
**# '''Master PBX''' - Set the name of your Master PBX ('''Not full DNS name, really just only the PBX name''') Good: [pbx] Bad: [pbx.domain.tld]
**# '''ClientIDSynctoPbx''' - Please insert the Application ID (Client ID) from Azure Portal from the in preparation created Teams to PBX app
**# '''TenantSynctoPbx''' - Please insert the Directory ID (Tenant) from Azure Portal from the in preparation created Teams to PBX app
**# '''Notification URL''' - You need to specify the address Microsoft can send presence updates to.
**## You need to make sure that you define a URL where you can reach your App Platform from the public internet <code>public.dns</code>
**## Next you need the domain you have configured in the app instance before (3.2.2) <code>your.domain</code>
**## Next you need the name of the instance you have configured before (3.2.2) <code>microsoft365</code>
**## The URL will always be terminated by <code>subscriptions</code>
**##* <code>https://public.dns/your.domain/microsoft365/subscriptions</code>
*** Save your changes
*** [[Image:Microsoft365_admin_app_2_14r2.png|thumb|none|600px]]
** Manage Teams accounts
**# Click on Add Teams account
**# Enter username (Azure Portal account in email format)
**# Enter password
**# Click on the check mark
**# Make sure to add an Azure Portal communication user for each 650 user you want to subscribe
*** [[Image:Microsoft365_admin_app_2_14r2_user.png|thumb|none|600px]]
* After successful configuration and subscription, the Microsoft services will connect to the specified ''Notification URL'' for presence and line state updates.
* For this to work, it is important to make sure that the specified ''Notification URL'' is reachable from the Microsoft services, meaning from the public internet.
'''It can take up to 10 Minutes until all check marks are green, and the sync is working'''

=====Synchronization from the PBX to Teams=====
* For the outbound synchronization you select from PBX to Teams in the admin app
# '''ClientIDSynctoTeams''' - Please insert the Application ID (Client ID) from Azure Portal from the in preparation created PBX to Teams app
# '''TenantSyncto Teams''' - Please insert the Directory ID (Tenand) from Azure Portal from the in preparation created PBX to Teams app
# '''ClientSecretSynctoTeams''' - Please insert the shared secret from the in preparation created PBX to Teams app
[[Image:Microsoft365_admin_app_3_14r2.png|thumb|none|600px]]
* For the sync direction from PBX to Teams, the app itself needs visibility permissions (presence, on-the-phone) for the users who are should be synced to Teams. The configuration tag is visibility for each user object.

==Related Articles==
[[Reference15r1:Concept_App_Service_Connector_for_Microsoft_365|Concept App Service Connector for Microsoft 365]] 
[[Howto15r1:Configure Calendar Presence Sync by Connector for Microsoft365]]

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

Howto15r1:Configure User Presence Sync by Connector for Microsoft365

2025-09-18T08:28:59Z

Jbi: /* Installing and configuring App Platform and PBX */

==Applies To==
This information applies to
Connector for Microsoft 365 from version 15r1

==More Information==

This article outlines a configuration scheme for Connector for Microsoft365 functionality. 
In preparation, you first will need to configure two Applications in your Azure Portal (one for each direction). 
After that, you will install the App in your Application Platform, and configure everything.

===System Requirements===

* Licenses '''innovaphone Connector for Microsoft 365''' per user who wants to use the innovaphone myApps Connector for Microsoft 365.
* '''account in Azure Portal of Microsoft''' (for each of the technical communication users, no permission role needed) 
** Each communication user must have a Teams license applied, more infos can be found [https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/eligible-teams-licenses here] 
** Each communication user can be used to subscribe the presence of up to 650 users. (If you want to synchronize more than 650 users, you will need a multitude of communication users)
** Must '''not''' have multi factor authentication activated
* Must have access from the internet to your App Platform
** This can be done by using a reverse proxy or other firewall
* The public endpoint '''must have ''' a '''valid, public signed certificate''' (in order to make a trusted SSL connection from the Azure cloud to the Application Platform possible)
** A valid certificate is required in all involved network entities - at least in the App Platform and if used in the Reverse Proxy; to ensure transmission of MS365 HTTPS POST requests to the app service in order to send notifications.
* Admin account for Azure Portal (only necessary for granting needed permission for registered app during setup)

==Installation==

===Configuration in Azure Portal===
====Create an App for syncing Teams to PBX====

* '''In the Azure Portal of Microsoft you have to add an app registration'''
* '''You only have to give a name for the app'''

[[Image:App_Registration_Connector_for_Microsoft365.png|thumb|none|600px|App Registration]]

* '''Switch to the authentication on the left'''
* '''You only have to configure allow public client flow'''

[[Image:Authentication_Connector_for_Microsoft365.png|thumb|none|600px]]

* '''Switch to api permissions on the left'''
* '''You have to configure delegated permissions (User.Read.All and Presence.Read.All) as shown in the picture'''
* '''Grant access to the api permissions, if not possible you have to ask an admin'''

[[Image:Azure_Select_Api-Permission.png|thumb|none|600px]]

[[Image:Azure_Select_Api-Permission_Delegated.png|thumb|none|600px]]

[[Image:APIPermission_Connector_for_Microsoft365.png|thumb|none|600px]]

With these configurations you can configure the Connector for Microsoft365

* '''Client ID as shown in the picture'''
* '''Tenant ID as shown in the picture'''
* '''User'''
* '''Password'''

[[Image:Overview_Connector_for_Microsoft365.png|thumb|none|600px]]

====Create an App for syncing PBX to Teams====

* '''In the Azure Portal of Microsoft you have to add a new app registration'''
* '''In the picture you can see that we have 2 values after that which we can use for the configuration of the app'''

[[Image:Overview_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px]]

* '''Switch to Certificates & Secrets on the left'''
* '''You only have to configure a client secret and save the value for the configuration of the app'''

[[Image:Authentication_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px]]

* '''Switch to api permissions on the left'''
* '''You have to configure application permission (Presence.ReadWrite.All) as shown in the picture'''
* '''Grant access to the api permissions, if not possible you have to ask an admin'''

[[Image:Azure_Select_Api-Permission.png|thumb|none|600px]]

[[Image:Azure_Select_Api-Permission_Application.png|thumb|none|600px]]

[[Image:APIPermission_Connector_for_Microsoft365_Sync_to_Teams.png|thumb|none|600px]]

===Installing and configuring App Platform and PBX===
==== Installation with the Settings App - AP app installer plug-in ====
[[File:Ap_app_installer.png]]

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

====Add the admin app to a user or a template====
To be able to configure the connector app, you need users to have access to the admin app. 
You can achieve this by adding the app to a user, or to a template. 
In this Howto - as an example - we will add the app to the <code>Config Admin</code> template. 
* In the Settings App
# select the <code>Templates</code> tile
# click on the <code>Config Admin</code> template
[[Image:Microsoft365_template_1.png|thumb|none|600px]]
* In the <code>Config Admin</code> template
# open Apps
# Check the <code>app name</code> checkbox
# Save the changes
[[Image:Microsoft365_template_2.png|thumb|none|600px]]

====Configure the connector with the admin app====
Now your admins (designated groups or configured user) should have access to the connector admin app. 
* A user with access to the app can now see a new tile in the '''All Apps''' area
* The name depends on the configured <code>app name</code> from the PBX Manager plugin
[[Image:Microsoft365_admin_app_1.png|thumb|none|600px]]
=====Synchronization from Teams to the PBX=====
* First you will need to configure the inbound sync from Teams to PBX
** Configuration
**# '''Master PBX''' - Set the name of your Master PBX ('''Not full DNS name, really just only the PBX name''') Good: [pbx] Bad: [pbx.domain.tld]
**# '''ClientIDSynctoPbx''' - Please insert the Application ID (Client ID) from Azure Portal from the in preparation created Teams to PBX app
**# '''TenantSynctoPbx''' - Please insert the Directory ID (Tenant) from Azure Portal from the in preparation created Teams to PBX app
**# '''Notification URL''' - You need to specify the address Microsoft can send presence updates to.
**## You need to make sure that you define a URL where you can reach your App Platform from the public internet <code>public.dns</code>
**## Next you need the domain you have configured in the app instance before (3.2.2) <code>your.domain</code>
**## Next you need the name of the instance you have configured before (3.2.2) <code>microsoft365</code>
**## The URL will always be terminated by <code>subscriptions</code>
**##* <code>https://public.dns/your.domain/microsoft365/subscriptions</code>
*** Save your changes
*** [[Image:Microsoft365_admin_app_2_14r2.png|thumb|none|600px]]
** Manage Teams accounts
**# Click on Add Teams account
**# Enter username (Azure Portal account in email format)
**# Enter password
**# Click on the check mark
**# Make sure to add an Azure Portal communication user for each 650 user you want to subscribe
*** [[Image:Microsoft365_admin_app_2_14r2_user.png|thumb|none|600px]]
* After successful configuration and subscription, the Microsoft services will connect to the specified ''Notification URL'' for presence and line state updates.
* For this to work, it is important to make sure that the specified ''Notification URL'' is reachable from the Microsoft services, meaning from the public internet.
'''It can take up to 10 Minutes until all check marks are green, and the sync is working'''

=====Synchronization from the PBX to Teams=====
* For the outbound synchronization you select from PBX to Teams in the admin app
# '''ClientIDSynctoTeams''' - Please insert the Application ID (Client ID) from Azure Portal from the in preparation created PBX to Teams app
# '''TenantSyncto Teams''' - Please insert the Directory ID (Tenand) from Azure Portal from the in preparation created PBX to Teams app
# '''ClientSecretSynctoTeams''' - Please insert the shared secret from the in preparation created PBX to Teams app
[[Image:Microsoft365_admin_app_3_14r2.png|thumb|none|600px]]
* For the sync direction from PBX to Teams, the app itself needs visibility permissions (presence, on-the-phone) for the users who are should be synced to Teams. The configuration tag is visibility for each user object.

==Related Articles==
[[Reference15r1:Concept_App_Service_Connector_for_Microsoft_365|Concept App Service Connector for Microsoft 365]] 
[[Howto15r1:Configure Calendar Presence Sync by Connector for Microsoft365]]

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

Reference15r1:Concept App Remote Control

2025-09-18T08:28:25Z

Jbi: /* With the Settings App - AP app installer plug-in */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
== Applies to ==
* innovaphone PBX from version 15r1
== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 130006)
* V15r1
* myApps for Windows.
* Remote Control Client for external participants '''Note : in v15r1 the Remote Control Client is only available for Windows'''

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

== Licensing ==

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

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

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

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

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

A user (viewer) sends a request to another user (sharer) to access the sharer's PC, the sharer accepts the session and begins to share their desktop with the viewer.
 The viewer is also automatically given control of the mouse and keyboard. Remote sessions are also possible between companies using myApps or not.

=== Features ===

Here are the features available in the Remote Control App

;Included features
:
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support in both directions
* Support for different keyboard layouts

;Licensed features
:
* Support with participants outside your organisation
** Between 2 different myApps installation using Remote Control App ''(e.g 2 different companies)'' via a session link.
** Without myApps with the [[Reference15r1:Concept_App_Remote_Control#With_the_Remote_Control_Client_msi_application|Remote Control Client]].
* Share/Join session
** Generate a session link from Remote Control App and share it
** Join a session by entering a link
* Multiple sessions:
**If you need more than one session (e.g many viewers for one sharer, more than one parallel session)

=== Remote Control with participants outside your organisation ===
====With the Remote Control Client external application====
The Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. ''E.g. : external participants such as your customers''. External participants see the myApps user's screen sharing.
* Client compatible with Windows only
* Easy to install, download client via a session link:
**Open the shared session link in a web browser and get the ''remoteControl.exe''
**Open the previously downloaded file on your computer
**Enter your name, info and session link ''(same link that is used to download the client)''
**Click on Join Session
''Note : from 15r1sr2 we introduced a new, lighter client that requires less effort to install and use. The new client also offers a new possibility of joining sessions with elevated admin rights for users who are not admins on their computers. ''

====With your myApps Remote Control App====
It is possible to establish a remote session between 2 organisations using myApps and having the Remote Control App installed. In the App you can also join/share a session with a link.
*Compatible only between myApps Windows clients
*Easy to use:
**User A from company "xyz.com" opens his Remote Control App in myApps and clicks on '''Share session'''
**User A copies the link and sends it to User B
**User B from company "abc.com" opens his Remote Control App in myApps, clicks on '''Join session''' and pastes the link received from User A into the '''Session link text field'''
**User A will receive a Join Session notification to accept
**User A will see User B shared session

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

=== Technical data ===
* The maximum bitrate is 1.2Mbits for the users who is sending its desktop UI. The viewer just sends mouse and keyboards events
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature
*Same port range is used by the Remote Control Client msi application

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

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

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

=== Trace of the Remote Control Client ===
Do a right click on the app try icon and click on ''open trace folder'' (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference15r1:Concept App Remote Control

2025-09-18T08:26:10Z

Jbi: /* Installation */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
== Applies to ==
* innovaphone PBX from version 15r1
== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 130006)
* V15r1
* myApps for Windows.
* Remote Control Client for external participants '''Note : in v15r1 the Remote Control Client is only available for Windows'''

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

== Licensing ==

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

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

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

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

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

A user (viewer) sends a request to another user (sharer) to access the sharer's PC, the sharer accepts the session and begins to share their desktop with the viewer.
 The viewer is also automatically given control of the mouse and keyboard. Remote sessions are also possible between companies using myApps or not.

=== Features ===

Here are the features available in the Remote Control App

;Included features
:
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support in both directions
* Support for different keyboard layouts

;Licensed features
:
* Support with participants outside your organisation
** Between 2 different myApps installation using Remote Control App ''(e.g 2 different companies)'' via a session link.
** Without myApps with the [[Reference15r1:Concept_App_Remote_Control#With_the_Remote_Control_Client_msi_application|Remote Control Client]].
* Share/Join session
** Generate a session link from Remote Control App and share it
** Join a session by entering a link
* Multiple sessions:
**If you need more than one session (e.g many viewers for one sharer, more than one parallel session)

=== Remote Control with participants outside your organisation ===
====With the Remote Control Client external application====
The Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. ''E.g. : external participants such as your customers''. External participants see the myApps user's screen sharing.
* Client compatible with Windows only
* Easy to install, download client via a session link:
**Open the shared session link in a web browser and get the ''remoteControl.exe''
**Open the previously downloaded file on your computer
**Enter your name, info and session link ''(same link that is used to download the client)''
**Click on Join Session
''Note : from 15r1sr2 we introduced a new, lighter client that requires less effort to install and use. The new client also offers a new possibility of joining sessions with elevated admin rights for users who are not admins on their computers. ''

====With your myApps Remote Control App====
It is possible to establish a remote session between 2 organisations using myApps and having the Remote Control App installed. In the App you can also join/share a session with a link.
*Compatible only between myApps Windows clients
*Easy to use:
**User A from company "xyz.com" opens his Remote Control App in myApps and clicks on '''Share session'''
**User A copies the link and sends it to User B
**User B from company "abc.com" opens his Remote Control App in myApps, clicks on '''Join session''' and pastes the link received from User A into the '''Session link text field'''
**User A will receive a Join Session notification to accept
**User A will see User B shared session

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

=== Technical data ===
* The maximum bitrate is 1.2Mbits for the users who is sending its desktop UI. The viewer just sends mouse and keyboards events
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature
*Same port range is used by the Remote Control Client msi application

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

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

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

=== Trace of the Remote Control Client ===
Do a right click on the app try icon and click on ''open trace folder'' (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Howto:Yealink IP phones - Yealink - 3rd Party Product

2025-07-11T08:06:39Z

Jbi: /* Special feature configuration */

[[Image:YealinkLogo.png||200px|right]]

==Product Name==


[https://www.yealink.com/en/product-list/ip-phone Yealink IP iphones]

==Certification Status==

{{Template:Compat_Status_referral_terminals|manufacturername=Yealink Network Technology Ltd|certificationdate=in April 2020}}

==Category==


[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Terminal_Devices}}
[[Category:3rdParty_Terminal_Devices|{{PAGENAME}}]]

==Vendor==



[[Image:YealinkLogo.png|150px]]

About us 

Yealink Network Technology Ltd. is a professional designer and manufacturer of innovative, affordable, and high-quality IP voice and video products for the worldwide broadband telephony market. The company's products are fully compatible with the SIP industry standard, field-proven with a large and rapidly growing deployed base, and also have broad interoperability with the major IP-PBX, IMS, NGN, soft-switch and other third-party SIP products on the market today. Until now, Yealink has risen to be the #1 SIP Phone provider in the World, the data from FROST&SULLIVAN
[https://www.yealink.com/about.html More About Yealink]

[[Image:Data2020.png]]

==Description==
<table>
<tr>
<td colspan=4>Desk phones</td>
</tr>
<tr>
<td colspan=4>T3 Series</td>
</tr>
<tr>
<td>T31P [[Image:Yealink_T31.png]]</td>
<td>T31G [[Image:Yealink_T31.png]]</td>
<td>T33G [[Image:Yealink_T33G.png]]</td>
</tr>
<tr>
<td>
Yealink T31P is a very fashionable and friendly entry-level IP phone 
- 2.3” 132x64-pixel graphical LCD with back light 
- 2 line keys with LED 
- 4 context-sensitive “soft” keys 
- Up to 2 SIP accounts 
- Opus codec support 
- Yealink Optima HD voice 
- PoE support 
- Headset, EHS support 
[https://support.yealink.com/en/portal/knowledge/show?id=649250866a27da76bd070103 T31P datasheet]
</td>
<td>
Yealink T31G is a very fashionable and friendly entry-level IP phone 
- 2.3” 132x64-pixel graphical LCD with back light 
- 2 line keys with LED 
- 4 context-sensitive “soft” keys 
- Up to 2 SIP accounts 
- Opus codec support 
- Yealink Optima HD voice 
- Dual-port Gigabit Ethernet 
- PoE support 
- Headset, EHS support 
[https://support.yealink.com/en/portal/knowledge/show?id=649250866a27da76bd070105 T31G datasheet]
</td>
<td>
Yealink T33G is an entry-level color screen IP phone with high performance 
- 2.4” 320 x 240-pixel color display with backlight 
- 4 line keys with LED 
- 4 context-sensitive “soft” keys 
- Up to 4 SIP accounts 
- Opus codec support 
- Dual-port Gigabit Ethernet 
- PoE support 
- Headset, EHS support 
[https://support.yealink.com/en/portal/knowledge/show?id=649250866a27da76bd07010d T33G datasheet]
</td>
</tr>
<tr>
<td colspan=4>T4S Series</td>
</tr>
<tr>
<td>T41S [[Image:Yealink_T41S.png]]</td>
<td>T42S [[Image:Yealink_T42S.png]]</td>
<td>T46S [[Image:Yealink_T46S.png]]</td>
<td>T48S [[Image:Yealink_T48S.png]]</td>
</tr>
<tr>
<td>
The SIP-T41S is a feature-rich business tool for superior communications and extended functionality. It offers a faster,more-responsive interface than the T41P and several performance-enhancing functions. 
- 2.7" 192x64-pixel graphical LCD with backlight 
- 6 line keys with LED 
- 4 context-sensitive “soft” keys 
- Up to 6 SIP accounts 
- Opus codec support 
- Dual-port Gigabit Ethernet 
- USB 2.0 
- PoE support 
- Headset, EHS support 
[https://www.yealink.com/upfiles/products/201809/1538272324363.pdf T41S datasheet]
</td>
<td>
The SIP-T42S IP phone is a dynamic business communications tool for superior voice communications and extended functionality. 
- 2.7" 192x64-pixel graphical LCD with backlight 
- 6 line keys with LED 
- 4 context-sensitive “soft” keys 
- Up to 12 SIP accounts 
- Opus codec support 
- Dual-port Gigabit Ethernet 
- USB 2.0 
- PoE support 
- Headset, EHS support 
- Corded-Cordless Phone (via DECT Dongle DD10K) 
[https://www.yealink.com/upfiles/products/201809/1538272294040.pdf T42S datasheet]
</td>
<td>
The SIP-T46S IP phone is the ultimate communications tool for busy executives and professionals. 
- 4.3" 480 x 272-pixel color display with backlight 
- 10 line keys with LED 
- 4 context-sensitive “soft” keys 
- Up to 16 SIP accounts 
- Opus codec support 
- Dual-port Gigabit Ethernet 
- USB 2.0 
- PoE support 
- BHeadset, EHS support 
[https://www.yealink.com/upfiles/products/201809/1538272263127.pdf T46S datasheet]
</td>
<td>
The SIP-T48S IP Phone is a dynamic business communications solution for executives and professionals. 
- 7" 800 x 480-pixel color touch screen with backlight 
- 29 one-touch DSS keys 
- 6 navigation keys 
- Up to 16 SIP accounts 
- Opus codec support 
- Dual-port Gigabit Ethernet 
- USB 2.0 
- PoE support 
- Headset, EHS support 
[https://www.yealink.com/upfiles/products/201809/1538272213388.pdf T48S datasheet]
</td>
</tr>
<tr>
<td>T5 Series</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>T53 [[Image:Yealink_T53.png]]</td>
<td>T53W [[Image:Yealink_T53W.png]]</td>
<td>T54W [[Image:Yealink_T54W.png]]</td>
<td>T57W [[Image:Yealink_T57W.png‎]]</td>
<td>T58W [[Image:Yealink_T58W.png]]</td>
<td>VP59 [[Image:Yealink_VP59.png]]</td>
</tr>
<tr>
<td>
Especially designed for busy executives and professionals, Yealink SIP-T53 is an easy-to-use Prime Business Phone with an adjustable 3.7-inch graphical LCD 
- 3.7" 360x160-pixel graphical LCD with backlight 
- Adjustable LCD screen 
- Bluetooth via BT40 
- Wi-Fi via WF40/WF50 
- USB 2.0 port for USB recording 
- Up to 12 VoIP accounts 
- Dual-port Gigabit Ethernet 
- PoE support 
- HAC Handset 
[https://support.yealink.com/en/portal/knowledge/show?id=649250866a27da76bd070122 T53 datasheet]
</td>
<td>
Especially designed for busy executives and professionals, Yealink SIP-T53W is an easy-to-use Prime Business Phone with an adjustable 3.7-inch graphical LCD 
- 3.7" 360x160-pixel graphical LCD with backlight 
- Adjustable LCD screen 
- Built-in Bluetooth 4.2 
- Built-in dual band 2.4G/5G Wi-Fi(802.11a/b/g/n/ac) 
- USB 2.0 port for USB recording 
- Up to 12 VoIP accounts 
- Dual-port Gigabit Ethernet 
- PoE support 
- HAC Handset 
[https://support.yealink.com/en/portal/knowledge/show?id=649250866a27da76bd070125 T53W datasheet]
</td>
<td>
Especially designed for busy executives and professionals, Yealink SIP-T54W is an easy-to-use Prime Business Phone with an adjustable 4.3-inch color LCD screen 
- 4.3" 480 x 272-pixel color display with backlight 
- Adjustable LCD screen 
- Built-in Bluetooth 4.2 
- Built-in dual band 2.4G/5G Wi-Fi(802.11a/b/g/n/ac) 
- USB 2.0 port for USB recording 
- Up to 16 VoIP accounts 
- Dual-port Gigabit Ethernet 
- PoE support 
- HAC Handset 
- Corded-Cordless Phone (via DECT Dongle DD10K) 
[https://support.yealink.com/en/portal/knowledge/show?id=649250876a27da76bd070128 T54W datasheet]
</td>
<td>
Especially designed for busy executives and professionals, Yealink SIP-T57W is an easy-to-use Prime Business Phone with an adjustable 7-inch multi-point touch screen 
- 7” 800 x 480 capacitive adjustable touch screen 
- Adjustable LCD screen 
- Built-in Bluetooth 4.2 
- Built-in dual band 2.4G/5G Wi-Fi(802.11a/b/g/n/ac) 
- USB 2.0 port for USB recording 
- Up to 16 VoIP accounts 
- Dual-port Gigabit Ethernet 
- PoE support 
- HAC Handset 
[https://support.yealink.com/en/portal/knowledge/show?id=649250876a27da76bd07012b T57W datasheet]
</td>
<td>
The Yealink SIP-T58W is a simple-to-use smart business phone that provides an enriched HD audio and video calling experience for business professionals. 
- 7” 1024 x 600 capacitive adjustable touch screen 
- Dual-port Gigabit Ethernet 
- PoE support 
- Opus codec support 
- Up to 16 SIP account 
- Up to 4 DECT cordless handsets(DD10K Dongle) 
- Bluetooth Handset BTH58 
- USB port for CAM50 camera 
- Android OS 
- Door phone integration 
[https://support.yealink.com/en/portal/knowledge/show?id=649250876a27da76bd070137 T58W datasheet]
</td>
<td>
The Yealink flagship smart video phone VP59 is designed for executives and teleworkers that strikes the perfect balance between simplicity and sophistication, enabling high quality communications for business executives and professionals alike. 
- 8" 1280 x 800 capacitive touch screen IPS LCD 
- Dual-port Gigabit Ethernet 
- 1 x HDMI output port 
- Opus codec support 
- Up to 16 SIP accounts 
- Door phone integration 
- Adjustable camera 
- Up to 4 DECT cordless handsets 
[https://support.yealink.com/en/portal/knowledge/show?id=649250876a27da76bd070142 VP59 datasheet]
</td>
</tr>
<tr>
<td>DECT System</td>
</tr>
<tr>
<td>W70B [[Image:Yealink W70B.png]]</td>
<td>W80DM/W80B [[Image:Yealink W80B.png]]</td>
<td>W90DM/W90B [[Image:Yealink W90B.png]]</td>
<td>W73H [[Image:Yealink W73H.png]]</td>
<td>W56H [[Image:Yealink W56H.png]]</td>
<td>W78H [[Image:Yealink W78H.png]]</td>
</tr>
<tr>
<td>
The Yealink W70B is the DECT IP base station for small and medium-sized businesses. 
- Up to 10 handsets/DECT headsets 
- Up to 20 simultaneous calls 
- Up to 10 SIP accounts 
- Up to 6 repeaters per base station (RT30) 
- No Perception Upgrade 
- 3-way conference 
- DECT radio coverage up to 50m indoors and 300m outdoors 
- Support Opus 
- Support PoE 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b565d5 W70B datasheet]
</td>
<td>
The Yealink W80 DECT IP Multi-Cell System, consisting of a base station W80B and a DECT Manager W80DM, is designed to provide organizations requiring wireless coverage with the full ease of deployment. 
- Seamless handover and roaming 
- Up to 100 parallel calls 
- Up to 30 base stations 
- Up to 100 handsets 
- Up to 100 SIP accounts 
- Support XML/LDAP/Remote Phonebook 
- DECT radio coverage up to 50m indoors and 300m outdoors 
- Support Opus 
- Support PoE 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b565dd W80DM/W80B datasheet]
</td>
<td>
The Yealink W90 DECT IP Multi-Cell System, consisting of three elements - a Virtual Integrator Manager (optional), a DECT Manager W90DM and a base station W90B, is designed to provide the organizations who require wireless coverage with the full ease of deployment. 
- Sync over the air and LAN (Seamless handover and roaming) 
- External antennas 
- Each W90 Multi-Cell System: 
Up to 60 base stations 
Up to 250 handsets 
Up to 250 VoIP accounts 
Up to 250 simultaneous calls 
- Each VIM Ststem: 
Up to 10 DM 
Up to 600 base stations 
Up to 2500 handsets 
Up to 2500 VoIP accounts 
Up to 2500 simultaneous calls 
[https://www.yealink.com/upfiles/products/201809/1538271168263.pdf W90DM/W90B datasheet]
</td>
<td>
The Yealink W73H is the new generation of stylish modern wireless handsets designed for business use with a new ID design that is more sleek and convenient to carry. 
- 1.8’’ 128x160 TFT color screen 
- Up to 2 simultaneous calls per handset 
- 3-way conference 
- OTA (Over-The-Air) upgrade 
- FNR (Flexible Noise Reduction)/Noise Cancellation 
- Handset Size: 144.5 mm x 48 mm x 21 mm 
- Up to 35 hours of talk time (in ideal conditions) 
- Up to 400 hours of standby time (in ideal conditions) 
- Headset jack (3.5 mm) 
- Hearing Aid Compatibility (HAC) compliant 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b565fd W73H datasheet]
</td>
<td>
The Yealink W56H is the next-generation wireless handset designed for business use with excellent battery life and high compatibility. 
- 2.4’’ 240x320 pixels color display 
- Up to 2 simultaneous calls per handset 
- 3-way conference 
- OTA (Over-The-Air) upgrade 
- Handset Size: 175 mm x 53 mm x 20.3 mm 
- Up to 30 hours of talk time (in ideal conditions) 
- Up to 400 hours of standby time (in ideal conditions) 
- Headset jack (3.5 mm) 
- Hearing Aid Compatibility (HAC) compliant 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b565f9 W56H datasheet]
</td>
<td>
Yealink W78H is a high-end, modern, stylish wireless handset with a 2.4’’ screen for business use. Its new ID design makes it more sleek, convenient, and durable. 
- 2.4’’ 240 x 320 TFT color screen 
- Up to 2 simultaneous calls per handset 
- 3-way conference 
- OTA (Over-The-Air) upgrade 
- FNR (Flexible Noise Reduction)/Noise Cancellation 
- Handset Size: 151 mm x 49.5 mm x 21 mm 
- Up to 21 hours of talk time (in ideal conditions) 
- Up to 166 hours of standby time (in ideal conditions) 
- Headset jack (3.5 mm) 
- Quick charging: 10-minute charging time for 2-hour talking time 
- Bluetooth 5.1 
- Vibration alarm 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b56601 W78H datasheet]
</td>
</tr>
<tr>
<td>DECT System</td>
</tr>
<tr>
<td>W57R [[Image:Yealink W57R.png]]</td>
<td>W59R [[Image:Yealink W59R.png]]</td>
</tr>
<tr>
<td>
Yealink W57R, certified to rigorous IP54 standard, is a professional ruggedized DECT handset with an integrated vibration alarm that is pretty eligible for the environment where there may be dusty, humid, and harsh. 
- 1.8’’ 128x160 TFT color screen 
- Up to 2 simultaneous calls per handset 
- 3-way conference 
- OTA (Over-The-Air) upgrade 
- FNR (Flexible Noise Reduction)/Noise Cancellation 
- Handset Size: 157 mm x 51 mm x 24 mm 
- Up to 40 hours of talk time (in ideal conditions) 
- Up to 575 hours of standby time (in ideal conditions) 
- Rugged DECT handset with IP54 protection rating 
- Scratch resistant, disinfectant resistant 
- Quick charging: 10-minute charging time for 2-hour talking time 
- Vibration alarm 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b565ea W57R datasheet]
</td>
<td>
Yealink W59R, certified to rigorous IP67 standard, is a professional ruggedized DECT handset with integrated Bluetooth and vibration alarm that is pretty eligible for the environment where there may be dusty, humid, and harsh. 
- 1.8’’ 128x160 TFT color screen 
- Up to 2 simultaneous calls per handset 
- 3-way conference 
- OTA (Over-The-Air) upgrade 
- FNR (Flexible Noise Reduction)/Noise Cancellation 
- Handset Size: 157 mm x 51 mm x 24 mm 
- Up to 28 hours of talk time (in ideal conditions) 
- Up to 360 hours of standby time (in ideal conditions) 
- Rugged DECT handset with IP67 protection rating 
- Scratch resistant, disinfectant resistant 
- Quick charging: 10-minute charging time for 2-hour talking time 
- Vibration alarm 
- Alarm functions: push-button/no-movement/man-down/running 
- Bluetooth 4.2 
[https://support.yealink.com/en/portal/knowledge/show?id=6458b6d6b1fa936c57b565f1 W59R datasheet]
</td>
</tr>
<tr>
<td>Conference Phone</td>
</tr>
<tr>
<td>CP925 [[Image:Yealink CP925.png]]</td>
<td>CP935W [[Image:Yealink CP935W.png]]</td>
<td>CP965 [[Image:Yealink CP965.png]]</td>
</tr>
<tr>
<td>
Yealink designs its audio conferencing solutions to suit a range of different meeting environments. 
- 4” 480x800 capacitive touch screen 
- Optimal HD audio, full duplex technology 
- Yealink Noise Proof Technology 
- 20-foot (6-meter) microphone pickup range 
- Built-in 6-microphone array, 360-degree voice pickup 
- Power over Ethernet 
- 5-way conference call 
- Hybrid UC meeting 
- Wi-Fi 
- Bluetooth 4.2 
- 1 x USB 2.0 Type-C device port 
[https://support.yealink.com/en/portal/knowledge/show?id=649250876a27da76bd070148 CP925 datasheet]
</td>
<td>
Yealink CP935W is a wireless touch-sensitive HD conference phone designed for small to medium conference room. 
- 4” 480x800 capacitive touch screen 
- Optimal HD audio, full duplex technology 
- Yealink Noise Proof Technology 
- 20-foot (6-meter) microphone pickup range 
- Built-in 6-microphone array, 360-degree voice pickup 
- Battery capacity: 7800mAH 
Up to 75 hours standby time in Wi-Fi mode (in ideal conditions) 
Up to 15 hours talk time (in ideal conditions) 
- 5-way conference call 
- Hybrid UC meeting 
- Wi-Fi 
- Bluetooth 4.2 
- 1 x USB 2.0 Type-C device port 
- DECT deployment 
[https://support.yealink.com/en/portal/knowledge/show?id=64b502595b323b55e7a981f5 CP935W datasheet]
</td>
<td>
Yealink CP965 is designed for medium and large-sized conference rooms. Based on Android 9.0 system, it is a flagship HD conference phone with powerful voice conferencing features and easy control operation. 
- 5” 720x1280 capacitive touch screen 
- Optimal HD audio, full duplex technology 
- Yealink Noise Proof Technology 
- 13ft (4m) high-quality voice pickup range Maximum 20ft (6m) voice pickup range 
- Built-in 12-microphone array, 360-degree voice pickup 
- Two expansion microphones for each CP965 
- 5-way conference call 
- Hybrid UC meeting 
- Wi-Fi 
- Bluetooth 4.2 
- 1 x USB 2.0 Type-A device port 
- 1 x USB 2.0 Type-C device port 
[https://support.yealink.com/en/portal/knowledge/show?id=649250876a27da76bd07014b CP965 datasheet]
</td>
</tr>
</table>

==Functions==




* Initiate outgoing call yes
* Answer incoming call yes
* Hold/Retrieve yes
* Transfer yes
* Call waiting yes
* Do not disturb yes
* Call Conference yes
* Call Park yes
* Voice Messages Center
* Call Forward and divert yes
* Intercom (HS to HS)
* Called, calling, and connected party information yes
* Missed-call notification yes
* 1-touch speed dial yes
* Redial yes
* Zero touch provisioning, management, configuration and remote debugging yes
* SIP NATPR yes
* Background Upgrades yes
* Dynamic Search of Network Based Directory yes
* BLF yes

==innovaphone CTI ready==



==innovaphone Reverse Proxy ready==

* STUN yes
* TURN yes
* ICE yes

Note: no more necessary starting with [[Reference13r3:Concept_Third_Party_Phones|innovaphone version 13r3]]

* SIP/TCP yes
* SIP/TLS yes

==innovaphone WebRTC ready==



==Supported Codecs==

* G.722 yes
* G.711 A-law yes (except W60P)
* G.711 y-law yes (except W60P)
* G.723.1 yes (except IP-T40G)
* G.729A yes
* Opus yes

==DTMF Support==


* SIP v1 (RFC2543), v2 (RFC3261)
* DTMF: In-band, Out-of-band(RFC 2833) and SIP INFO

==Supports RFC3261 Digest Authentication Scheme (Section 22.4)==

* Supports RFC3261 Digest Authentication Scheme (Section 22.4) yes

==Support LDAP Phonebook==

* Support LDAP Phonebook yes
{{3rd Pty Terminal Contacts}}

==Version==




Product versions used for interop testing:

* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=2b4aca35e7524741 T3X 124.86.0.147]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=24a5fa2d469a4634 T4XS 66.86.0.81]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=b8ee3f39ed334b9a T4U 108.86.0.147]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=e670f45ec9d2459b T5X 96.86.0.147]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=fdb31e75a3644ca3 W70B 146.85.0.82]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=a6c867494e9144a7 W80DM 103.85.0.53]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=577da53831f94be0 W80B 103.85.0.53]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=869733db8f25479f W90DM/B 130.85.0.86]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=46ef545a80894d14 W73H 116.85.0.61]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=eab90a14035040f3 W56H 61.85.0.84]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=5bd270416a4646bd W78H 16.85.0.29]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=24f9ec09bb2c48b8 W57R 118.85.0.26]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=fc8734d0dc664404 W59R 115.85.0.84]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=fe90072f7cc84457 CP925 148.86.0.38]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=5036192e02f5415a CP935W 149.86.0.37]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=3cfc11750acd40f0 CP935W DDPhone 149.86.0.37]
* [https://support.yealink.com/support-service/attachment/downLoadFile?fileCode=15ebb35cfb7f433d CP965 143.86.0.46]

==Configuration==

'''Note''': Following steps apply only if not provisioned by use of the [[Reference13r1:Concept_App_Service_Yealink|innovaphone Yealink provisioning application]] or [[Howto:Deploy Yealink Devices on myApps]].

Yealink IP phone supports multiple configurations
Phone Web Configuration:
a. Press “Ok” Buttom when your phone on idle interface, you can get the IP address of the phone, input it to your PC browser.
b. The factory account password of the telephone is admin/admin. Then you can enter the Phone Configuration Interface
1.Login to phone web portal:
[[Image:login.png]]
2.Network setting:
[[Image:network.png]]
3.Account setting：
[[Image:account.png]]
4.Server setting
[[Image:server setting.png]]
5.Register successful:
[[Image:registered.png]]
Use configuration files:
Yealink phones can be deployed locally or remotely by creating a CFG file and importing the phones in different ways. Details can be found in the following links:
http://support.yealink.com/forward2download?path=ZIjHOJbWuW/DFrGTLnGypuWyg0RhC93gYEIbLjMU7E1BroZ4Bf7cS0eTeIfu0tgucplusSymbolsLktV2ZhhsqOnJ/tuBaslD7h0DspvD1CaR5Vz9n04/6LylDzplusSymbolA7plusSymbollbu7/ra/qMQLBLDplusSymbolaaAplusSymbol6s7YAAeSchu8igST0k5vGL
Configuration file template
As we said before, you can create a CFG file and import it to your phone to make all setting done. And here is an example for your reference:
<pre>
#!version:1.0.0.1
account.1.auth_name = Yealink-1
account.1.display_name = Yealink-1
account.1.enable = 1
account.1.label = Yealink-1
account.1.nat.nat_traversal = 1
account.1.outbound_proxy.1.address = sip1.xxxx.info
account.1.outbound_proxy_enable = 1
account.1.sip_server.1.address = sip1.xxxx.info
account.1.sip_server.1.transport_type = 1
account.1.user_name = 121
account.1.password = (your password)

### Recommended Opening ###
account.1.use_real_remote_in_dialog.enable=1
account.1.hold_use_inactive=1
account.1.dtmf.type=2

### Static Configuration ###
static.ice.enable = 1
static.sip.nat_stun.enable = 1
static.sip.nat_stun.server = stun.xxxx.info
static.sip.nat_turn.enable = 1
static.sip.nat_turn.server = turn.xxxx.info
static.sip.nat_turn.username = turn4sip
static.sip.nat_turn.password = (your password)
</pre>
Any question please contact us
Support: http://support.yealink.com
Ticket: https://ticket.yealink.com

=== Special feature configuration ===
{{Template:3rd Party Input}}
''' Music on Hold / MoH '''
* Requirement: Use innovaphone-PBX-built-in MoH in case of call-hold etc.
* Applies to: T54W series, FW 96.86.0.70
* Required configuration:
** Webinterface: Section Header General Information, Option RFC 2543 Hold
** Configuration file option: <pre>sip.rfc2543_hold = 1</pre>

''' BLF '''
* For innovaphone PBX configuration settings, refer to this [[Howto:Busy_lamp_field_(partner_keys)_with_SIP_phones|this article]]

'''MOH'''
* Another approach is to use this option to make the MOH works when pressed from yealink phone (tested with T58W)
<code>
!config add SIP /take-sendonly-as-inactive 
!config activate 
!config write 
</code>
Restart the unit afterwards

==Summary==



==Contact==



{|
| Company Name: || Yealink Network Technology Ltd.
|-
| Street: || No.666 Hu'an Road High Tech Park, Huli District Xiamen, Fujian China
|-
| ZIP/City: || Xiamen,361009
|-
| Country: || China
|-
| Phone: || 0086-592-5702000
|-
| Mail: || [mailto:sales@yealink.com sales@yealink.com]
|-
| Support: || [https://ticket.yealink.com Yealink Technical Support]
|}

Reference14r1:Concept App Service Reports

2025-07-03T10:15:48Z

Jbi: /* CSV, XML or PDF export */

[[Category:Concept|Apps]]

The App Service Reporting is an App Service which can be installed on an innovaphone App Platform. It is used to provide call lists in myApps and to create call reports.

== Applies To ==

* innovaphone PBX from version 13r1

== Technical Overview ==
[[Image:Concept_reporting.png]]

== Apps ==

=== Reports App (innovaphone-reporting) ===
This is the Reporting UI App.

[[File:Reference14r1_Concept_App_Service_Reports_App.png|600px]]

Legend of used symbols:

[[Image:Reporting_symbol_legend.png]]

You can display all or filtered calls and sort them by time, name, call and alert duration.
The amount of displayed entries in the UI is limited to 10000.

Parameters:

;Websocket:

=== Call List App (innovaphone-calllist) ===
This is the Call list App.

Parameters:

;Websocket:

=== Call List API (innovaphone-calllist-api) ===
This is an App, which provides the Call list API (com.innovaphone.calllist). This API can be used to find the recent calls of a user.

Parameters:

;Websocket:

== PBX Manager Plugins ==

=== Reporting ===

With the Reporting plugin App objects can be created, edited and deleted for the provided Apps.

====Configuration====

Following configuration options are offered:

* CDR handling
** automatic deletion of CDRs
** deletion interval - default is 90 days. If configured, deletion is performed at 3 a.m. UTC.

* Account for CDR authentication

* Account for authentication for external apps (When username and password are defined external app will be able to fetch PDF,XML or CSV report with HTTP GET requests using HTTP Authentication.)

* SMTP Configuration
When reports should be send by email the SMTP Server address and the login credentials must be specified. An example configuration can be seen on the screen shot.
 
 
[[File:Reference14r1_Concept_App_Service_PBX-Manager-Plugin.png|400px|SMTP Configuration]]

== Concepts ==
===Database Structure===

====cdrs====
The service receives CDRs in XML format at the URL http://AP-IP/DOMAIN/reporting/cdr . That URL must be configured at the PBX.

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

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

* '''cdr fields:'''
** id
** guid
** user_guid
** conf
** sys
** pbx
** node
** phys
** device
** h323
** e164
** cn
** dn
** email
** dir
** external
** licensed
** more_calls: set inside the CDR XML if there are multiple calls for the same call and user (e.g. multiple registrations)
** conn_duration
** alert_duration
** call_duration
** billing_duration
** utc_stamp: unix timestamp in '''milliseconds''' since 1970
** cause
** remote_e164
** remote_h323
** remote_dn
** call_list: CDR which is suitable for calllist or report queries (this flag is set depending on data received inside a CDR)
** missed_call
** status: the final state of the CDR (co: connected, al: alerting, er: error, bu: busy)
** further: flag is set if CDR has been cancelled with cause 26 (non selected user clearing) indicating that there will be another more suitable CDR for the same call
** user_id
** callback_e164
** callback_h323
** callback_dn
** callback_time
** remote_clir: this flag is set if the remote side suppresses the calling information (number, name etc.)

* '''event fields:'''
** id
** cdr_id
** msg
** ext
** e164
** h323
** dn
** conf
** cause
** time: the kernel uptime of the sending gateway in seconds. Substract time from a newer event (higher id) of a previous event to get the elapsed seconds inbetween.
** clir

* '''group fields:'''
** id
** name
** active
** type
** cdr_id

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

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

The table cdrp_properties from version 10 has been removed. Most columns can be now found directly in the table cdrs.
If you need the callflow in a similar way, you can JOIN the events table (GROUP BY cdr_id) and run a query which creates an array string from the events table:

array_agg(array[ev.msg, COALESCE(ev.e164,''), COALESCE(ev.h323,''), COALESCE(ev.dn,'')] ORDER BY ev.id) AS callflow

====cdr_users====

This table contains a timestamp '''missed_calls_time''' for the last call list access by a user '''sip'''. It is used to retrieve information about missed calls since the last use of mypbx/myApps. 
The timestamp '''clear_report_time''' indicates the last clearance time. 

===Database query samples===

====Calllist query====

SELECT cdr.id, cdr.cn, cdr.conf, dir, external, alert_duration, call_duration, conn_duration, billing_duration,
sys, pbx, node, phys, cdr.cause, utc_stamp, status, further,
CASE WHEN remote_clir THEN <nowiki>''</nowiki> ELSE remote_e164 END,
CASE WHEN remote_clir THEN <nowiki>''</nowiki> ELSE remote_h323 END,
CASE WHEN remote_clir THEN <nowiki>''</nowiki> ELSE remote_dn END,
callback_e164, callback_h323, callback_dn, callback_time, cdr.e164, cdr.h323
FROM cdrs cdr
JOIN cdr_users cu ON cdr.user_id = cu.id
WHERE cu.cn NOT IN ('_ADMIN_','_KADMIN_','_EXTERN_','_UNKNOWN_','_MASTER_','_STANDBY_','_ACTIVE_','_MOH_','_HTTP_','_CONF_') AND (cu.sip = 'sip' OR cu.guid = '00000000000000000000000000000000')
AND cdr.call_list = true
AND (cu.clear_report_time IS NULL OR utc_stamp > cu.clear_report_time)
ORDER BY utc_stamp DESC, cdr.id DESC LIMIT '5' OFFSET '0'

====Reporting query====

WITH inp AS (SELECT 1611187200000::BIGINT AS from, 1611211143042::BIGINT AS to, 'sip'::VARCHAR AS sip, 'cn'::VARCHAR AS cn, 'TRUE'::BOOLEAN AS check_objects)
SELECT cdr.id, cdr.cn, cdr.conf, dir, external, alert_duration, call_duration, conn_duration,
billing_duration, sys, pbx, node, phys, cdr.cause, utc_stamp, status, further, remote_e164,
remote_h323, remote_dn, callback_e164, callback_h323, callback_dn, callback_time, cdr.e164,
cdr.h323, cdr.dn,
array_agg(array[ev.msg, COALESCE(ev.e164,<nowiki>''</nowiki>), COALESCE(ev.h323,<nowiki>''</nowiki>), COALESCE(ev.dn,<nowiki>''</nowiki>), 'false'] ORDER BY ev.id)
FROM inp, cdrs cdr
JOIN cdr_users cu ON cdr.user_id = cu.id
JOIN events ev ON ev.cdr_id = cdr.id
WHERE cdr.call_list = true
AND cdr.licensed = true
AND utc_stamp >= inp.from
AND utc_stamp < inp.to
AND (inp.check_objects=false OR LOWER(cu.sip) LIKE LOWER(inp.sip) OR LOWER(cu.cn) LIKE LOWER(inp.cn))
GROUP BY cdr.id
ORDER BY utc_stamp ASC
LIMIT 10000

=== Database access ===

You have to grant [[Reference14r1:Concept_App_Platform#Database|database access]] in the AP-Platform.
 
The database user and password can be configured for every Reporting instance inside the AP Manager if you edit the instance. 
These database credentials are just used internally and not e.g. inside the PBX App Objects.

==== Write an own app ====

Currently there can be two ways for an own App:

* You receive the CDRs from the CDR interfaces yourself and store them into your own database with your own structure.
* You hand the Reporting database credentials to your own App and connect directly to the Reporting database within your own App. This saves you the parsing and storing of the data, but you must maintain your queries if something in the Reporting database is changed. It is important, that you should just access this data '''readonly''' and that you do '''not modify''' table data!

Example for automatic download of existing CSV files:

#establish a web socket connection for reporting using [[Reference13r2:Concept_Talking_to_the_v13_Application_Platform_using_PHP | PHP ]]
#request the session key with { "mt": "Start" }
#receive the session key which e.g. looks like {"mt": "StartResult", "session": "189", "key": "552ca6fe05a19"}
#while the web socket connection is established, a GET request using received data can be sent like this:
#*<nowiki>http://AP-IP/DOMAIN/reporting/reports/report-20200408-1015.csv?session=189&key=552ca6fe05a19&lang=de&tz=Europe/Berlin&type=csv&sip=&from=1586304000000&to=1586333749607</nowiki>

==== Remote Interface ====

You can retrieve the PDF/XML/CSV report with a remote interface. After the configuration in the PBX Manager Plugin (Set user name and password under '''[[Reference14r1:Apps/PbxManager/App_Reports#Account_for_external_applications| Account for external applications]]''') make a GET HTTP request to http://AP-IP/DOMAIN/reporting/ext/ with the following parameters:

from : the from date/time as a local timestamp
to: the to date/time as a local timestamp
type: the return format, allowed values:
xml
pdf
csv
[anonymous]: anonymizes names and numbers ("true" or "false"), default is true

[filterNames]: use a filter with its name. You can use multiple filters inside of a filter array filterNames=[{"name":"filter1"},{"name":"filter2"},...]
[lang]: the language, e.g. "en" or "de"
tz: the time zone corresponding to the time stamp
[sip]: the SIP or Cn (Long Name) of the object you want to filter for

Parameters in [] are optional.

Example:

http://ap.innovaphone.com/innovaphone.com/reporting/ext/report.xml?lang=en&tz=Europe/Berlin&type=xml&sip=&from=1692136800000&to=1698056896320&filterNames=&anonymous=true

Gets all records between 2023-08-16 and 2011-10-23 in time zone Europe/Berlin.

http://ap.innovaphone.com/innovaphone.com/reporting/ext/report.xml?lang=en&tz=Europe/Berlin&type=xml&sip=&from=1692136800000&to=1698056896320&filterNames=[{"name":"Only Incoming Calls"}]&anonymous=true

Gets all "Incoming calls" records between 2023-08-16 and 2011-10-23 in time zone Europe/Berlin. (The filter must be defined beforehand)

===CSV, XML or PDF export===

There is no limit of entries anymore concerning the export as XML,CSV or PDF (Previously there was a limit of 20000 entries). But keep in mind, that the creation of large reports will take a considerable amount of time and load. Depending on your hardware the download of very large reports may take several minutes and currently no feedback is given by the service when a "Download report" request is made. (This will be added in future versions).

The field description applies to the '''CSV''' columns!

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

Note that a CSV export doesn't contain the whole call flow!

===Filters===

==== General ====

Filters are set up to create reports based on certain conditions. ( Attention must be taken as the filters are AND combined to the date filters '''From''' and '''To''' and the quick filter '''Name or SIP'''). A filter can have multiple conditions (Name, Number, Group, PBX Name. Time... ) and multiple filters can be combined on report creation. Multiple filters are OR combined. So in the following picture you would see all incoming calls plus all transferred calls plus all calls made on the PBX Berlin.
A filter has a unique name.

[[Image:Reference14r1_Concept_App_Service_Reports_Filters.png|600px]]

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

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

==== SQL Wildcard ====

Like seen in the previous line you may use the SQL wildcard "%" which matches everything (so Inn% matches Innovaphone, Inno, Innovahone Gmbh ...) and corresponds to the better known "*" wildcard.

==== Base filter ====

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

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

'''Anonymous'''

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

'''Local'''

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

Name or SIP: the cn/PBX object name/sip
Number: the number
Groups: a group of the PBX object

'''Remote'''

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

Name: cn or sip
Number: the number
Remote display name: the display name

'''PBX'''

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

PBX: the PBX name
Node: the node name

'''States'''

No Response
Connected
Busy
No Channel

'''Directions'''

Incoming
Outgoing
Transfer: calls, which have been transferred to the current local party (calls which were initiated by a transfer action)
Call Forward: calls, which have been forwarded to the current local party

[[Image:Reference14r1_Concept_App_Service_Reports_Filters_Second_Part.png|300px|thumb|left|Filter Definition lower part]]

'''Call domain'''

Internal calls
External calls

'''Call Duration'''

Time the call was connected.

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

'''Alert Duration'''

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

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

'''Report times'''

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

'''Using Patterns'''

You can use these PostgreSQL Patterns for every condition.

== Report Mails ==

You can send daily, weekly or monthly emails with attached reports and apply filters on them. There is no limit concerning the size of the reports but keep in mind, that your email provider might not allow attachments exceeding a certain size e.g. 20 MB.
The automatic report generation can be configured here:

[[Image:Reference14r1_Concept_App_Service_Reports_Email.png|300px|thumb|left|Report Email Settings]]

'''User reports'''

Creates for each matching user a separate report
Users are matched by Object (Long Name). A user report only contains calls for this user. The email address of the user is built by its H323 name and the System Name of its PBX (h323@systemname) or determined by the E-Mail field of the user

'''Name'''

Quick filter for the cn/sip

'''Filter'''

Applied filter to the report

'''Output Format'''

PDF,CSV,XML (CSV and XML can be gzip compressed)

'''Displayed Duration'''

used for PDF reports (call duration total/user, billing duration)

'''Interval'''

daily: Mail will be send daily with the automatic period "last day"
weekly: Mail will be send weekly with the automatic period "last week"
monthly: Mail will be send daily with the automatic period "last month"

'''Day'''

the day, at which the report is sent

'''E-mail adresse(s)'''

recipients of the report (comma separated)

'''Compress'''

compress the attachment or not

'''Language'''

language used for the report

'''Sorting'''

sort entries by time, name, call or alert duration

'''Send time'''

the time of a day, when the report is sent

'''Time zone'''

the time zone corresponding to the send time

== Simple Statistics ==

[[Image:Reference14r1_Concept_App_Service_Reports_Statistics.png|300px|thumb|left|Report Email Settings]] The Reports App as well as PDF Reports offer simple statistics where the number of incoming and outgoing calls are displayed as well as their respective total and average call and alert duration. Be aware that a transferred call with multiple participants may be counted multiple times as in fact CDRs are displayed.

==Troubleshooting==
Trace flags for App instance on App Platform:

*App
*App Database
*Webserver traffic (shows the communication with the PBX)
*App Websocket (shows the communication with the client in browser)

Trace flags for myAPPS Client:

*Browser Console

== Known issues ==

=== Missed calls query takes long ===
In some scenerios, the missed calls query takes quite long. 13r3 addresses this issue by adding a new combined index.
You can add this index yourself in earlier version through SSH (as root user):

psql -d reporting_db_name
CREATE INDEX cdrs_user_id_utc_stamp_index ON cdrs (user_id,utc_stamp);

Do not change the index name, as updates to 13r3 will create a second index otherwise!

Howto13r3:Step-by-Step Open H.323 Federation

2025-07-02T11:45:37Z

Jbi:

[[Category:Step-by-Step|Federation|Open|h323]]

'''Important:'''
Beginning with 15r1 the used certificate is [[Howto15r1:Firmware_Upgrade_V14r2_V15r1#Federation|validated]] by the reverse proxy/gateway. 

{{HOWTOMOD13r3 Translation Info}}
The article will describe how to configure an open H323 Federation in an simplified way. Here is not the idea to go deep into some federation details. If you think that federation is missing some feature, you can write them into our [[Howto:Community_Platform| Community Platform]].
[[File:Federationprinciplescheme.png|900px|center]]
== Purpose ==
Open federation allows you to establish IP encrypted communication with others innovaphone systems (e.g. two separate customer installed with innovaphone want to do internal call together, share presence, chat). The usage of a regular telecommunications service provider (TSP) is not needed.
=== Features ===
* Call between two innovaphone systems which are not in a master/slave environment
* UC features possible : Video during a call, application sharing, 3 way-calls and video calls
* Chat
* Presence info sharing, favourite
=== Limitations ===
* This solution shows only the configuration of an open federation. More about closed federation can be found [[Howto:Setup_Federation_with_innovaphone_V12r1 | here]]
* If your installation is already configured with the general PBX route feature [[Reference13r1:PBX/Config/General#Common |"Route external calls to"]], this guide is not for you. This does not mean that federation is not possible in that particular case
== Requirements ==
* innovaphone PBX
* innovaphone TURN
* Optional STUN server
* Internet access and external access of your innovaphone PBX
* Valid domain and signed certificate installed [[Reference11r1:Certificate_management]]
* 1 SRV record
* 1 A record
* 1 Port License

== Things to know before you begin ==
* You will need to use two GW interface, be sure to have them available
* The System Name of the PBX must be equal to the domain part used for E-Mails
== Configuration ==
In our scenario, we have the following initial situation:
* Configure 2 GW interfaces
* Adjust CLI for call federation and creates route for both federation calls direction
* Define new filter set to restrict call with number
* Define a Gateway object in the PBX and apply a filter on it
* Define the PBX federation call route
* Definition of the A and SRV record needed to make Federation signalling work with innovaphone system
* Define a basic visibility filter
* Configuration of TURN
=== step 1: Gateway side===
===== The VoIP gateway interfaces configuration =====
Configure 2 GW under [[Reference13r3:Gateway/GK/GW]], one register internally toward the PBX, the other one act as Federation open interface
* GW One Toward the PBX:
**Name: optional ''(in our example we have named it internal Federation)''
**Protocol: H323/TLS
**Mode: Register as Gateway
**Address: your PBX FQDN ''(e.g. pbx.voipsystem.tld)''
**Gatekeeper Identifier: the PBX system name
* GW Open Federation:
**Name: optional ''(in our example we have named it H323 Federation)''
**Protocol: H323/TLS
**Mode: Gateway without Registration
**Address: 0.0.0.0 with the checkbox "Federation" ticked
**Local Domain: when the local domain cannot be used for external federation, you can configure a working domain that will automatically match the local domain
**Mask: 0.0.0.0
''Hint: The 0.0.0.0 allow any network to reach this interface, you can restrict to specific network by entering its IP and sub network'' 
''Hint2: The local domain option has been introduced in v13r3sr7''
===== Routing table : the routing configuration and CGPN suppression=====
You need to define 2 routes under [[Reference9:Gateway/Routes]] in both directions, in our case we want to have the route at the top of the routing table, we need to click on the top left icon.
[[File:Insertroute.png]]
{| class="wikitable"
! From !! To !! Direction
|-
| GW16: H323 Federation|| GW15: internal Federation || ''Incoming traffic''
|-
| GW15: internal Federation|| GW16: H323 Federation || ''Outgoing traffic''
|}
And then open the CGPN maps menu to insert an exclamation mark under the '''Number In''' field. [[Reference9:Gateway/CGPN-Maps]]
[[File:Routesandcgpnsupression.jpg|700px|thumb|none| CPGN routing table configuration menu, click on the arrow to open it]]
''Hint: CGPN suppress is important in order to have a well formatted displayed name (e.g. John and not 209@yourdomain.tld)'' and also to be able to call federation destination.
===== Gateway interface (GK) : CGPN suppression=====
Open the interface which register internally in our case GW15 and set like in the screenshot below the exclamation mark '''!''' under the '''CGPN In''' and '''CGPN Out'''
[[File:Gkcgpn.jpg|700px|thumb|none| Click on orange coloured name of your interface to open the number mappings menu]]

=== step 2: PBX side ===
===== The PBX filter definition =====
We do not want to have the internal user being call over a number but rather with email addresses, therefore we need to define a filter and apply it later on. like in the screenshot forbid all number and name your filter smartly in order to retrieve it later on. 
Filter definition is under [[Reference13r1:PBX/Config/Filter]].
[[File:Nocalloninternalnumber.jpg|700px|thumb|none|Filter definition, all internal extension should not be called by federated systems]]
===== The PBX Gateway object =====
As we have a Voip interface configured on the gateway side, we need to register it into our PBX.
Create a PBX Gateway Object, name it smartly (can helps in the syslogs) like this example:
*Tab General
**Long Name: Federation
**Name: federation
**Password: a secure one, even not needed, take the habit to secure your PBX objects
**Node: according to your setup
**PBX: according to your setup
*Under ---Devices---
**Hardware ID: 005056xxxxxx-GW15 (as we have used the GW15 connected in TLS mode, we need to enter the mac of the PBX followed by the sign "-" and the respective used gateway interface
We need then to apply the previously defined filter into this Gateway object. To do so, navigate to :
*Tab Gateway
**Filter: select in the drop-down list your filter, in our example it is ''inbound_fed''
===== Route Root-Node External Calls to =====
As you already know, the idea of federation communication is to use email. Of course our PBX does not know the target email to dial out and thus will drop the federation call. We need to root the federation traffic toward the previously created PBX Gateway object which is connected to our gateway interface GW15.
*Under [[Reference13r3:PBX/Config/General]]
**Route Root-Node External Calls to: Federation ''(Hint: configure here the '''Long name''' of the object and not the '''name''', which is in our example "Federation")''
=== step 3: DNS side ===
==== DNS, A and SRV records let's make this clear====
In few words, SRV records provide more infos, like for our case a specific service and point to a A records. SRV records are needed for the federation signalling with innovaphone system. A records point to a specific public IP which is bound to the system where the federation interface is configured. It can run separated into a dedicated box or in the same box where the pbx is.
In your DNS controller you need to configure the following DNS records types.
*SRV type: <code>_h323s._tcp.yourcompany.tld</code> and/or <code>_h323federationtls._tcp.yourcompany.tld</code>
*A type: <code>federation.yourcompany.tld</code>
SRV record infos to provide:
*Type: SRV
*Service: h323s and/or h323federationtls
*Protocol: tcp
*TTL: your desired value
*Port: 1300
*Target: federation.yourcompany.tld
SRV records should point to your FQDN A record where the Federation interface is configured. ''(e.g. federation.yourcomapny.tld)''
A Record infos to provide:
*Type: A
*Domain Name: federation.yourcompany.tld (as used in our example)
*IP Address: the Public WAN address of federation interface
*TTL: your desired value
''Hint: if you use the same box for PBX and federation interface and the system is installed with DNS, you can use the PBX DNS name as A record, not mandatory to configure one dedicated)''
==== Pay attention on certificate ====
For the federation to work, you need a valid certificate at the federation interface. The CN/DNS must be the same as the system name (e.g. <code>yourcompany.tld</code> or <code>*.yourcompany.tld</code>). If this is not possible, the target of the SRV record (e.g. SRV Record: <code>_h323s._tcp.yourcompany.tld</code> target <code>federation.yourcompany.tld</code>) must be included in the certificate as the DNS name.
In other words, the device certificate for the federation gateway should also have a DNS entry with <code>federation.yourcompany.tld</code>. 
''Hint: the certificate chain should be loaded in the unit where the federation interface is configured, and the authority CA from the federation partners should be in the trust list.''

=== step 4: Default visibility settings ===
Visibility filter is important when we use federation. It can be configured by:
*The administrator in the admin UI under [[Reference13r3:PBX/Objects]], column visibility for a specific user or for a template [[Reference13r1:PBX/Objects/Visibility]]
*The user via his Profile App under Privacy
Here an example of a deployed visibility via the Config User template with a minimum of informations, no contact name or number or customized presence note will be shared.
[[File:Defaultvisibility.jpg|700px|thumb|none|Default visibility settings]]
*'''Name''': entering '''@''' match all domain
*'''Online''': show if you are logged-in or not
*'''Presence''': show the coloured labels if you are available''(green)'', busy''(red)'', away''(yellow)'', do not, disturb''(violet)''
*'''On the phone''': show a busy presence state with the text ''On the phone''
''Hint: when no presence is shared the contact will always appear Offline(grey)''

=== step 5: Configuration of a TURN server ===
{{FIXME|reason=This article section "step 5" is still work in progress}}
In order to relay the RTP between NAT we need to have a working turn server, in 13r3 we have a new mechanism to use a TURN server behind a NAT router, it is not needed to have the turn directly on the wan network anymore. 
''Hint: for security reason it is better to run the turn server in a separate system''
===== TURN endpoint media relay =====
Tick the TURN option under [[Reference13r3:PBX/Config/General]]
[[File:Pbxturnactivate.jpg|700px|thumb|none|PBX general configuration page, tick TURN]]
===== Public IP of TURN server and port configuration =====
Go to your system where the turn server is running ''(e.g. your SBC)'' under [[Reference13r3:IP4/NAT/General]] 
*Verify that the option enable under STUN/TURN server is ticked
*Configure the Public IP address who belong to the TURN server ''(which is also bound to your turn server DNS A record)''
[[File:Turnconfiguration.jpg|700px|thumb|none|Configure here the public IP and check turn account]]
''Note: Define a turn user and password if it is not done, if you use the TURN installed by the v13 installer, this is already configured''
!!! '''Things to check and to be sure to have it properly configured''' !!!
*Be sure to have a A records pointing to your TURN server ''(e.g. turn.domain.tld)''
*Be sure to have the '''TCP''' and '''UDP''' port '''3478''' allowed in your firewall toward the TURN server ''(if you use the standard turn port)''
*Be sure to have also the '''RTP-UDP''' range is '''forwarded''' for '''incoming''' traffic and '''opened''' for the '''outgoing''' traffic from the firewall toward your TURN server '''(default is 16384 / 32767)'''. The configuration of port range can be found under [[Reference13r2:IP4/General/Settings]]
===== Deploy TURN configuration =====
You need to be sure for the federation that ALL endpoints of your system are configured to use the defined TURN server, also in the same time we can configure the STUN server. The PBX and the SBC need a STUN/TURN configuration.
*Open you devices App and select your domain. Navigate in the middle menu to '''"Device configuration"'''
*Open the category Media and configure your TURN server
**You can also configure a STUN server if it is not configured as it is used for the ICE signalling in general
''Hint: All devices connected to Devices App will be configured with your TURN and STUN configuration, if they have no connection to Devices (e.g. offline devices) they will not get the new devices configuration''.
[[File:Devicesapp.jpg|700px|thumb|none|Device configuration settings]]
== Verification ==
'''Outgoing traffic'''
* Start a chat
** You should be able to find the external user in the search field of the Chat App and start a conversation, the presence state should be also visible (if allowed by the other side).
*Start a call
**You should be able to find the external user in the search field of the Phone/Softphone App and place a call. App sharing and video should also works.
'''Incoming traffic'''
*Add a federated contact as favourite
**You can type the email address of the federated contact in your Phone App or Softphone App and click on the star to add it into your favourite list.
**Your visibility
** Do not forget to adjust your visibility filter based on your needs ''(e.g. disallow all kind of visibility for a specific federated user or domain)''.
== Known issues ==
*Pictures of users are not transmitted and so not displayed. The federation system does not communicate with the Users application service and cannot retrieve profile picture.
*Call pickup : Currently call-pickup is not possible between federated systems.

== Related Articles ==
* [[Howto:Setup_Federation_with_innovaphone_V12r1]]
* Youtube video: [https://www.youtube.com/watch?v=YFCrnOXOPZY| What is Federation? (H.323 / SIP Federation) | English]

Howto:Gcalendar - Wecom - Partner App

2025-06-17T06:37:17Z

Jbi: /* Configuration */

{| class="wikitable" style="float:right;"
! colspan="2" |Partner App Info
|-
| colspan="2" |[[File:Wecom Gcallendar Icon.png|alt=|center|frameless|200x200px|Gcalendar Icon]]
|-
!Name
|Gcalendar
|-
!Company
|Wecom
|-
!Version
|1.0
|-
!Compatibility
|Innovaphone XML Schema
|-
!License
|Via Innovaphone Pricelist
|-
!Languages
|Portuguese, English, Spanish, German
|}

== Product Name ==
'''Gcalendar''' [https://wecom.com.br/ Link]

== Certification Status ==

''Space dedicated to Gcalendar certification information.''

== Category ==

{{Category:3rdParty CTI and integrations}}

== Vendor ==
[[File:Logo wecom.png|thumb|326x326px|Wecom's logo]]
Wecom

* [https://wecom.com.br/ wecom.com.br]

== Description ==
'''Gcalendar''' is a Partner App developed by '''Wecom''' to integrate Google Calendar events with the Innovaphone presence system.

The app operates through two components:

* '''Users App''' – Where the users initiate their account linking process via Google login.
* '''Admin App''' – Allows configuration of the integration with editable fields for Google Client ID and Client Secret, along with a dedicated OAuth authorization URL.

This setup enables real-time status synchronization and supports four languages: Portuguese, English, Spanish, and German.

== Functions ==
This section provides an overview of each core part of the '''Gcalendar''' application. It highlights what actions can be performed, and how to navigate through the available features. Additionally, this section provides step-by-step explanations for each functionality.

=== Users App ===
The '''Users App''' is the interface used by users to link their Google Calendar account to the Innovaphone presence system. It focuses only on enabling the connection between the user and their calendar through Google authentication.
[[File:Gcallendar Users App Interface.png|none|thumb|404x404px|Users app interface with google account pop-up]]

==== Connecting with Google account ====

# Open the '''Gcalendar''' Users App.
# Click the '''Connect''' button.
# A Google login popup will appear.
#* This popup allows users to choose or log into a Google account.
# After selecting an account, the integration process will begin automatically.
#* Once completed, the account will be linked to the Innovaphone system.
[[File:Gcallendar Connect Button.png|none|thumb|Connect button]]
<blockquote>⇒ '''Note:''' Before starting the connection process, ensure you're already logged into the correct Google account in your browser. This helps avoid selecting the wrong account and ensures the integration is completed with the intended calendar.</blockquote>

==== Disconnecting from Google account ====

# Open the '''Gcalendar''' Users App.
# If a Google account is already connected, the '''Connect''' button will be replaced by a '''Disconnect''' button.
# Click the '''Disconnect''' button to unlink your current Google Calendar account from the Innovaphone presence system.
# Once disconnected, presence synchronization will be disabled for that user.
[[File:Gcallendar Disconnect Button.png|none|thumb|392x392px|Disconnect button]]

=== Admin App ===
The '''Admin App''' provides configuration options required to authorize and manage the Google integration. It is intended for system administrators and enables control over OAuth credentials used for user authentication.
[[File:Gcallendar Admin App.png|none|thumb|453x453px|Admin app interface]]

==== Updating Google OAuth Credentials ====
To enable or update the integration between Gcalendar and Google Calendar, you’ll need to provide the correct '''Client ID''' and '''Client Secret''' obtained from your Google Cloud project.

# Open the '''Gcalendar Admin App'''.
# Locate the fields labeled '''Google Client ID''' and '''Client Secret'''.
# Paste the values copied from your Google OAuth Credentials into the respective fields.
# Click the '''Update''' button next to each field to save the changes.

<blockquote>⇒ '''Notes:'''

* Ensure both values are correctly copied and properly formatted.
* Incorrect credentials will prevent users from authenticating.
* The Client Secret is sensitive—never share or expose it publicly.
</blockquote>
[[File:Gcallendar Google Client ID Update.png|none|thumb|519x519px|Google Client ID input and update button]]
[[File:Gcallendar Client Secret Update.png|none|thumb|519x519px|Client Secret input and update button]]

== Licensing ==
The '''Gcalendar''' application is licensed via the Innovaphone Pricelist.

Currently, it is not yet listed on the official Innovaphone Partner App Licenses page, but it is expected to be included in future updates.<blockquote>'''License type:''' Innovaphone Pricelist

'''License model:''' One license per user

'''Listed at:''' https://www.innovaphone.com/en/services/licenses/partner-apps.html?app=Gcalendar&type=license#gcalendar</blockquote>

== Prerequisites ==
Before installing and using Gcalendar, ensure your environment meets the following requirements:

==== System Requirements ====

* '''Innovaphone firmware:''' Version <code>14r1</code> or later
* '''App platform:''' Innovaphone '''myApps''' system with '''App Platform''' active
* '''PBX Manager:''' Required to register and configure the Users and Admin Apps

==== OAuth Setup ====

* A '''Google Cloud Project''' with valid '''OAuth 2.0 credentials''' (Client ID and Client Secret)
* The following URIs must be configured in the Google project:
** '''Authorized JavaScript origins:''' <code>https://<app_platform></code>
** '''Authorized redirect URI:''' <code>https://<app_platform>/<domain>/<app_name>/newToken</code>

== Versions ==
The '''Gcalendar''' application follows the release versioning aligned with the Innovaphone platform.

* '''Initial release version:''' <code>14r1</code>
* '''Latest available version:''' <code>2001 final</code> (as of May 22, 2025)
* '''Build number:'''<code>14A1149 dvl</code>
* '''Supported architectures:''' <code>arm</code>, <code>x86_64</code>, <code>arm64</code>

<blockquote>⇒ New versions are published and made available through the Wecom App Store.</blockquote>

== Configuration ==

=== Google OAuth Setup (Admin Only) ===
To enable account linking between the Innovaphone presence system and Google Calendar, administrators must configure OAuth 2.0 credentials using the Google Cloud Platform beforehand.

# Go to [https://console.cloud.google.com/ Google Cloud Console].
# Select or create a '''Google Cloud Project'''.<blockquote>◇ ''This project will host the credentials used by Gcalendar to access the Google Calendar API. We recommend creating a dedicated project for better control and security.''</blockquote>[[File:Google Cloud Select-Create Project.png|none|thumb|425x425px|Google Cloud Console welcome page with select project button outlined (here the project is already selected)]]<blockquote>Clicking the '''"Select Project"''' button will open a '''modal''' where you can choose or create a project.</blockquote>[[File:Google Cloud Select Project If Selected.png|none|thumb|353x353px|Project selection modal]]<blockquote>If a project already exists, click on its name from the list to open it. If not, click '''"New Project"''' in the top-right corner to create one.</blockquote>[[File:Google Cloud New Project Page.png|none|thumb|440x440px|New project creation page]]
# In the top-left corner, click the '''hamburger menu icon''' (☰) to expand the left navigation menu.
# In the left menu, navigate to '''API & Services > OAuth consent screen'''.[[File:Google Cloud Left Menu API Outlined.png|none|thumb|482x482px|Left menu: '''APIs & service -> OAuth consent screen''']]
#* If it's your first time, configure the consent screen with basic app details (organization name, app name, email, etc.).
#* Once configured, you'll be redirected to the '''Google Auth Platform / Overview''' page.
# Click '''Clients''' in the left menu and then click "'''+ Create client"'''.[[File:Google Cloud new client.jpg|none|thumb|525x525px|Creating client option in Clients page]]
# Choose '''Application Type: Web Application'''.
# Enter a recognizable '''name''' (e.g., ''Gcalendar Integration'').
# Add the following values:
#* '''Authorized JavaScript origins'''
#** <code>https://<app_platform></code>
#* '''Authorized redirect URIs'''
#** <code>https://<app_platform>/<domain>/<app_name>/newToken</code>[[File:Google Cloud Create OAuth Client ID.jpg|none|thumb|411x411px|Create OAuth client ID inputs]]
# After creation, copy the generated:
#* '''Client ID'''
#* '''Client Secret'''[[File:Google Cloud Client ID Client Secret.jpg|none|thumb|434x434px|Client credentials available after creating]]
# Open the '''Gcalendar Admin App''' and insert the values in the respective fields and click '''Update''' (see [[Howto:Gcalendar_-_Wecom_-_Partner_App#Updating_Google_OAuth_Credentials|Update Google OAuth Credentials]] section above).

<blockquote>▷ This links the Google authentication flow to the presence system, allowing users to authorize their calendars.</blockquote>

== Installation ==
Follow the steps below to install the '''Gcalendar''' application in your Innovaphone environment.

=== Option 1: Installing via AP Manager App Store (Recommended) ===
You can install '''Gcalendar''' directly through the '''App Platform Manager''' (AP Manager) by accessing the App Store:

# Open the '''AP Manager'''.
# Click the yellow '''App Store''' button in the top-right corner.
# Search for '''Gcalendar''' in the list.
# Select the latest version and confirm the download.
# The app will be automatically installed and ready to configure.

<blockquote>🛈 This is the easiest and fastest way to deploy the app.</blockquote>
[[File:Innovaphone MyApps Lab AppStore Button in AP Manager.png|none|thumb|436x436px|AppStore Button in AP Manager outlined]]
[[File:AP Manager Appstore Interface.png|none|thumb|436x436px|AP Manager Appstore interface]]

=== Option 2: Manual Installation via Upload ===
If the app is not yet listed in the App Store, follow the steps below:

==== Step 1: Download the App Package ====

# Visit the official Wecom myApps Downloads Portal.
# Find the '''Gcalendar''' app.
# Download the latest available version compatible with your system architecture.
[[File:Gcalendar myapps wecom appstore.png|none|thumb|418x418px|Gcalendar on MyApps' Wecom's App Store]]

==== Step 2: Upload to AP Manager ====

# In '''AP Manager''', click '''App upload''' (top right).
# Select the <code>.app</code> package you downloaded from the portal.
# After successful upload, the app will appear in your list and show as '''Running'''.
[[File:App Upload Button on MyApps AP Manager.png|none|thumb|485x485px|App Upload button on AP Manager outlined]]
[[File:Gcallendar on AP Manager Innovaphone.jpg|none|thumb|490x490px|Gcalendar on AP Manager]]

=== Final Step: Registering the App in PBX Manager ===

# Open the '''PBX Manager'''.
# Go to the '''Apps''' section.
# Click '''Add App''' and register:
#* A '''Users App'''
#* An '''Admin App'''
# Assign access rights as needed.
[[File:PBX Manager Add an App flow - part 1.png|none|thumb|440x440px|PBX Manager Add an App select the app]]
[[File:Gcallendar PBX Manager Add an App flow - part 2.png|none|thumb|440x440px|PBX Manager Add an App configurations]]
[[File:Gcallendar on PBX Manager Innovaphone.jpg|none|thumb|441x441px|Gcalendar on PBX Manager configured]]
<blockquote>⇒ After registration, both apps will appear in MyApps and are ready for use.</blockquote>

== Copyright ==
Copyright information.

== Contact ==

* '''PORTO ALEGRE - RS'''

Av. Carlos Gomes, 466 / 401

Boa Vista - CEP 90480-000

'''Tel:''' +55 51 3079.5000

* '''FLORIANÓPOLIS - SC'''

SC 401, 8600 - Room 7

Corporate Park - Block 2

Santo Antônio de Lisboa

CEP 88050-001

'''Tel:''' +55 48 3112.6200

'''Mail:''' [mailto:comercial@wecom.com.br comercial@wecom.com.br]

'''Support:''' [mailto:suporte@wecom.com.br suporte@wecom.com.br]

'''Website:''' [https://wecom.com.br/ wecom.com.br]

For any questions please refer to [https://wecom.com.br/fale-conosco/ our contact page.]

Reference15r1:Concept App Remote Control

2025-05-21T13:11:45Z

Jbi: /* With the Remote Control Client external application */

[[Category:Concept|Apps]]
[[Category:Concept App Remote Control]]
== Applies to ==
* innovaphone PBX from version 15r1
== Requirements ==
* innovaphone PBX
* innovaphone Application Platform (minimum version 130006)
* V15r1
* myApps for Windows.
* Remote Control Client for external participants '''Note : in v15r1 the Remote Control Client is only available for Windows'''

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

== Licensing ==

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

== Installation ==
=== For new v15r1 installation ===
The Remote Control App is automatically installed by the installer and will be deployed in the '''Config User''' template
=== With the PBX manager AP app installer plug-in ===
[[File:Ap_app_installer.png]]

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

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

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

A user (viewer) sends a request to another user (sharer) to access the sharer's PC, the sharer accepts the session and begins to share their desktop with the viewer.
 The viewer is also automatically given control of the mouse and keyboard. Remote sessions are also possible between companies using myApps or not.

=== Features ===

Here are the features available in the Remote Control App

;Included features
:
* App notification to start a session
* Multiple monitor support: Viewers can switch between desktops by clicking on the monitor icons
* Direction of control: Change the direction of sharing, a viewer would become a sharer
* Screen scaling: Two different views of the remote desktop, original size or resized
* Notifications: On the remote PC, if the sharer does not have the remote control open or is busy with another session, the person requesting a session will be notified within the Remote Control App
* Text copy & paste support in both directions
* Support for different keyboard layouts

;Licensed features
:
* Support with participants outside your organisation
** Between 2 different myApps installation using Remote Control App ''(e.g 2 different companies)'' via a session link.
** Without myApps with the [[Reference15r1:Concept_App_Remote_Control#With_the_Remote_Control_Client_msi_application|Remote Control Client]].
* Share/Join session
** Generate a session link from Remote Control App and share it
** Join a session by entering a link
* Multiple sessions:
**If you need more than one session (e.g many viewers for one sharer, more than one parallel session)

=== Remote Control with participants outside your organisation ===
====With the Remote Control Client external application====
The Remote Control Client allows you to establish a remote session with people who are not part of your myApps environment. ''E.g. : external participants such as your customers''. External participants see the myApps user's screen sharing.
* Client compatible with Windows only
* Easy to install, download client via a session link:
**Open the shared session link in a web browser and get the ''remoteControl.exe''
**Open the previously downloaded file on your computer
**Enter your name, info and session link ''(same link that is used to download the client)''
**Click on Join Session
''Note : from 15r1sr2 we introduced a new, lighter client that requires less effort to install and use. The new client also offers a new possibility of joining sessions with elevated admin rights for users who are not admins on their computers. ''

====With your myApps Remote Control App====
It is possible to establish a remote session between 2 organisations using myApps and having the Remote Control App installed. In the App you can also join/share a session with a link.
*Compatible only between myApps Windows clients
*Easy to use:
**User A from company "xyz.com" opens his Remote Control App in myApps and clicks on '''Share session'''
**User A copies the link and sends it to User B
**User B from company "abc.com" opens his Remote Control App in myApps, clicks on '''Join session''' and pastes the link received from User A into the '''Session link text field'''
**User A will receive a Join Session notification to accept
**User A will see User B shared session

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

=== Technical data ===
* The maximum bitrate is 1.2Mbits for the users who is sending its desktop UI. The viewer just sends mouse and keyboards events
* Remote Control App is using the SCTP protocol with a fix UDP port range between [https://wiki.innovaphone.com/index.php?title=Howto:What_Ports_are_used_for_Signaling_and_Voice_Traffic_in_SIP_and_H.323%3F#Application_Sharing_(RTP)| 50200-50299] within the myApps client. Same range as the Application Sharing feature
*Same port range is used by the Remote Control Client msi application

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

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

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

=== Trace of the Remote Control Client ===
Do a right click on the app try icon and click on ''open trace folder'' (''default path C:\Users\[YourUser]\AppData\Local\innovaphone\RemoteControl''), get the whole content in a zip file.

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

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

Reference16r1:Concept innovaphone App Platform Container

2025-05-14T10:04:39Z

Jbi:

{{FIXME|reason=Below described feature is experimental and not officially supported for use in productive environments.}}
The innovaphone App Platform Docker container provides a myApps App Platform instance that includes the AP Manager, Webserver and PostgreSQL. This container offers a ready-to-use environment for myApps applications and the innovaphone PBX.

==Image Information==

This chapter provides details about the Docker image used for the innovaphone App Platform.

===Repository Details===

;Repository Host : docker.innovaphone.com
;Image Name : cloud/kubernetes/innovaphone-platform-instance

docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

===Tagging and Versioning===
The image is usually tagged with the build number according to innovaphone software releases:

;Latest Tag : Use the latest tag for pulling the most recent service release.

;Release Build Number : For production or version-specific deployments, use a specific build number as the tag (e.g., 130006).

Example:
docker pull docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

===Supported Architecture===
This Docker image supports the <code>linux/amd64</code> architecture.

===Image Reference===
An example of a full image reference using a specific release build number would be:
docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

==Ports==
This chapter outlines the various ports exposed by the Docker container. The webserver ports are available immediately upon container startup, after start of the AP Manager and the Webserver, while the additional application ports become active after the app installation. In most cases, a one-to-one mapping is used, meaning the container port is mapped directly to the same host port unless otherwise specified.

===Webserver Ports===
;HTTP:
Container Port: 8080
Description: Used for accessing the built-in webserver immediately upon container startup.

;HTTPS:
Container Port: 8082
Description: Used for accessing the built-in webserver immediately upon container startup.

=== Additional Application Ports===
Following additional container ports are avilable depending on installed and configured applications:
;H323/TLS : 1300
;SIP : 5060
;SIPS : 5061
;LDAPS : 1636
;SMTP : 8025
;SMTPS : 8587
'''Additional hint for Portmapping'''<syntaxhighlight lang="yaml" line="1">
docker run -d \
--name=innovaphone \
--restart unless-stopped \
-p 9090:8080 \ #Container Host Port (external) 9090:8080 Container Port
-p 9091:8082 \
-p 5060:5060 \
-p 5061:5061 \
-p 1300:1300 \
-p 1636:1636 \
-p 8025:8025 \
-p 8587:8587 \
-v /path/of/data/innovaphone:/mnt/data \ #in this path you will find Apps, DBs & Logs
#this path musst be used for backups!!
-e WEBSERVERPORTHTTP=8080 \
-e WEBSERVERPORTHTTPS=8082 \
-e LOG_FLAGS=7 \
-e LOG_SIZE=1048576 \
-e DNSIPV4=8.8.8.8 \
-e LIMIT_RAM=512 \ #Ram limit in MB
-e LIMIT_DISK=10 \ #disk size in GB
-e TZ=Europe/Berlin \
docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

</syntaxhighlight>

==Environment Variables (ENVs)==
This chapter outlines the key environment variables used to configure the behavior of the innovaphone App Platform Docker container. These variables allow you to customize logging, port settings, resource limits, and more during startup and runtime.

;LOG_FLAGS : Defines the integer representation for the trace flags of the AP Manager, according flags activated under the AP Manager / Diagnostics. See browser console message on Save button press (e.g. "logFlags":1 , if the "App" flag is activated).
LOG_FLAGS=7
;LOG_SIZE : Specifies the maximum size in bytes for logs before rotation or management actions occur. Default: 5242880.
LOG_SIZE=1048576
;WEBSERVERPORTHTTP : Sets the in-container HTTP port for the webserver. Default: 8080.
WEBSERVERPORTHTTP=8080
;WEBSERVERPORTHTTPS : Sets the in-container HTTPS port for the webserver. Default: 8082.
WEBSERVERPORTHTTPS=8443
;DNSIPV4 : Specifies the in-container IPv4 address for DNS resolution. Overrides the deafult container runtime DNS server.
DNSIPV4=8.8.8.8
;LIMIT_RAM : Sets the RAM limit for the container, in MB, controlling how much memory it may consume. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_RAM=512
;LIMIT_DISK : Defines the disk space limit in GB for the container to manage storage consumption. Used by AP Manager to stop the app instances on overconsumption.
LIMIT_DISK=10
;MANAGER_DB_HOST : defines an external database host for the database of the App Platform Manager
If you hand database settings, the container will work without the local database server and doesn't need any storage at all (under development).
MANAGER_DB_HOST=172.16.14.35:5432 (port is optional)
;MANAGER_DB_NAME : the external database name
MANAGER_DB_NAME=databasename
;MANAGER_DB_USER : the external database user who has access
MANAGER_DB_USER=databaseuser
;MANAGER_DB_PASSWORD : the password of the user
MANAGER_DB_PASSWORD=o1kk2hj312k3

==Volumes and Mounts==
This container uses a dedicated internal mount path for the persistent data management across container restarts and updates.

===Internal Data Volume===
;Mount Path : <code>/mnt/data</code>
;Contents:
*Apps: Installed application binaries.
*Databases: PostgreSQL files.
*Logging: Log files for system and application events.

===Mounting===
To ensure that your data is preserved, map a host directory or Docker named volume to the container's /mnt/data path when running the container.
For example:
docker run -d -v /path/on/host:/mnt/data docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:130006

This setup guarantees that your apps, associated data, databases, and logs persist independently of the container lifecycle.

==Entrypoint==
The container uses a fixed entrypoint:
ENTRYPOINT ["/entrypoint.sh"]

This script prepares the container and starts the AP Manager executable.

==Logging and Monitoring==
The log of the entrypoint.sh and of the AP manager is avilable as conatiner output. The installed applications store the ir log files under <code>/mnt/data/var/log/apps/</code>.

==Usage Example==
sudo docker run -d --restart unless-stopped --name innovaphoneAP -p 9090:8080 -p 9091:8082 -e WEBSERVERPORTHTTP=8080 -e WEBSERVERPORTHTTPS=8082 -v $(pwd)/myapps/:/mnt/data docker.innovaphone.com/cloud/kubernetes/innovaphone-platform-instance:latest

This command runs the container in detached mode with automatic restart. It names the container innovaphoneAP, maps host ports 9090 and 9091 to the container's HTTP and HTTPS ports, sets the webserver port environment variables, mounts a host directory to /mnt/data, and starts the AP Manager. After container start up the AP manager web UI is accessible via <code>http://localhost:9090</code> or <code>https://localhost:9091</code>.