innovaphone wiki - User contributions [en]

Reference13r1:Concept myApps platform services

2024-05-14T09:11:17Z

RobinBaur: Undo revision 71747 by RobinBaur (talk)

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

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

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

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

* myApps Web App (WebRTC)
version 13r1

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

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

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

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

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

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

|-

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

| application sharing

|-

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

|   consumer || view an application shared be the peer || ✔ || ✗ || ✗ || ✔

|-

|   control|| take control of presenters application (mouse & keyboard) || ✔ || ✗ || ✗ || ✔

|-

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

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

|-

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

|-

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

|-
| notifications || display notifications with OS standard mechanism || ✔ || ✗? || ✗? || ✗?
|-

| phone book access || access local phone book || ✔ || ✔ || ✔ || ✗
|-

| office presence provider || maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗

|-

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

|-

| push || wake-up app from background mode on event (e.g. incoming call) || ✗ || ✔ || ✔ || ✗
|-

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

|-

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

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

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

|}

<references/>

=Requirements=
* innovaphone PBX 13r1 and up

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

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

=== Windows N editions ===

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

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

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

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

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

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

= Licenses =
* No license needed for myApps platform services

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

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

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

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

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

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

{|

| audio || 50000 -> 50099

|-

| video || 50100 -> 50199

|-

| data || 50200 -> 50299

|}

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

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

===== Codecs =====

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

The following codecs are supported:

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

''* small presentation only''

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

The default resolution for video capture is 352x288 if available. Otherwise, 320x240 is used. The frame rate is 30 fps if available, otherwise 15 fps is used. The resulting average bandwidth will be 350 kbps.

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

Screen content and mouse position will be transmitted by the presenter. Mouse and keyboard control can be handed over to viewers. Bitrate is restricted to 500 kbps.

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

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

In the Windows Launcher the RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.

For this to work, vendor specific development kits from Jabra, Epos (formerly Sennheiser) and Poly (formerly Plantronics) are integrated.

Note that it is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI_parameters | MSI parameters ]] below).
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app.


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

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

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

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

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

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI_elements | UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function.
; dial selected number : Initiates a call using the currently selected text as target.

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

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

; accept call : Accepts a currently alerting call.

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

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

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

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

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

=== URL Handler ===

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

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

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

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

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

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

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

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

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

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

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

=== Notifications ===

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

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

==== Windows ====

If notifications do not work, please check:

* '''Shortcut'''. During myApps installation a shortcut must be created in '''C:\ProgramData\Microsoft\Windows\Start Menu\Programs\innovaphone\myApps''' for the notifications to work. Please check that this shortcut is present.
* '''Windows Settings'''. Check following screenshots:
[[Image:notifications0.jpg]]
[[Image:notifications1.jpg]]

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

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

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

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>
Note that Apps never perform a reverse (number) lookup, neither is there an API defined for it. This is done centrally within the PBX. However, as the PBX has no access to the user's local phone books, entries therein are not searched for reverse lookup.

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

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

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

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

=== Microsoft Office integration ===

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

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

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

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

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

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

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

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

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

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

; $c : conference id

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

=== Push ===

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

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to [[Course13:IT Connect - 10.1 Push Object | be configured in the PBX ]]. Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[Reference12r2:Concept Push Notifications for myPBX iOS and Android]] for more details.

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

=== App Proxy ===

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

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

=== Auto update ===

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

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

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

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

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

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

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

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

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

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

=== Used APIs ===

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

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

=== Protocols ===

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

== Related App Services ==

none

== Known limitations ==
; Button on Bluetooth headsets not functional on myApps for iOS : The button of Bluetooth headsets doesn't provide to accept or disconnect calls. The button on wired earphones does.

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

= Installation =

== Windows ==

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

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

=== MSI Parameters and install options ===

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

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

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

; EXTERNALAPPS: pre-define external applications, see [[#Call_an_external_application_for_calls|Call an external application for calls]] above
: e.g. <code>"{\"externalApps\":[{\"id\":1,\"name\":\"Wireshark\",\"path\":\"C:\\Program Files\\Wireshark\\wireshark.exe\",\"param\":\"\",\"autostart\":true]}"</code>

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

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

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

== iOS ==

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

== Android ==

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

= Configuration =

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

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

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

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

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

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

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

|-

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

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

|-

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

|-

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

|-

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

|-

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

|-

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

|-

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

|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker (should be in phoneapp rather???)|| ✔ ||✗ ||✔ || ✗ || ✗
|}
== Start parameters for Windows ==

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

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

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

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

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

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

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

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

=Troubleshooting=

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

The following trace flags can be set:
{|
!style="text-align: left; font-weight: bold" | Abbreviation

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

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

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

; Windows :On Windows, traces are written to the <code>C:\Users\[UserName]\AppData\Local\innovaphone\myApps</code> directory.

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

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

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

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

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

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

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

= Related Articles =

* [[Reference13r1:Concept_myApps]]
* [[Reference13r1:Concept_myApps_Office_Integration]]
* [[Reference13r1:Concept_myAPPs_Search_in_local-Outlook_Contacts]]

* [[Reference10:Call_Detail_Record_CDR_PBX]]

* [[Reference12r2:Concept Push Notifications for myPBX iOS and Android]]

* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]

* [[Reference13r1:PBX/Config/myApps]]

Reference13r1:Concept myApps platform services

2024-05-14T08:36:02Z

RobinBaur: /* Device handling */ Epos

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

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

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

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

* myApps Web App (WebRTC)
version 13r1

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

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

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

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

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

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

|-

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

| application sharing

|-

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

|   consumer || view an application shared be the peer || ✔ || ✗ || ✗ || ✔

|-

|   control|| take control of presenters application (mouse & keyboard) || ✔ || ✗ || ✗ || ✔

|-

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

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

|-

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

|-

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

|-
| notifications || display notifications with OS standard mechanism || ✔ || ✗? || ✗? || ✗?
|-

| phone book access || access local phone book || ✔ || ✔ || ✔ || ✗
|-

| office presence provider || maps PBX presence state to Microsoft office presence state || ✔ || ✗ || ✗ || ✗

|-

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

|-

| push || wake-up app from background mode on event (e.g. incoming call) || ✗ || ✔ || ✔ || ✗
|-

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

|-

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

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

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

|}

<references/>

=Requirements=
* innovaphone PBX 13r1 and up

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

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

=== Windows N editions ===

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

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

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

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

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

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

= Licenses =
* No license needed for myApps platform services

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

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

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

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

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

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

{|

| audio || 50000 -> 50099

|-

| video || 50100 -> 50199

|-

| data || 50200 -> 50299

|}

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

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

===== Codecs =====

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

The following codecs are supported:

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

''* small presentation only''

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

The default resolution for video capture is 352x288 if available. Otherwise, 320x240 is used. The frame rate is 30 fps if available, otherwise 15 fps is used. The resulting average bandwidth will be 350 kbps.

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

Screen content and mouse position will be transmitted by the presenter. Mouse and keyboard control can be handed over to viewers. Bitrate is restricted to 500 kbps.

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

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

In the Windows Launcher the RTP service also enables some extended features (such as hook switch or volume control) for supported USB headsets or Bluetooth headsets connected to myApps.

For this to work, vendor specific development kits from Jabra, Epos (formerly Sennheiser) and Poly (formerly Plantronics) are integrated. Starting with 13r3 sr10, the Epos SDK needs to be installed separately using the Epos Connect software. If the Epos-Connect software is not installed, the headsets will not be able to control calls, but audio will still be played when calls are connected.

Note that it is possible to inhibit the start of the Sennheiser SDK (SenncomSDK.exe) using the <code>DISABLEHEADSETS</code> directive of the installer (see [[#MSI_parameters | MSI parameters ]] below).
The supported headset-SDKs determine which headset vendors are recommended to be used with the myApps softphone app.


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

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

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

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

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

The hot keys can be specified using the ''advanced settings'' user interface (see [[#UI_elements | UI elements]] below. Any of the function keys F1 to F11 (optionally combined with up to two modifier keys ''alt'', ''ctrl'', ''shift'' or ''win'') can be chosen for each function.
; dial selected number : Initiates a call using the currently selected text as target.

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

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

; accept call : Accepts a currently alerting call.

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

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

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

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

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

=== URL Handler ===

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

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

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

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

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

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

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

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

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

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

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

=== Notifications ===

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

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

==== Windows ====

If notifications do not work, please check:

* '''Shortcut'''. During myApps installation a shortcut must be created in '''C:\ProgramData\Microsoft\Windows\Start Menu\Programs\innovaphone\myApps''' for the notifications to work. Please check that this shortcut is present.
* '''Windows Settings'''. Check following screenshots:
[[Image:notifications0.jpg]]
[[Image:notifications1.jpg]]

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

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

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

: <code>{"mt":"ApiResult","src":"3","provider":"@local-8125d22e37-519d-4056-bfe5-c52ef2ae8fabb0","consumer":"dev:SwPh_zkl_5e42e884","client":"@client-f62702dd86-be3f-47fc-b4bc-7a21627b75b2ea","msg":{"mt":"SearchInfo","relevance":2000,"adjust":true,"type":"contact","contact":{"givenname":"John","sn":"Doe","company":"ACME","position":"Head of everything","telephonenumber":["11111","22222"],"homephone":["+4944444","33333"],"mobile":["+49 (123) 55555"]}},"api":"com.innovaphone.search"}</code>
Note that Apps never perform a reverse (number) lookup, neither is there an API defined for it. This is done centrally within the PBX. However, as the PBX has no access to the user's local phone books, entries therein are not searched for reverse lookup.

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

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

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

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

=== Microsoft Office integration ===

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

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

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

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

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

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

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

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

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

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

; $c : conference id

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

=== Push ===

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

For ''push'' to work, a [[{{NAMESPACE}}:PBX/Objects/Push|''push object'']] needs to [[Course13:IT Connect - 10.1 Push Object | be configured in the PBX ]]. Also, it needs to be enabled on the mobile phone for the myApps app.
This mechanism is quite similar in v12 and v13, so you can refer to [[Reference12r2:Concept Push Notifications for myPBX iOS and Android]] for more details.

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

=== App Proxy ===

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

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

=== Auto update ===

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

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

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

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

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

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

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

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

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

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

=== Used APIs ===

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

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

=== Protocols ===

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

== Related App Services ==

none

== Known limitations ==
; Button on Bluetooth headsets not functional on myApps for iOS : The button of Bluetooth headsets doesn't provide to accept or disconnect calls. The button on wired earphones does.

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

= Installation =

== Windows ==

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

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

=== MSI Parameters and install options ===

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

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

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

; EXTERNALAPPS: pre-define external applications, see [[#Call_an_external_application_for_calls|Call an external application for calls]] above
: e.g. <code>"{\"externalApps\":[{\"id\":1,\"name\":\"Wireshark\",\"path\":\"C:\\Program Files\\Wireshark\\wireshark.exe\",\"param\":\"\",\"autostart\":true]}"</code>

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

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

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

== iOS ==

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

== Android ==

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

= Configuration =

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

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

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

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

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

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

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

|-

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

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

|-

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

|-

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

|-

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

|-

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

|-

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

|-

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

|-

| Ring in headset || send ring tone for incoming to headset instead of loudspeaker (should be in phoneapp rather???)|| ✔ ||✗ ||✔ || ✗ || ✗
|}
== Start parameters for Windows ==

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

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

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

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

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

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

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

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

=Troubleshooting=

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

The following trace flags can be set:
{|
!style="text-align: left; font-weight: bold" | Abbreviation

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

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

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

; Windows :On Windows, traces are written to the <code>C:\Users\[UserName]\AppData\Local\innovaphone\myApps</code> directory.

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

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

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

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

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

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

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

= Related Articles =

* [[Reference13r1:Concept_myApps]]
* [[Reference13r1:Concept_myApps_Office_Integration]]
* [[Reference13r1:Concept_myAPPs_Search_in_local-Outlook_Contacts]]

* [[Reference10:Call_Detail_Record_CDR_PBX]]

* [[Reference12r2:Concept Push Notifications for myPBX iOS and Android]]

* [[Howto:Troubleshoot v13 Push with myApps for Android and iOS]]

* [[Reference13r1:PBX/Config/myApps]]

Howto:How to Reset IPXXX

2023-03-22T15:03:40Z

RobinBaur:

==Summary==
Different Reset Options of IPXXX

==Applies To==
This information applies to

* All innovaphone products with the latest boot code.


==More Information==
Different options resetting innovaphone devices.

* bringing to Factory default
* bringing to TFTP mode for GWLoad
* clearing config
* explaining the LED behavior

Additional Information for the following table, TFTP-Mode or TFTP-Mode + FACTORY RESET for the phones IP110, IP150, IP200, IP202, IP230, IP240

Seperating the phone from the power, press the Key/Button, keep on pressing the Key/Button, plug in the PSU or ethernet cable (in case of PoE), watch the status of the device (table: visual display), release the Key/Button after time shown in the table. If you want to reanimate this devices now with GWLoad, do not powercycle the device again. If the factory reset was successful the device is now in the defined TFTP-Mode and ready for GWLoad. If you just wanted to factory reset the device you can do a powercycle for sure.

If the factory reset was not successful please contact rma@innovaphone.com

or look at [[Howto:Get Access to Gateways if the Assistant don't boot the device.]]

{| border=1
!Device (visual display)
!Reset Button/Key
!Button pressed
!Clear Config
Firmware
Boot code update
!Pressing Button to TFTP without deleting config in seconds ca.
!Pressing Button to factory reset in seconds ca.
!GWLoad- / TFTP-Mode
!Firmware starting
!Firmware ready
!Firmware Error
|----
|IP21
(all LED's)
|Button
|ready: <5s blink, >5s constant flash

line1 + line2 + door + aux constant flash / link + act off

with plugged in ethernet cable 100M + link: <3s off, >3s normal operating state
|...

ready fast blink, line1 + line2 + door + aux off link + 100M normal operating

|3
|25
|all LED’s are constant flashing

link is blinking
|ready + line1/2 + door + aux + 100M (if link)

permanent for ca. 5s

link blinking
|ready + 100M (if link)

link blinking
|
|----
|IP400
(all LED’s)
|Button
|PPP+Tel.1+Tel.2: <5s blink, [5;8] constant flash, >8 ready + link + act constant flash

without ethernet cable plugged in: <8s off, 8s one blink, >8s off
|
|3
|25
|ready + link + act flashing constant
|<8 ready + PPP + tel1 + tel2 constant flash,

[3;10] link + act. uncoordinated flashing

>10s ready + link (if link) constant act. blinking
|ready + 100M (if link)

link blinking
|
|----
|IP3000
(all LED’s)
|Button
|<6s PRI1+PRI2+S/T+ready blink, [6;10] PRI1 + PRI2 + S/T + ready constant flash,

act + speed + link off

>10s PRI1 + PRI2 + S/T constant flash, ready + act + speed + link off

with ethernet cable plugged in: act + speed + link normal working state
|fast blink (green)
|3
|25
|all LED’s flashing permanent

ready off

link blinking
|>2 link + speed constant flashing, act blinking

<5s PRI1 + PRI2 + S/T constant flash

>5s ready constant flash, (if link) link + speed constant flashing, act blinking
|ready constant flash, (if link) link + speed constant flashing, act blinking
|blinking (green)
|----
|IP800/IP6000/IPx010
(red/green/orange ready LED )
|Button
|<6 slow gn blink

[6;10] constant red

[10;13] fast gn blink

<13 constant orange
|fast blink (green)
|3
|15 (IP800)

15-20 (IP6000/IPx010)
|constant orange
|red
|green
|blinking (red)
|----
|IP1200
|Button
|<2s alarm red constant flash, ready off

[2;7] alarm off, ready slow blink green

[7;13] alarm off, ready fast blink green

>13s alarm off, ready 2 Hz blink green
|fast blink
|3
|10
|slow flash ca. 2 Hz
|<2s alarm red constant flash

ready green constant flash

power orange constant flash

[2;4] alarm off, ready off, power orange

>4s alarm off, ready constant green flash, power constant green flash
|ready constant green flash and power constant orange flash
|alarm (red)
|----
|IP1202/IP1203
|Button
|<3s LED off

[3;10] LED blink fast blue 1 sec

>10s LED blink fast blue 1 sec,
than blink slow blue until factory reset completed,
than constant yellow/amber
|fast blink in blue
|3
|10
|constant yellow/amber
|LED red until firmware lstarted

LED blink fast red until ethernet link up

LED blink fast blue until Air Sync established

LED constant blue if Air Sync OK

|LED constant blue
|LED constant red
|----
|IP200/IP202
(red handset)
|alt key
|slow blink
|slow blink
|3
|5
|constant flash
|slow blink
|off
|constant flash
|----
|IP200A/IP210
(red handset)
|alt key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP110
(LED’s in F1 key)
|save key
|slow blink
|F1 off
|3
|10 - 15
|slow flash
ca. 2 Hz
|constant F1 flash
|off
|blinking
|----
|IP101
(MWI LED)
|backspace key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP102
(MWI LED)
|backspace key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP111
(MWI LED)
|home key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP112
(MWI LED)
|home key
|press key when power cycle, hold ca 10 sec till led flashing. Power cycle again when slow blink
|
|
|
|
|
|
|
|----
|IP230
(menu key)
|menu key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP240
(menu key)
|menu key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP241
(menu key)
|alt key
|slow blink
|fast blink
|3
|10
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP222
(MWI LED)
|ESC key or Home key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking
|----
|IP232
(MWI LED)
|ESC key or Home key
|slow blink
|fast blink
|3
|15
|slow flash
ca. 2 Hz
|on
|off
|blinking

|}

== Related Articles ==
* [[Howto:How to use gwload]]
* [[Howto:How_to_Reset_IPXXX_(V10...)]]

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

Reference13r2:Concept App Service Queues

2022-06-16T09:55:55Z

RobinBaur: /* Busy Lamp Field */ Delete user

[[Category:Concept|Apps]]
The Queues App Service can be installed on an innovaphone App Platform and will provide services for several Apps that can be used to manage calls and waiting queues with myApps. For example the Switchboard App.

== Applies To ==

* innovaphone PBX from version 13r2final

==Requirements==
* innovaphone PBX
* innovaphone Application Platform
* Firmware V13r2xx
* UsersAdminApp
* ProfileApp
* CalllistApp
* Calllist-API
* RCC-API
* configured Waiting Queues in the PBX
* configured group(s) in the PBX assigned as "Static" and "Active" to the Waiting Queue
* License “App(innovaphone-switchboard)13” (order no. 02-00050-007) per application-user

== Apps ==
=== innovaphone-switchboard ===
[[Image: Switchboard-App.png|50px]]

The Switchboard App is an attendant workstation integrated into the myApps user interface. At a switchboard workstation, an employee of a company or a telephone network operator can process incoming calls and connection requests from external or internal callers. An employee can accept connections, request information, put calls on hold, transfer them to the desired destination, or reject the connection. The calls displayed are the ones from the monitorized phone device and they are managed using the RCC-API. The Switchboard App needs a license per Switchboard user, called the Switchboard App.

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard</pre>
;Websocket
;TableUsers: to be able to replicate the users for the BLF
;Admin: to be able to edit the User object to monitor or un-monitor a waiting queue
;Pbx-API: to edit the presence information
;RCC-API: to use the RCC API to manage the calls
;Impersonation: to get the Phone App favorites

=== innovaphone-switchboard-admin ===
[[Image: Innovaphone-switchboard-admin.png|50px]]

With the Switchboard Admin App an administrator can manage the user(s) rights and can assign waiting queues to users.

The rights that can be set are:
* Edit waiting queues
* Edit presence
* Edit call diversions (and in a future version also mobility)

Parameters:
;URL: <pre>http://<ap.domain.tld>/<domain.tld>/<instance-name>/innovaphone-switchboard-admin</pre>
;Websocket
;TableUsers: to be able to replicate the users from the PBX
;Admin: to be able to assign the waiting queue groups to the user

== PBX Manager Plugins ==

=== Queues ===

With the Queues plugin the Switchboard App and Switchboard Admin App Objects can be created, edited and deleted on the PBX.

==Configuration==
# Download the Queues App via App Store.
# Install the Queues App on the App Platform.
# Create an instance in the Queues App on the App Platform.
# Make sure the Instance is running.
# Create a new Switchboard App Object with the PBX Manager Plugin.
#* Optional: Create a new SwitchboardAdmin App Object with the PBX Manager Plugin for administration purposes.
# Check that there are enough licenses and assign them to the users.
# Assign the Switchboard app to authorized users (who will be allowed to open the app) using a config template or directly on the user object.
#* Optional: Assign the SwitchboardAdmin app to authorized users who will be allowed to assign WQs & respective rights to switchboard app users).
# Configure waiting queues via the PBX manager if needed or use the Switchboard Admin App to assign existing waiting queues and manage the users rights. (existing waiting queues should have a primary group assigned, the Switchboard App will assign this primary group to the User)
#* Optional: configure a Park-key for the User with an audio reminder of x seconds to receive an audio and visual reminder of your parked call after the configured amount of seconds in the Switchboard App
#* Optional: configure a Recall time-out under PBX Generall to receive recalls from unanswered (blind)transfered calls.
# Open the Switchboard App and select a (soft)phone device on the hamburger menu.
'''To prevent the (Soft)Phone App from popping up in front of the Switchboard App with an incoming call, deselect in myApps your default (Soft)Phone App and deselect "Bring AppSharing/Video always to front" in your (Soft)Phone App.'''

==Switchboard App - User interface==
[[Image: Switchboard UI.PNG|thumb|upright=1.0|right|Switchboard App UI]]
The user interface is divided in 3 panels:
* Left panel : Busy Lamp Field and users search
* Central panel: Calls
* Right panel: Waiting queues and calls history

There is also a hamburger menu, where some configuration settings can be edited.

=== Left panel ===
==== Busy Lamp Field ====
The '''BLF''' is displayed on the left panel. There all the users replicated from the PBX are displayed and it can be undocked and displayed on another window.
Information displayed by user:
* Profile picture
* Presence
* Common name
* Phone number

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a call by using the phone button
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add a user to a BLF group
* Delete a user from a BLF group by long press left mouse. When a user already was deleted in the PBX, the BLF entry can only be removed in the Switchboard Admin App.

==== Users search ====
[[Image: Switchboard User Search.PNG|thumb|upright=1.0|right|User search]]
The '''users search''' (Search-API) can be done with the input field. This input field can also be used to directly dial using the phone button.
Information displayed by user:
* Profile picture
* Presence
* Common name

Actions allowed:
* Select a user to Transfer a call by clicking on it
* Start a chat
* Start a call
* Send an email

[[Image: Switchboard User Details.PNG|thumb|upright=1.0|right|User search]]
The user '''details''' can also be expanded by clicking on the arrow icon.
Data displayed (read only) for the user:
* Profile picture
* Common name
* SIP
* Phone number
* Email
* PBX
* Node

Data displayed that can also be edited for the user (if the user has the appropriate rights):
* Presence note
* Presence
* Call diversions
* Mobility

Actions allowed:
* Start a chat
* Start a call (by SIP and phone number)
* Send an email
* Send a "Call me back" notification by email
* Add the user to a BLF group

=== Center panel ===
On the center panel the calls are displayed.

==== Calls ====
The calls are divided in 5 sections: in the waiting queue, incoming, outgoing, parked and transferred.

Depending on the call state, different '''actions''' are allowed to manage the calls:
* Connect/Disconnect a call
* Mute/Unmute a call
* Hold/Release a call
* Park/Unpark a call
* Transfer a call to a user or connect 2 calls
* Pick up a transferred call or a call from the waiting queue

=== Right panel ===
On the right panel the waiting queues and the calls history are displayed.

==== Waiting Queues ====
On the right panel the '''waiting queues''' are displayed. They can be added by clicking on "Add waiting queue" (only displayed if the user has the appropriate right), which will automatically add the user to the given group. The calls will be displayed on the calls section and from there they can be picked up or transferred to an user.

==== Calls history ====
On this panel also the '''calls history''' is displayed, which is received from the Call List-API.

Information displayed on entry:
* Call flow
* Call information (source/destination, date and duration)

Actions allowed:
* Start a call
* Start a chat
* Send an email
* Send a "Call me back" notification by email
* Display contact information
* Add the user to a BLF group

=== Hamburger menu ===
On the hamburger menu the '''shortcuts''' can be edited and the size of the users items from the BLF can be customized.
==== Edit shortcuts ====
To edit a shortcut, the shortcut must be selected and then the desired key pressed. Afterwards it has to be clicked again to finish the editing. To remove a shorcut, select the shortcut and press the "Del" key on your keyboard.

==== Size of the user items (BLF) ====
There are 2 different size:
* Icons only: only the profile picture, presence and common name will be displayed.
* Detailed large: the phone number and the call button are displayed too.

==== Select monitored device ====
If a device is selected, all the calls from/to that device will be monitored by the app.

==Additional information==
===Licensing===
* When using the OperatorV13 license in a pre V13r2 release, and you want to use the Switchboard App instead in a > V13r2, you need to download a new license file from my.innovaphone
* Upgrade from Operator, the Operator13 license will result in 3 times App(innovaphone-switchboard)13 in addition.

==Known issues==
* When closing the Switchboard App, the user will be logout of all the waiting queues groups. When opening the app again, the user will be automatically logged-in on this groups again.
* Shortcuts may not be triggered on the Switchboard App if the app is not on focus. For this just click on the UI of the app.
* If a softphone is being monitorized, the Softphone App must be opened on background. Otherwise the RCC-API will not sent calls information to the Switchboard App.
* If no (soft)phone device has been selected on the hamburger menu of the Switboard App, the calls may be displayed duplicated because that means that the app is monitoring all the devices. To avoid this please select your default (Soft)Phone App on the phone devices section.
* As Switchboard App "Operator" you will work mainly with the Switchboard App. To have video from internal callers, you need to have a (Soft)Phone App open in the background. Deselect your Default Phone device in the myApps otherwise this App will get focus during the incoming call and on connect after answering a call. Best Practice to undock the Video from your (Soft)Phone App in the background and deselect the option "Bring AppSharing/Video always to front" as this would bring your (Soft)Phone App to the front as well.
* If LDAP contacts are not displayed on the search results, please check if the rights for the LDAP object have been given to the Switchboard App.

==Trouble shooting==
* If any issue can be reproduced, open the console output of your browser or right-click and inspect in the native client version of the Switchboard App. Clear the console output and reproduce the issue and copy past the output as a textfile and send this attached in your support ticket.

==Related Articles==
* SDK Integration (if the content is available)

Reference13r1:Apps/PbxManager/Voicemail

2022-02-24T14:03:43Z

RobinBaur: /* Add Voicemail */

Configure Voicemail Objects

=Features from Version 13r1sr10=
==Settings==

Password and Username can be set for all voicemail objects

==Add Voicemail==

*Name of the voicemail object
*sip of the voicemail object
*number of the voicemail object
*choose of a PBX
*choose of a Node
*checkmark for email notification (The SMTP account from PBX Manager -> E-Mail is used)
*checkmark for custom mode

==Voicemail Objects==
Here are the configured voicemail objects.

=Details=
==Upgrade to sr10==
If an upgrade is made of an earlier version there is an [[Reference9:Services/HTTP/Client | HTTP/Client]] entry on the PBX which authorizes the PBX against the Voicemail App to have access to the voicemail files.
After setting a new password for the voicemail objects in the PBX Manager the Services/HTTP/Client entry is obsolete. The HTTP username & password are written in the voicemail objects. They can be read by using the admin interface of the PBX (e.g. Devices) on the Voicemail tab of a voicemail object.

'''DO NOT CHANGE THE PASSWORD OF THE VOICEMAIL OBJECT IN THE ADMIN INTERFACE ON THE PBX! VOICEMAIL WILL NOT WORK ANYMORE DUE TO NO AUTHORISATION AGAINST VOICEMAIL APP ON THE APP PLATFORM'''

==Install of sr10==
If the Voicemail is installed with the install script, the voicemail object HTTP-password is the same as the Voicemail-App password.

==Custom Mode==
For Custom Mode the password for the WinSCP (as explained in the [[Howto:V13_Access_Voicemail_Files#Use_your_own_voicemail_files_with_the_voicemail-App_in_custom_mode | HOWTO article]]) can be seen in the settings in the PBX Manager (Voicemail). With these credentials start a WinSCP and copy all VM files (scripts and announcements e.g. a full httpfiles.zip (unpacked)) in the custom folder (path: domain/voicemail<language>/custom). There have to be uploaded the scripts and all announcement files.

=Related Articles=
* [[Howto:V13 Access Voicemail Files|Howto:V13 Access Voicemail Files]]

Howto:Pcap

2021-06-29T12:57:26Z

RobinBaur: /* Versions */ Where to paste the DLL

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 1.12.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 or 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, open the [http://download.innovaphone.com/ice/download/p/6.00/apps/ V6 application page], select the '''6000055''' folder and download the '''tools.zip'''.
: 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\2.6\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.
<code type="bash">
rpcap://[ip-address]/trace
</code>

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.
<code type="bash">
C:\Program Files\Wireshark>wireshark -ni rpcap://[ip-address]/trace
</code>

===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==
* 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
* Wireshark 3.2.x: DLL Version 1061 - V6 6000063 Application Packet
* Wireshark 3.4.x: DLL Version 1065 - https://store.innovaphone.com

[http://download.innovaphone.com/ice/download/p/6.00/apps/ Download the ''tools'' package]

You have to paste the DLL to folder .../wireshark/x.x/epan/

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

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

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

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

Howto13r1:Firmware Upgrade V12r2 V13r1

2021-06-08T12:03:45Z

RobinBaur: /* Slave PBX */ Disable Relay CDRs

== Possible Migration scenarios ==

* PBX without Linux Application Platform or external Linux Application Platform
** Update PBX
** Installation App Platform (see below for more details)
*** On local SSD (if Gateway is SSD capable) ''- is performed automatically by the install process''
*** On external Gateway with SSD [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#ARM_Gateway Installation of AP Platform on SSD]
*** On virtual machine (Hyper-V or VMWare) [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#App_Platform_-_x86-64_.28Virtual_Machine.29 Installation of Virtual App Platform] 
*PBX with Linux Application Platform on local SSD or CF-card
** Update PBX
** Installation App Platform (see below for more details)
***On external Gateway with SSD [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#ARM_Gateway Installation of AP Platform on SSD]
*** On virtual machine (Hyper-V or VMWare) [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#App_Platform_-_x86-64_.28Virtual_Machine.29 Installation of Virtual App Platform] 
* Virtual PBX (IPVA) without Linux Application Platform or external Linux Application Platform
** Update PBX (IPVA)
** Installation App Platform (see below for more details)
*** On external Gateway with SSD [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#ARM_Gateway Installation of AP Platform on SSD]
*** On virtual machine (Hyper-V or VMWare)[http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#App_Platform_-_x86-64_.28Virtual_Machine.29 Installation of Virtual App Platform] 

==Changes that will be performed during the install/migration process:==
* CDR0 will be changed
* DNS0 will be changed
* LOG0 will be changed
* IP0 /priority-tos will be changed
* HTTP, HTTPS Ports will be changed
* LDAP Server will be changed to "Force TLS", there for all replications and other LDAP accesses need to be changed to TLS
** Existing LDAP Server Accounts will be removed, a new user ''domain.tld\ldap-guest'' will be created. You can find the password in the App PBX Manager/AP contacts/Change configuration/Password (LDAP). The user is already set in the the created config template ''Config User''
* No of Regs w/o Pwd will be changed to "0"
* Relay CDRs are disabled under Gateway->General "Write CDRs"
* Call filters are deleted/emptied
 
All changes can be changed back to another or original value after the migration process manually if necessary. 
Make sure you store all these values upfront with a backup or manually.
Always make a backup before you start a migration process. 
We advice to update all devices to the latest available Minor Release firmware version within your existing release before updating to V13. 
A deeper look in what install does, you can find in the trainings book [[Course13:IT_Connect_-_11.0_The_individual_Device_User_Interface| The individual Device User Interface - What the Install does]]. 
'''In this scenario example we will explain you the Migration steps: PBX with Linux Application Platform on a local SSD and we install an additional Gateway with SSD for the new AP Platform'''. 
Additional components who are necessary:
* IPxx11 Gateway with new SSD
* v13 Licenses 

==Hardware Restrictions==

The same hardware restrictions as for V12r2 will apply.
* [[Howto:Firmware Upgrade V12r1 V12r2#Hardware_Restrictions]]

=== Main Memory (RAM) Considerations ===
New firmware always has more features which in turn requires more resources. Growing firmware will thus consume both more flash and RAM for sure. A given system configuration will run flawlessly after a firmware largely only if there is still enough memory left after boot. As a rough rule of thumb, a v13r1 release will consume ~ 1 MB RAM and 0.5 MB flash more compared to a v12r2 firmware.

Standard configurations which are according [[Howto:How_to_implement_large_PBXs#Technical_data_and_recommended_number_of_users_supported | to spec ]] will run on all supported hardware. However, unusual configurations may not. It is a good idea to examine both flash and RAM memory left on high load situations in your existing configuration to see if there is enough resources left for an upgrade. Please find details in [[Reference:Device Health Check]].

Special care has to be taken for old devices with less memory than suggested by current specs. Most notably, these are the older IP30x and IP2x models (hardware build 306 or less, which had 16MB RAM as opposed to 32MB in the current models). We do not recommend to upgrade such old hardware to a current firmware version.

=== Flash Memory Considerations ===
New firmware comes with new code for new features which consumes more flash memory for the firmware image. For this reason, devices may run out of flash memory during upgrade to v13r1. Here is the recommended procedure for upgrade on such devices:

* save entire configuration
* reset to factory defaults
* load saved configuration (this will reorganize flash memory usage)
* upgrade to new firmware

When there is still not enough flash memory available to store the new firmware, the web GUI will issue a ''Firmwareupdate failed:no space'' during firmware upload. If the firmware upload is done using the update client, a ''Error 0x00130001 Major FLASHMAN0 no space'' event will occur.

== Preparation before you start ==

* Check the known issues section at the bottom of this wiki-article
* Check [[Reference13r1:Release_Notes_Firmware#13r1_Known_Issues | Known Issues]] in the 13r1 Release Notes before start. If unsure if an issue affects your setup, open a presales-ticket and ask for clarification
* You have to disable ''Force HTTPS'' and ''Password protect all HTTP pages'' in the [[Reference13r1:Services/HTTP/Server|configuration]] before the update, because the installer is HTTP only and Check that you use the default http port 80 !
** If you have forgotten it and cannot reach the installer you have to access the advanced UI directly via https://ip/admin.xml?xsl=admin.xsl to deactivate it. After that, you can open the installer
* You have to decide if you want to install with IP addresses or DNS Names.
** IP Addresses: go ahead
** DNS Names: you have to make sure before installation that your PC (your browser) and all innovaphone devices receive correct DNS resolutions from your internal DNS for the used DNS-Names in the install process
** Check connectivity from and to PBX, App Platform and PC (where you run the install) with IP and or DNS
* Check your Reverse Lookup Configuration
** Until V12r2 the LDAP configuration was deployed on the user object level and thus used by the phone and myPBX. In v13r1 the forward LDAP lookup is still user specific possible, the phone uses the user directories settings (as in v12) and the myApps client uses the ''Contacts App'' entries (which can be user specific by the LDAP object configuration).
** In v13 the Reverse-Ldap-Lookup is done centrally by the PBX by the [[Reference13r1:PBX/Config/General#Common|PBX configuration]] so called ''Reverse Lookup URL''. (by default install will configure this to use your ''Contacts App''). Please check the whole [[Reference13r1:Concept_Number_Resolution_and_LDAP|Concept]] before you start.
** Please also think about that since v13 all objects from type "Node" or "PBX" has its own [[Reference13r1:PBX/Objects/PBX#Number_Mapping_.28International.2C_National.2C_Subscriber_Prefix.29|Number Mappings Settings]] and has to be configured. If you miss this configuration reverse Lookup from Slaves/Nodes will not work as expected.
* in v12 (and previous firmware versions) the CONF-interface used the available DSP - resources on a gateway without checking if Channel-license were assigned to the device. This was changed in v13. Therefore, if you use a CONF-interface without proper channel licenses, be sure to order Channel licenses before starting. To calculate the needed Channel licenses, see [[Howto:Conferences%2C_Resources_and_Licenses | Conferences, Resources and Licenses]]

== App Platform ==

At first install the gateway with the new Application Platform.

We assume it is in factory default. When a V13 firmware is already installed, you can access the gateway via its IP-address and you will get in the install GUI and can start the install process. If this is not the case, you can perform an update of the firmware to v13r1 via Maintenance, Update.

''Tip: If an V13r1 is installed but you don't get the install gui immediately you can open it via [http://ipaddress/install.htm http://ipaddress/install.htm]
* '''Install switch from HTTPS to HTTP, please be careful if you have deactivated HTTP, the redirection will fail''' !!

''If not no secure passwords should be assigned automatically, you can use the default passwords by using the URL with a password switch [http://ipaddress/install.htm?stdpwd=on http://ipaddress/install.htm?stdpwd=on]. We recommend the use of secure passwords''

''If the install doesn't start in your desired language or you want another language during the install process as the OS-language, use an appropriate language switch, for example ?lang=nl for Dutch or ?lang=en for English''

 

As first you will be asked for the username and password of the gateway.

As long as these are on the default values, you don't have to enter a value or just enter this default value.

''Tip: On the right pane of the install you find the explanations for the parameters that you can fill out.''

 
In the second step the install method will be asked. 
Here we select "Only update and network settings" to prepare the gateway for the installation of the App Platform.

[[Image:Only update and network settings.png]]

In the step "innovaphone PBX Installation" you enter the necessary network settings of the gateway and the IP address of the App Platform.

It is also possible to update the gateway to the latest possible firmware version.

Be aware that if you choose for an update of the firmware, a restart will occur.

[[Image:innovaphone PBX installation.png]]

In the next step the App Platform will be downloaded and installed and started.
 

[[Image:innovaphone App Platform.png]]

== PBX ==

After the App Platform is installed and started, we will follow-up with the update of the PBX (Master, in Distributed Systems).

To proceed we need to install the latest version of the V13r1 firmware on the existing PBX.

Before upgrading the licence master (master pbx) make sure you have v13 licences. Delete the old licences and upload the new licences to the licence master. Otherwise you can run into cpu load issues and the install prozess can fail because of the traffic of registration attempts with TLS.
<hr> 
If the firmware V13r1 is installed, you can access the gateway via its IP-address and you enter into the install process.

As first you will be asked for the username and password of the gateway.

Here you enter the credential of the existing admin user (this user should be the user admin as mentioned in the known issues) of the gateway.

The install will recognize that it is an existing PBX configuration and provides you with the appropriate Update scenarios.

We choose for "Update existing PBX with installation of an external App Platform" as the selected scenario.

[[Image:Update existing PBX with installation of an external App Platform.png]]

In case of any inconsistencies between the existing configuration file and new objects, error messages will be displayed.

Those need to be fixed before continuing the installation. Fixing is done by login to the admin-UI and change of the displayed object.
<hr> 
In the step "innovaphone PBX Installation" you enter the necessary network settings of the gateway.

It is also possible to update the gateway to the latest possible firmware version.

Be aware that if you choose for an update of the firmware, a restart will occur.

[[Image:innovaphone PBX installation2.png]]

<hr> 
''Tip: If the "Login to Devices" message appears, there was already an entry in the advanced user interface in (General/Devices Registration). Clear this entry and restart the Install process again.'' 

In the step, "Connect to external App Platform" we connect the PBX with the pre-defines gateway with the App Platform.

To proceed we enter the IP-address off the App-Platform and its password.

After pressing connect and a successful connection it will show connected.

''Tip: The default password for the App-Platform is "pwd". If you don't enter a password the default password will be used automatically. If you changed the password on the App-Platform into a more secure password yourself before starting the Install to update the PBX, Be sure you use this same password to connect. Otherwise the connection will fail and the install can't proceed.''

The installer will overwrite the AP Password, with the current Gateway Adminpassword during the installation.

 
''Tip: With the search option you can searh for available App-platform in your network that are installed on a gateway. It is required that this gateway was in default factory setting.''

''A search is not possible for an App-platforms that runs on a virtual machine. This can only be accessed via its IP-address.''

[[Image:Connect to external App Platform.png]]

''Tip: If no apps are installed and the console displays the following error message maybe there was already an entry in the advanced user interface in (General/Devices Registration). Clear this entry and restart the Install process again. 
<code>WebSocket connection to 'ws://ip.addr/domain.de/devices' failed: Error during WebSocket handshake: Unexpected response code: 404</code>'' 
<hr> 
In the following step "''innovaphone PBX Options''" you enter the configuration just as you have seen and learned during the iT Connect op iT Update training.

Here the PBX name and Domain name (System name) should match with your configuration.

''Tip: As user please add an additional (not existing) new user as myApps Admin. Name and mail cannot be in use already.''
<hr> 
In the following step "''Emergency Administrator password, please save secure''" the passwords will NOT be created randomly as you have learned during the iT Connect Training. The existing passwords of the PBX system remain as they are.
<hr> 
In the following steps the configurations will be done as learned during your [[Special:Prefixindex/Course13:|iT Connect Training]].
<hr> 
After finishing all the install steps, you can login into the system with the previously define myApps Admin in the myApps client.

''Tip: If you cant login with the myApps Admin User, go to the Advanced User Interface ([https://ip.addr/admin.xml?xsl=admin.xsl https://ip.addr/admin.xml?xsl=admin.xsl]) and assign an existing user object the Template "Config Admin". You can then login with this user into myApps.''
<hr> 
As mentioned in the beginning , one now can change the stored special settings back to its original state if necessary for the configuration
<hr> 
To give the existing users the possibility to use the innovaphone myApps, you should inherit the existing templates to the new template "Config User". If the user didn't have any template at all, then assign them o the template "Config User".

''Tip: The Users are only seen in Users App if they have the "Visible" flag in Visibility set. This is mostly done by Config Templates. So be aware that if you have another Config Template in use (that has not set the Visibility flag) even if you inheritate it from Config User it will not overwrite the older settings. So choose here the Visibility flag afterwards.''

[[Image:Change template.png]]

''Tip: Assign Administrative users to the new template "Config Admin".''

''Tip: In case you are using Apps that need a License the selectable box under License only appear after uploading the necessary license. In test mode everything works. So in case you are using test mode it is better to first upload your licenses, select the license boxes and than deactivate your test mode!

== Provisioning ==

If you want to use Provisioning and you are using Update Server/PHP Update Server 2 you have to consider that your phone needs to reach config.innovaphone.com via Update URL. 
That means that if you already provide an Update URL via DHCP that the Provisioning process will not be possible. Therefore delete the Update URL in your DHCP Server. 
In case you are using Update Server/PHP Update Server 2 for Certificates etc. your phone needs to reach your old Update Server after provisioning again. (further details will follow) 

Please Check: [[Reference13r1:Services/Update]]

== Assign Hardware of a User to a phone or softwarephone App ==

This can be done by the administrator in UsersAdmin App. 
Alternative the User can do this via his Profile. At the instruction from myApps the user can be shown on which point he can assign the app.

[[Image:Profile PhoneApp.png]]

== Reverse Proxy ==

Reverse Proxy migration must be done after upgrade the (first) pbx.

Via the advanced user interface install the latest V13r1 firmware.

In the next step we need the Devices App URL. Via the advanced user interface, in General/Devices Registration/Devices App URL.

Copy this URL.

[[Image:Device Registration2.png]]

Paste this URL in the advanced user interface of the Reverse Proxy in the field General/Devices Registration/Devices App URL.

From now on this device can be found in the Devices App in Devices.

The MAC address and a wrench symbol will be displayed.

Here you can now assign a meaningful name and the domain to the device.

[[Image:Devices.png]]

Via Categories you should assign this gateway also to the appropriate Category.
 

[[Image:Devices2.png]]

''Tip: Now the device configurations are assigned to all devices and the corresponding category(s)''

''These include at least:  Alarmserver Global, Media Global, NTP-settings''
 

Via the PBX Manager App and the Reverse Proxy plugin you can now configure the Reverse Proxy.

You should add here a new Host entry for the App Platform in the Reverse Proxy via the option "Add Host".

The DNS name of the App Platform will be displayed in the next step. Select the DNS name and it will be added to the Reverse Proxy entries.

Via the advanced user interface you have to change the URLs for every hostname pointing to an PBX (Slaves and Standby).
 

In the first http forward field you need to enter the following string /PBX0/APPCLIENT/appclient.htm and forward it to the appropriate IP-address with the port numbers 80 and 443 and tag the checkbox Default.
 

At least the following entries should be available as shown in the picture below.
 

[[Image:Reverse Proxy Entries.png]]
 

== Slave PBX ==

To proceed we need to install the latest version of the V13r1 firmware on the Slave PBX.

If the latest firmware V13r1 is installed, you can access the gateway via its IP-address and you enter into the install process. If there is no standard password you have to enter the admin credentials to login to the gateway.

In the next step select "Manual Configuration" and you will enter the Advanced User Interface.

In the following step we need the Device URL. You can find it on the Master PBX under General/Devices Registration/Devices App URL. Copy the complete URL.



[[Image:Device Registration2.png]]

Paste this URL via the Advanced User Interface of the Slave PBX under General/Devices Registration/Devices App URL.

Now you can find this Gateway in the Devices App within Devices. It will be displayed with its MAC-address and a wrench symbol.

Here you can now assign a meaningful name and the domain to the device.

[[Image:Devices.png]]

Via Category you should assign the Gateway to the appropriate category.

[[Image:Devices2.png]]

''Tip: Now the device configurations are assigned to all devices and the corresponding category(s)''

''These include at least: Alarmserver Global, Media Global, NTP-settings''

For provisioning new devices to the Slave PBX you need a new provisioning category and a new phone device configuration.
In the training books you can find how to do this for [http://wiki.innovaphone.com/index.php?title=Course13:IT_Connect_-_06_Managing_Devices#Categories categories] and [http://wiki.innovaphone.com/index.php?title=Course13:IT_Connect_-_06_Managing_Devices#Phone phone configuration]. In the device configuration you need to specify the Slave PBX as Primary Gatekeeper.

Next Steps:

On a Slave you should change some configuration if it needed.

- Slave PBX registration to the Master must be done with authentication. We prefer to do this with H323/TLS as Registration protocol.

- Slave Replication must be done with use TLS. Check if the Objects will be synchronized.

- For the new Reporting App the Gateway/CDR0 must be adapted accordingly to receive the CDRs of the slave. You can copy the values from the Master.

- Disable Relay CDRs under Gateway->General "Write CDRs"

- For reverse lookup you have to configure the Reverse Lookup URL and also the appropriate Prefixes under PBX/General.


At this point no "Edit profile" menu item appears in the myApps client of a Slave PBX user. You can fix this in the [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Service_Users#Users PBX Manager Plugin Users]. Under "Change configuration" select the Slave PBX and activate the displayed app under "Use as profile".''

On the Slave PBX go to Services, HTTP, Client, and add the necessary URL's for Events, Voicemail, files, backup-files.

You can copy and paste the URL's from the Master. Be aware that you have to set the new Passwords should also be changed on the Master, instances, PBX Objects and HTTP Client!

''Tip: If the redirect from the slave or standby PBX to the myApps weblauncher does not work, you have to enter the following via Command or the webbrowser:''
!config change HTTP0 /home PBX0/APPCLIENT/appclient.htm
!config write
!config activate
!reboot

== IP Phones ==

Proceed to install the latest version of the V13r1 firmware on the IP Phones.

To update the existing IP Phones to V13 there are two possibilities.

In a large environment with a lot of IP Phones you probably already have an update server.

If an update server is available,

''- Change the Update Server script to update all phones with a Firmware upgrade to V13''

''- If the Phones are updated to V13, execute the update script with a change to delete the Update URL and add the Devices App URL, you can have a look of the config example below''
*This script command line will erase the update entry under [[Reference13r1:Services/Update]]
config change UP1
config write
config activate
*This script command line will configure the Websocket link under [[Reference13r1:General/Devices-Registration]] to connect the phone to its respective Devices App. More about this provisioning method you can read under [[Reference13r1:Concept_Provisioning#Automatic_provisioning]].
Let's assume the auto provisioning URL (visible in the Devices App) looks like this: 
wss://apdnsname.com/domain.com/devices/sysclients?domain=domain.com&token=1j2h3j12h3&category=testcategory
config change SYSCLIENT /sysadmin wss%3A%2F%2Fapdnsname.com%2Fdomain.com%2Fdevices%2Fsysclients%3Fdomain%3Ddomain.com%26token%3D1j2h3j12h3%26category%3Dtestcategory
config write
config activate

If no update server is available,

''- Manual firmware upgrade to V13''

''- Manually edit the Devices App URL under General, Devices Registration, Devices App URL''

''- In Devices add the Phones to the appropriate Domain and category and give it a useful name to find a users phone via the search option in devices (unfortunately manual one by one)''

== STUN / TURN / Standby / DECT ==

To proceed we need to install the latest version of the V13r1 firmware on the existing Gateway.

If the latest firmware V13r1 is installed, you can access the gateway via its IP-address and you enter into the install process. If there is no standard password you have to enter the admin credentials to login to the gateway.

In the next step select "Manual Configuration" and you will enter the Advanced User Interface.

In the following step we need the Device URL which can be found on two different ways.



# Via the Advanced User Interface of the PBX
In General/Devices Registration/Devices App URL copy the complete URL.

[[Image:Device Registration2.png]]

Paste this URL via the Advanced User Interface of the Reverse Proxy Gateway in General/Devices Registration/Devices App URL .

Now you can find this Gateway in the Devices App within Devices. It will be displayed with its MAC-address and a wrench symbol.

Here you can now assign a meaningful name and the domain to the device.

[[Image:Devices.png]]

Via Category you should assign the Gateway to the appropriate category.

[[Image:Devices2.png]]

''Tip: Now the device configurations are assigned to all devices and the corresponding category(s)''

''These include at least: Alarmserver Global, Media Global, NTP-settings''

''Tip: For a Slave, Standby PBX or DECT you should select TLS as Replication protocol.''

''Tip: If the redirect from the slave or standby PBX to the myApps weblauncher does not work, you have to enter the following via Command or the webbrowser:''
!config change HTTP0 /home PBX0/APPCLIENT/appclient.htm
!config write
!config activate
!reboot

== Configuration Changes ==
=== SNMP disabled by default ===
Up and including v12r2, SNMP was by default activated on a innovaphone device. In v13 it is by default deactivated, it can be activated by a new [[Reference13r1:Services/SNMP | Enable Checkmark]]. As a result, if you upgrade to v13 firmware SNMP is deactivated and needs to be enabled if SNMP is needed in the customer setup.

===Config line size was increased to 32KB===

Downgrade from 13r1 to 12r2 (or older firmware) will result in objects with a too large [[Howto:Config_size_Limitations#Global | config line]] being dropped.

===New visibility option "Visible"===
[[Reference13r1:PBX/Objects/Visibility | Visible]] allow the PBX users to be listed in the users App. Attention : If a visibility is configured at the PBX user object, Visible option is not set with the install automatically and must be set manually.

===New "App" field in object Devices property===
The App field allows you to configure either "phone" or "softphone" in order to get the respective app in user's myApps.

Note: If there are Devices already present (hardware ID), the App field is not set automatically by the install and must be set manually.

Furthermore, the Name field should also be filled out with the name of your myApps softphone App or phone App.

Example :
<table>
<tr>
<th>Hardware Id</th>
<th>Name</th>
<th>App</th>
</tr>
<tr>
<td>009033000000</td>
<td>myDeskphoneName</td>
<td>phone</td>
</tr>
<tr>
<td>exampleSoft</td>
<td>mySoftphoneName</td>
<td>softphone</td>
</tr>
</table>

For more details of the Devices properties, refer to [[Reference13r1:PBX/Objects#Devices_Input_Fields|the corresponding article]].

=== DHCP1 Mode switch to client ===

During the install process, the DHCP1 mode of the Gateway will be switched to client mode by the install script.

== Known issues ==
* For the known issues, please have a look into our [[Reference13r1:Release_Notes_Firmware]]
** The Headline '''13r1 Release Notes''' will list the known issues.
* install did not finish if you have configured ETH0 as DHCP Server and ETH1 DHCP Client (connected to corporate network, internet access). You have to Swap the ETH interfaces before you start the install.

===Default Admin account===
There where issues reported when the admin account used during the install was not the username admin.

Please make sure that your default system admin account does have the name admin and do not use a custom defined name!
If you want to have a custom admin account with a different username, please add it as a separate account under, General, Admin, Additional Administrator Accounts.
Before starting the install use this admin account to successfully log in to the system.
The install will use this account during the instal process to install all PBX objects and to install the Application Platform.

===LDAP Directory Service on IP Phones via Reverse Proxy===
Currently by default IP phones registered via Reverse Proxy are NOT able to search in the PBX users and in the external LDAP resource (for example the Contacts database) To enable the LDAP search on the Phones we have to do some manual modification.

For more details: [http://wiki.innovaphone.com/index.php?title=Howto:V13_LDAP_IP_Phones_Directory_Services_via_Reverse_Proxy&action=submit: Howto V13 LDAP IP Phones Directory Services via Reverse Proxy]

===PBX Replication===
The PBX LDAP Replication won‘t work if Master and Slave have different major Versions (V13/V12). The reason is that the binding user is different in V13 and V12. The binding user in V12 is called ''_PBX_''. In V13 the binding user is called ''[domain]\_PBX_''. You should either use the same major Version or use the LDAP replicator at [[Reference9:Services/LDAP/Replicator|Services->LDAP->Replicator]].

===Fax App===
The Fax App currently supports only dial plan having all objects in the root node. For details see [[Reference13r1:Concept_App_Fax#Known_issues | Concept App Fax: Known issues]].

===Install No-DNS mode in V13r1 sr7===
The install process in No-DNS mode stops when installing events.
This can be avoided by entering the DNS name in the hosts file of the PC you are installing with. The hosts file can only be edited with admin rights and is located in the folder:
<code> C:\Windows\System32\drivers\etc\hosts </code>

This will be fixed in V13r1 sr8.

===LDAP Server===
The Upgrade Install will overwrite any existing LDAP Server(Services->LDAP->server) account. If you have a special account (e.g DECT-Replication), it must be reconfigured afterwards.

===Soap===
In v12 the PBX returned for a [[Reference10:Concept_SOAP_API#string_LocationUrl.28string_v501.2C_string_v700.2C_string_v800.2C_string_vx1000.2C_string_location.2C_bool_tls.29|LocationUrl - query]] a URL using an IP-address as host, in V13 a DNS-name is used instead. As a result, the DNS-Server used by the Soap-Client needs to return the expected IP-addresses.

== Related Articles ==
*[[Howto:Guideline V5 to V6 upgrade]]
*[[Howto:Upgrade Issues V5 to V6]]
*[[Howto:Firmware Upgrade V6 V7]]
*[[Howto:Firmware Upgrade V7 V8]]
*[[Howto:Firmware Upgrade V8 V9]]
*[[Howto:Firmware Upgrade V9 V10]]
*[[Howto:Firmware Upgrade V10 V11r1]]
*[[Howto:Firmware Upgrade V11r1 V11r2]]
*[[Support:Special_Precaution_required_when_upgrading_IPxx11_Gateways_from_pre-SR14_Firmware_Versions]]
* [[Howto:Firmware Upgrade V11r2 V12r1]]
* [[Howto:Firmware Upgrade V12r1 V12r2]]
* [[Reference13r1:Concept_Number_Resolution_and_LDAP]]
[[Category:Howto|{{PAGENAME}}]]

Reference13r1:Concept App Services Files

2020-10-22T08:57:20Z

RobinBaur: /* Features */

The App Services Files is an App Service which can be installed on an innovaphone App Platform. It is used to store own files. It provides these files for other apps via an API.

=Features=
Database for own files (for example Announcements, Pictures and so on)

* Upload via Drag and Drop (~100 MB) due to implementation
* Move, Delete, Download of files, Share of folders
* API for other apps

Files can be shared via WebDAV. For this you have to select "Share with user and password" for the folder you want to share. The URL for this share is ''https://app.company.tld/company.tld/files/root/'' (regarding to your AppPlatform URL).
If you want to share the folder "announcements" for excample, your share URL is ''https://app.company.tld/company.tld/files/root/announcements/''

=Requirements=
innovaphone PBX and App Platform from on version 13r1

== Technical Overview ==
[[Image:concept_files.png]]

=Details=

=App Services=

== innovaphone-files ==
Main app to manage the files and folders.

Parameters:

;Websocket: to get the URL of the Devices App itself which is used for provisioning

== innovaphone-files-api ==
API to get announcements from files app.

Parameters:

;Hidden: FilesApi must be a hidden App
;Websocket: to ??? ''TBD''

=Troubleshooting=


= Related Articles =

Reference9:Phone/User/Function-Keys/Partner

2020-08-28T08:40:44Z

RobinBaur: /* Partner */

== Partner ==

''' Idle State ''' 
The Partner has three states.
* '''Idle''': the partner's phone has no calls. The key initiates a call to the partner
* '''Alerting''': the partner's phone has an alerting call. The key initiates a call of the alerting call
* '''Busy''': the partner's phone has an active call. The key does not perform any action
Only the text and icon shown for the ''Idle State'' can be defined.

''' Partner identification''' 
Defines the partner the state of which is monitored by the key. It is recommended to use either ''Number'' or ''Name'', not both. If you defined both, the ''Number'' takes precedence.

'''Partner Type''' 
Selects the operation type of the key:
* ''Default'' - normal partner key
* ''Executive'' - Enables special executive/secretary functionality. It is used on a secretary's phone to use the CLIP (extension) of the partners ''Executive'' object to execute calls
* ''Secretary'' - Enables special executive/secretary functionality. It is used on an executive's phone to display ''Call Forward'' and primary or secondary secretary join/leave group state. This feature uses ''Subscribe for Presence'' functionality (hence ''Subscribe for Presence'' must be enabled). Also you must set the ''Name'' (and not the ''Number'') in the ''Partner identification''.

'''Perform intrusion if partner is busy''' 
When calling the partner with the key and if the partner already has an active call, a call intrusion is performed. There are two ''Type''s available: ''Conference'' and ''silent monitoring''. The partner has to grant the visibility right ''calls'' to the user which uses this partner key.

'''Subscribe for Presence''' 
If checked, the key will subscribe for the partner's presence state. The presence information will be shown. This is required for a ''Secretary'' partner type (see above).

'''Subscribe for Dialog Info''' 
If checked, the key will subscribe for the partner's call state information. No ''group indications'' are required nor evaluated then. Otherwise, the partner key requires receipt of [[Reference9:PBX/Objects#Object_Properties | ''group indications'' ]] from the partner to work. ''Executive''/''Secretary'' types do require ''group indications'', so ''Subscribe for Dialog Info'' is available for ''Default'' types.

Please note that dialog info subscriptions will work across PBXs, whereas group indications don't. Dialog info subscriptions are subject to standard [[ {{NAMESPACE}}:PBX/Objects/Edit Allow | access rights ]].

'''Hide calling party in alerting state''' 
By default the calling party info is shown in the key label area when a call is ringing at the partners phone. This may be suppressed by this check-mark.

'''Hide calling party in ringback state''' 
By default a call picked up from the partners phone by pressing this key is indicated as a normal inbound call and the calling party info is shown. This may be suppressed by this check-mark.

'''Show connected party in busy state''' 
By default the party info of the party the partner is currently speaking to is not shown. This may be changed by this check-mark.

'''Do not pick up an alerting Call''' 
By default a call ringing at the partners phone is picked up when this key is pressed. This may be suppressed by this check-mark.

'''Audible Signal after alerting [sec]''' 
Notify pending call at own extension for partner after [sec]. By default disabled.

Reference9:Phone/User/Function-Keys/Partner

2020-08-28T08:39:53Z

RobinBaur: /* Partner */ Call intrusion

== Partner ==

''' Idle State ''' 
The Partner has three states.
* '''Idle''': the partner's phone has no calls. The key initiates a call to the partner
* '''Alerting''': the partner's phone has an alerting call. The key initiates a call of the alerting call
* '''Busy''': the partner's phone has an active call. The key does not perform any action
Only the text and icon shown for the ''Idle State'' can be defined.

''' Partner identification''' 
Defines the partner the state of which is monitored by the key. It is recommended to use either ''Number'' or ''Name'', not both. If you defined both, the ''Number'' takes precedence.

'''Partner Type''' 
Selects the operation type of the key:
* ''Default'' - normal partner key
* ''Executive'' - Enables special executive/secretary functionality. It is used on a secretary's phone to use the CLIP (extension) of the partners ''Executive'' object to execute calls
* ''Secretary'' - Enables special executive/secretary functionality. It is used on an executive's phone to display ''Call Forward'' and primary or secondary secretary join/leave group state. This feature uses ''Subscribe for Presence'' functionality (hence ''Subscribe for Presence'' must be enabled). Also you must set the ''Name'' (and not the ''Number'') in the ''Partner identification''.

'''Perform intrusion if partner is busy''' 
When calling the partner with the key and if the partner already has an active call, a call intrusion is performed. There are two ''Type''s available: ''Conference'' and ''silent monitoring''. The partner has to grant the visibility right 'calls' to the user which uses this partner key.

'''Subscribe for Presence''' 
If checked, the key will subscribe for the partner's presence state. The presence information will be shown. This is required for a ''Secretary'' partner type (see above).

'''Subscribe for Dialog Info''' 
If checked, the key will subscribe for the partner's call state information. No ''group indications'' are required nor evaluated then. Otherwise, the partner key requires receipt of [[Reference9:PBX/Objects#Object_Properties | ''group indications'' ]] from the partner to work. ''Executive''/''Secretary'' types do require ''group indications'', so ''Subscribe for Dialog Info'' is available for ''Default'' types.

Please note that dialog info subscriptions will work across PBXs, whereas group indications don't. Dialog info subscriptions are subject to standard [[ {{NAMESPACE}}:PBX/Objects/Edit Allow | access rights ]].

'''Hide calling party in alerting state''' 
By default the calling party info is shown in the key label area when a call is ringing at the partners phone. This may be suppressed by this check-mark.

'''Hide calling party in ringback state''' 
By default a call picked up from the partners phone by pressing this key is indicated as a normal inbound call and the calling party info is shown. This may be suppressed by this check-mark.

'''Show connected party in busy state''' 
By default the party info of the party the partner is currently speaking to is not shown. This may be changed by this check-mark.

'''Do not pick up an alerting Call''' 
By default a call ringing at the partners phone is picked up when this key is pressed. This may be suppressed by this check-mark.

'''Audible Signal after alerting [sec]''' 
Notify pending call at own extension for partner after [sec]. By default disabled.

Reference13r1:Concept App Service Reports

2020-05-27T10:00:51Z

RobinBaur: /* Database access */

[[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 or myPBX and to create call reports.

== Applies To ==

* innovaphone PBX from version 13r1

== Technical Overview ==
[[Image:Concept_reporting.png]]

== Apps ==

=== innovaphone-reporting ===
This is the Reporting UI App.

=== innovaphone-calllist ===
This is the Call list App.

Parameters:

;Websocket:

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

=== mypbx ===
This is the interface for the support of the old myPBX client.

== PBX Manager Plugins ==

=== Reporting ===

With the Reporting plugin App objects can be created, edited and deleted for the provided Apps. 
 
====Configuration====
There is also a configuration to enable compatibility for myPBX call lists in the ''AP-Reporting'' Plugin in the PBXManager. You have also to configure the new created account in the [[Reference13r1:PBX/Config/myPBX | MyPBX]] configuration.

== Concepts ==
===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference13r1: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, conn_duration, alert_duration, call_duration, billing_duration, utc_stamp, cause, remote_e164, remote_h323, remote_dn, call_list, missed_call, status, further, user_id, callback_e164, callback_h323, callback_dn, callback_time, remote_clir
* '''event fields:''' id, cdr_id, msg, ext, e164, h323, dn, conf, cause, time, 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 access ===

You have to manually grant access to the reporting database, e.g. for specific IP addresses, inside the file '''/mnt/sda2/pgsql/pg_hba.conf''', as the default configuration doesn't allow access from external. 
You can find the documentation for this file here: https://www.postgresql.org/docs/11/auth-pg-hba-conf.html 
 
The user admin is not allowed to access pg_hba.conf. You have to use the root user. Access with the root user is described [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#Default_credentials here]. 
 
After editing pg_hba.conf, the database-service has to be restarted with this command: 
/etc/init.d/S50postgresql restart
 
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 [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_Talking_to_the_v13_Application_Platform_using_PHP PHP-access]
#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>

== Appendix ==

Reference13r1:Concept App Service Reports

2020-05-27T09:59:18Z

RobinBaur: /* Database access */

[[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 or myPBX and to create call reports.

== Applies To ==

* innovaphone PBX from version 13r1

== Technical Overview ==
[[Image:Concept_reporting.png]]

== Apps ==

=== innovaphone-reporting ===
This is the Reporting UI App.

=== innovaphone-calllist ===
This is the Call list App.

Parameters:

;Websocket:

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

=== mypbx ===
This is the interface for the support of the old myPBX client.

== PBX Manager Plugins ==

=== Reporting ===

With the Reporting plugin App objects can be created, edited and deleted for the provided Apps. 
 
====Configuration====
There is also a configuration to enable compatibility for myPBX call lists in the ''AP-Reporting'' Plugin in the PBXManager. You have also to configure the new created account in the [[Reference13r1:PBX/Config/myPBX | MyPBX]] configuration.

== Concepts ==
===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference13r1: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, conn_duration, alert_duration, call_duration, billing_duration, utc_stamp, cause, remote_e164, remote_h323, remote_dn, call_list, missed_call, status, further, user_id, callback_e164, callback_h323, callback_dn, callback_time, remote_clir
* '''event fields:''' id, cdr_id, msg, ext, e164, h323, dn, conf, cause, time, 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 access ===

You have to manually grant access to the reporting database, e.g. for specific IP addresses, inside the file '''/mnt/sda2/pgsql/pg_hba.conf''', as the default configuration doesn't allow access from external. 
You can find the documentation for this file here: https://www.postgresql.org/docs/11/auth-pg-hba-conf.html 
 
The user admin is not allowed to accesss pg_hba.conf. You have to use the root user. Access with the root user is described [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#Default_credentials here]. 
 
After editing pg_hba.conf, the database-service has to be restarted with this command: 
/etc/init.d/S50postgresql restart
 
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 [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_Talking_to_the_v13_Application_Platform_using_PHP PHP-access]
#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>

== Appendix ==

Reference13r1:Concept App Service Reports

2020-05-27T09:57:35Z

RobinBaur: /* Database access */

[[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 or myPBX and to create call reports.

== Applies To ==

* innovaphone PBX from version 13r1

== Technical Overview ==
[[Image:Concept_reporting.png]]

== Apps ==

=== innovaphone-reporting ===
This is the Reporting UI App.

=== innovaphone-calllist ===
This is the Call list App.

Parameters:

;Websocket:

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

=== mypbx ===
This is the interface for the support of the old myPBX client.

== PBX Manager Plugins ==

=== Reporting ===

With the Reporting plugin App objects can be created, edited and deleted for the provided Apps. 
 
====Configuration====
There is also a configuration to enable compatibility for myPBX call lists in the ''AP-Reporting'' Plugin in the PBXManager. You have also to configure the new created account in the [[Reference13r1:PBX/Config/myPBX | MyPBX]] configuration.

== Concepts ==
===Database Structure===

====cdrs====
Each received cdr-xml is formed by a cdr tag and an undefined number of event and group tags.
(Refer to: [[Reference13r1: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, conn_duration, alert_duration, call_duration, billing_duration, utc_stamp, cause, remote_e164, remote_h323, remote_dn, call_list, missed_call, status, further, user_id, callback_e164, callback_h323, callback_dn, callback_time, remote_clir
* '''event fields:''' id, cdr_id, msg, ext, e164, h323, dn, conf, cause, time, 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 access ===

You have to manually grant access to the reporting database, e.g. for specific IP addresses, inside the file '''/mnt/sda2/pgsql/pg_hba.conf''', as the default configuration doesn't allow access from external. 
You can find the documentation for this file here: https://www.postgresql.org/docs/11/auth-pg-hba-conf.html 
 
The user admin is not allowed to accesss pg_hba.conf. You have to use the root user. Access with the root user is described here: 
[http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#Default_credentials] 
 
After editing pg_hba.conf, the database-service has to be restarted with this command: 
/etc/init.d/S50postgresql restart
 
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 [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_Talking_to_the_v13_Application_Platform_using_PHP PHP-access]
#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>

== Appendix ==

Howto13r1:Firmware Upgrade V12r2 V13r1

2020-01-09T13:17:12Z

RobinBaur: /* Possible Migration scenarios */

== Possible Migration scenarios ==

* PBX without Linux Application Platform or external Linux Application Platform
** Update PBX
** Installation App Platform (see below for more details)
*** On local SSD (if Gateway is SSD capable) ''- is performed automatically by the install process''
*** On external Gateway with SSD [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#ARM_Gateway Installation of AP Platform on SSD]
*** On virtual machine (Hyper-V or VMWare) [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#App_Platform_-_x86-64_.28Virtual_Machine.29 Installation of Virtual App Platform] 
*PBX with Linux Application Platform on local SSD or CF-card
** Update PBX
** Installation App Platform (see below for more details)
***On external Gateway with SSD [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#ARM_Gateway Installation of AP Platform on SSD]
*** On virtual machine (Hyper-V or VMWare) [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#App_Platform_-_x86-64_.28Virtual_Machine.29 Installation of Virtual App Platform] 
* Virtual PBX (IPVA) without Linux Application Platform or external Linux Application Platform
** Update PBX (IPVA)
** Installation App Platform (see below for more details)
*** On external Gateway with SSD [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#ARM_Gateway Installation of AP Platform on SSD]
*** On virtual machine (Hyper-V or VMWare)[http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Platform#App_Platform_-_x86-64_.28Virtual_Machine.29 Installation of Virtual App Platform] 

'''Changes that will be performed during the install/migration process:'''
* CDR0 will be changed
* DNS0 will be changed
* LOG0 will be changed
* IP0 /priority-tos will be changed
* HTTP Client Authenticated URLs 1-n will be changed, depending on number of installed voicemails
* HTTP, HTTPS Ports will be changed
* STUN Server will be changed
* TURN Server will be changed (Turn User & PW)
* LDAP Server will be changed to "Force TLS", there for all replications and other LDAP accesses need to be changed to TLS
** Existing LDAP Server Accounts will be removed, a new user ''domain.tld\ldap-guest'' will be created. You can find the password in the App PBX Manager/AP contacts/Change configuration/Password (LDAP). The user is already set in the the created config template ''Config User''
* No of Regs w/o Pwd will be changed to "0"
* Relay CDRs are disabled under Gateway->General "Write CDRs"
 
All changes can be changed back to another or original value after the migration process manually if necessary. 
Make sure you store all these values upfront with a backup or manually.
Always make a backup before you start a migration process. 
We advice to update all devices to the latest available Minor Release firmware version within your existing release before updating to V13. 
A deeper look in what install does, you can find in the trainings book [[Course13:IT_Connect_-_11.0_The_individual_Device_User_Interface| The individual Device User Interface - What the Install does]]. 
'''In this scenario example we will explain you the Migration steps: PBX with Linux Application Platform on a local SSD and we install an additional Gateway with SSD for the new AP Platform'''. 
Additional components who are necessary:
* IPxx11 Gateway with new SSD
* v13 Licenses 

== Preparation before you start ==
* You have to disable ''Force HTTPS'' in the [[Reference13r1:Services/HTTP/Server|configuration]] before the update, because the installer is HTTP only
** If you have forgotten it and cannot reach the installer you have to access the advanced UI directly via https://ip/admin.xml?xsl=admin.xsl to deactivate it. After that you can open the installer
* You have to decide if you want to install with IP addresses or DNS Names.
** IP Addresses: go ahead
** DNS Names: you have to make sure before installation that your PC (your browser) and all innovaphone devices receive correct dns resolutions from your internal DNS for the used DNS-Names in the install process
* Check your Reverse Lookup Configuration
** Until V12r2 the LDAP configuration was deployed on the user object level and thus used by the phone and myPBX. In v13r1 the forward LDAP lookup is still user specific possible, the phone uses the user directories settings (as in v12) and the myApps client uses the ''Contacts App'' entries (which can be user specific by the LDAP object configuration). In v13 the Reverse-Ldap-Lookup is done centrally by the PBX by the [[Reference13r1:PBX/Config/General#Common|PBX configuration]] so called ''Reverse Lookup URL''. (by default Install will configure this to use your ''Contacts App''). Please check the whole [[Reference13r1:Concept_Number_Resolution_and_LDAP|Concept]] before you start.

== App Platform ==

At first install the gateway with the new Application Platform.

We assume it is in factory default. When a V13 firmware is already installed, you can access the gateway via its IP-address and you will get in the install GUI and can start the install process. If this is not the case, you can perform an update of the firmware to v13r1 via Maintenance, Update.

''Tip: If an V13r1 is installed but you don't get the install gui immediately you can open it via [http://ipaddress/install.htm http://ipaddress/install.htm]
* '''Install switch from HTTPS to HTTP, please be careful if you have deactivated HTTP, the redirection will fail''' !!

''If not no secure passwords should be assigned automatically, you can use the default passwords by using the URL with a password switch [http://ipaddress/install.htm?stdpwd=on http://ipaddress/install.htm?stdpwd=on]. We recommend the use of secure passwords''

''If the install doesn't start in your desired language or you want another language during the install process as the OS-language, use an appropriate language switch, for example ?lang=nl for Dutch or ?lang=en for English''

 

As first you will be asked for the username and password of the gateway.

As long as these are on the default values, you don't have to enter a value or just enter this default value.

''Tip: On the right pane of the install you find the explanations for the parameters that you can fill out.''

 
In the second step the install method will be asked. 
Here we select "Only update and network settings" to prepare the gateway for the installation of the App Platform.

[[Image:Only update and network settings.png]]

In the step "innovaphone PBX Installation" you enter the necessary network settings of the gateway and the IP address of the App Platform.

It is also possible to update the gateway to the latest possible firmware version.

Be aware that if you choose for an update of the firmware, a restart will occur.

[[Image:innovaphone PBX installation.png]]

In the next step the App Platform will be downloaded and installed and started.
 

[[Image:innovaphone App Platform.png]]

== PBX ==

After the App Platform is installed and started, we will follow-up with the update of the PBX (Master, in Distributed Systems).

To proceed we need to install the latest version of the V13r1 firmware on the existing PBX.

Before upgrading the licence master (master pbx) make sure you have v13 licences. Delete the old licences and upload the new licences to the licence master. Otherwise you can run into cpu load issues and the install prozess can fail because of the traffic of registration attempts with TLS.
<hr> 
If the firmware V13r1 is installed, you can access the gateway via its IP-address and you enter into the install process.

As first you will be asked for the username and password of the gateway.

Here you enter the credential of the existing admin user (most of the time it is admin) of the gateway.

The install will recognize that it is an existing PBX configuration and provides you with the appropriate Update scenarios.

We choose for "Update existing PBX with installation of an external App Platform" as the selected scenario.

[[Image:Update existing PBX with installation of an external App Platform.png]]

In case of any inconsistencies between the existing configuration file and new objects, error messages will be displayed.

Those need to be fixed before continuing the installation. Fixing is done by login to the admin-UI and change of the displayed object.
<hr> 
In the step "innovaphone PBX Installation" you enter the necessary network settings of the gateway.

It is also possible to update the gateway to the latest possible firmware version.

Be aware that if you choose for an update of the firmware, a restart will occur.

[[Image:innovaphone PBX installation2.png]]

<hr> 
''Tip: If the "Login to Devices" message appears, there was already an entry in the advanced user interface in (General/Devices Registration). Clear this entry and restart the Install process again.'' 

In the step, "Connect to external App Platform" we connect the PBX with the pre-defines gateway with the App Platform.

To proceed we enter the IP-address off the App-Platform and its password.

After pressing connect and a successful connection it will show connected.

''Tip: The default password for the App-Platform is "pwd". If you don't enter a password the default password will be used automatically. If you changed the password on the App-Platform into a more secure password yourself before starting the Install to update the PBX, Be sure you use this same password to connect. Otherwise the connection will fail and the install can't proceed.''

The installer will overwrite the AP Password, with the current Gateway Adminpassword during the installation.

 
''Tip: With the search option you can searh for available App-platform in your network that are installed on a gateway. It is required that this gateway was in default factory setting.''

''A search is not possible for an App-platforms that runs on a virtual machine. This can only be accessed via its IP-address.''

[[Image:Connect to external App Platform.png]]

''Tip: If no apps are installed and the console displays the following error message maybe there was already an entry in the advanced user interface in (General/Devices Registration). Clear this entry and restart the Install process again. 
<code>WebSocket connection to 'ws://ip.addr/domain.de/devices' failed: Error during WebSocket handshake: Unexpected response code: 404</code>'' 
<hr> 
In the following step "''innovaphone PBX Options''" you enter the configuration just as you have seen and learned during the iT Connect op iT Update training.

Here the PBX name and Domain name (System name) should match with your configuration.

''Tip: As user please add an additional (not existing) new user as myApps Admin. Name and mail cannot be in use already.''
<hr> 
In the following step "''Emergency Administrator password, please save secure''" the passwords will NOT be created randomly as you have learned during the iT Connect Training. The existing passwords of the PBX system remain as they are.
<hr> 
In the following steps the configurations will be done as learned during your [[Special:Prefixindex/Course13:|iT Connect Training]].
<hr> 
After finishing all the install steps, you can login into the system with the previously define myApps Admin in the myApps client.

''Tip: If you cant login with the myApps Admin User, go to the Advanced User Interface ([https://ip.addr/admin.xml?xsl=admin.xsl https://ip.addr/admin.xml?xsl=admin.xsl]) and assign an existing user object the Template "Config Admin". You can then login with this user into myApps.''
<hr> 
As mentioned in the beginning , one now can change the stored special settings back to its original state if necessary for the configuration
<hr> 
To give the existing users the possibility to use the innovaphone myApps, you should inherit the existing templates to the new template "Config User". If the user didn't have any template at all, then assign them o the template "Config User".

''Tip: The Users are only seen in Users App if they have the "Visible" flag in Visibility set. This is mostly done by Config Templates. So be aware that if you have another Config Template in use (that has not set the Visibility flag) even if you inheritate it from Config User it will not overwrite the older settings. So choose here the Visibility flag afterwards.''

[[Image:Change template.png]]

''Tip: Assign Administrative users to the new template "Config Admin".''

''Tip: In case you are using Apps that need a License the selectable box under License only appear after uploading the necessary license. In test mode everything works. So in case you are using test mode it is better to first upload your licenses, select the license boxes and than deactivate your test mode!

== Provisioning ==

If you want to use Provisioning and you are using Update Server/PHP Update Server 2 you have to consider that your phone needs to reach config.innovaphone.com via Update URL. 
That means that if you already provide an Update URL via DHCP that the Provisioning process will not be possible. Therefore delete the Update URL in your DHCP Server. 
In case you are using Update Server/PHP Update Server 2 for Certificates etc. your phone needs to reach your old Update Server after provisioning again. (further details will follow) 

Please Check: [[Reference13r1:Services/Update]]

== Assign Hardware of a User to a phone or softwarephone App ==

This can be done by the administrator in UsersAdmin App. 
Alternative the User can do this via his Profile. At the instruction from myApps the user can be shown on which point he can assign the app.

[[Image:Profile PhoneApp.png]]

== Reverse Proxy ==

Reverse Proxy migration must be done after upgrade the (first) pbx.

Via the advanced user interface install the latest V13r1 firmware.

In the next step we need the Devices App URL. Via the advanced user interface, in General/Devices Registration/Devices App URL.

Copy this URL.

[[Image:Device Registration2.png]]

Paste this URL in the advanced user interface of the Reverse Proxy in the field General/Devices Registration/Devices App URL.

From now on this device can be found in the Devices App in Devices.

The MAC address and a wrench symbol will be displayed.

Here you can now assign a meaningful name and the domain to the device.

[[Image:Devices.png]]

Via Categories you should assign this gateway also to the appropriate Category.
 

[[Image:Devices2.png]]

''Tip: Now the device configurations are assigned to all devices and the corresponding category(s)''

''These include at least:  Alarmserver Global, Media Global, NTP-settings''
 

Via the PBX Manager App and the Reverse Proxy plugin you can now configure the Reverse Proxy.

You should add here a new Host entry for the App Platform in the Reverse Proxy via the option "Add Host".

The DNS name of the App Platform will be displayed in the next step. Select the DNS name and it will be added to the Reverse Proxy entries.

Via the advanced user interface you have to change the URLs for every hostname pointing to an PBX (Slaves and Standby).
 

In the first http forward field you need to enter the following string /PBX0/APPCLIENT/appclient.htm and forward it to the appropriate IP-address with the port numbers 80 and 443 and tag the checkbox Default.
 

At least the following entries should be available as shown in the picture below.
 

[[Image:Reverse Proxy Entries.png]]
 

== Slave PBX ==

To proceed we need to install the latest version of the V13r1 firmware on the Slave PBX.

If the latest firmware V13r1 is installed, you can access the gateway via its IP-address and you enter into the install process. If there is no standard password you have to enter the admin credentials to login to the gateway.

In the next step select "Manual Configuration" and you will enter the Advanced User Interface.

In the following step we need the Device URL. You can find it on the Master PBX under General/Devices Registration/Devices App URL. Copy the complete URL.



[[Image:Device Registration2.png]]

Paste this URL via the Advanced User Interface of the Slave PBX under General/Devices Registration/Devices App URL.

Now you can find this Gateway in the Devices App within Devices. It will be displayed with its MAC-address and a wrench symbol.

Here you can now assign a meaningful name and the domain to the device.

[[Image:Devices.png]]

Via Category you should assign the Gateway to the appropriate category.

[[Image:Devices2.png]]

''Tip: Now the device configurations are assigned to all devices and the corresponding category(s)''

''These include at least: Alarmserver Global, Media Global, NTP-settings''

For provisioning new devices to the Slave PBX you need a new provisioning category and a new phone device configuration.
In the training books you can find how to do this for [http://wiki.innovaphone.com/index.php?title=Course13:IT_Connect_-_06_Managing_Devices#Categories categories] and [http://wiki.innovaphone.com/index.php?title=Course13:IT_Connect_-_06_Managing_Devices#Phone phone configuration]. In the device configuration you need to specify the Slave PBX as Primary Gatekeeper.

Next Steps:

On a Slave you should change some configuration if it needed.

- Slave PBX registration to the Master must be done with authentication. We prefer to do this with H323/TLS as Registration protocol.

- Slave Replication must be done with use TLS. Check if the Objects will be synchronized.

- For the new Reporting App the Gateway/CDR0 must be adapted accordingly to receive the CDRs of the slave. You can copy the values from the Master.

- For reverse lookup you have to configure the Reverse Lookup URL and also the appropriate Prefixes under PBX/General.


At this point no "Edit profile" menu item appears in the myApps client of a Slave PBX user. You can fix this in the [http://wiki.innovaphone.com/index.php?title=Reference13r1:Concept_App_Service_Users#Users PBX Manager Plugin Users]. Under "Change configuration" select the Slave PBX and activate the displayed app under "Use as profile".''

On the Slave PBX go to Services, HTTP, Client, and add the necessary URL's for Events, Voicemail, files, backup-files.

You can copy and paste the URL's from the Master. Be aware that you have to set the new Passwords should also be changed on the Master, instances, PBX Objects and HTTP Client!

''Tip: If the redirect from the slave or standby PBX to the myApps weblauncher does not work, you have to enter the following via Command or the webbrowser:''
!config change HTTP0 /home PBX0/APPCLIENT/appclient.htm
!config write
!config activate
!reboot

== IP Phones ==

Proceed to install the latest version of the V13r1 firmware on the IP Phones.

To update the existing IP Phones to V13 there are two possibilities.

In a large environment with a lot of IP Phones you probably already have an update server.

If an update server is available,

''- Change the Update Server script to update all phones with a Firmware upgrade to V13''

''- If the Phones are updated to V13, execute the update script with a change to delete the Update URL and add the Devices App URL, you can have a look of the config example below''
*This script command line will erase the update entry under [[Reference13r1:Services/Update]]
config change UP1
config write
config activate
*This script command line will configure the Websocket link under [[Reference13r1:General/Devices-Registration]] to connect the phone to its respective Devices App
config change SYSCLIENT /sysadmin wss://apps.yourdomain.ltd/yourdomain.ltd/devices/sysclients
config write
config activate

''- In Devices add the Phones to the appropriate domain and category and give it a useful name to find a users phone via the search option in devices (unfortunately manual one by one)''

If no update server is available,

''- Manual firmware upgrade to V13''

''- Manually edit the Devices App URL under General, Devices Registration, Devices App URL''

''- In Devices add the Phones to the appropriate Domain and category and give it a useful name to find a users phone via the search option in devices (unfortunately manual one by one)''

== STUN / TURN / Standby / DECT ==

To proceed we need to install the latest version of the V13r1 firmware on the existing Gateway.

If the latest firmware V13r1 is installed, you can access the gateway via its IP-address and you enter into the install process. If there is no standard password you have to enter the admin credentials to login to the gateway.

In the next step select "Manual Configuration" and you will enter the Advanced User Interface.

In the following step we need the Device URL which can be found on two different ways.



# Via the Advanced User Interface of the PBX
In General/Devices Registration/Devices App URL copy the complete URL.

[[Image:Device Registration2.png]]

Paste this URL via the Advanced User Interface of the Reverse Proxy Gateway in General/Devices Registration/Devices App URL .

Now you can find this Gateway in the Devices App within Devices. It will be displayed with its MAC-address and a wrench symbol.

Here you can now assign a meaningful name and the domain to the device.

[[Image:Devices.png]]

Via Category you should assign the Gateway to the appropriate category.

[[Image:Devices2.png]]

''Tip: Now the device configurations are assigned to all devices and the corresponding category(s)''

''These include at least: Alarmserver Global, Media Global, NTP-settings''

''Tip: For a Slave, Standby PBX or DECT you should select TLS as Replication protocol.''

''Tip: If the redirect from the slave or standby PBX to the myApps weblauncher does not work, you have to enter the following via Command or the webbrowser:''
!config change HTTP0 /home PBX0/APPCLIENT/appclient.htm
!config write
!config activate
!reboot

== Configuration Changes ==
=== SNMP disabled by default ===
Up and including v12r2, SNMP was by default activated on a innovaphone device. In v13 it is by default deactivated, it can be activated by a new [[Reference13r1:Services/SNMP | Enable Checkmark]]. As a result, if you upgrade to v13 firmware SNMP is deactivated and needs to be enabled if SNMP is needed in the customer setup.

===Config line size was increased to 32KB===

Downgrade from 13r1 to 12r2 (or older firmware) will result in objects with a too large [[Howto:Config_size_Limitations#Global | config line]] being dropped.

== Known issues ==
* For the known issues, please have a look into our [http://wiki.innovaphone.com/index.php?title=Support:DVL-Roadmap_Firmware_13r1 Support:DVL-Roadmap Firmware 13r1]
** The Headline '''13r1 Release Notes''' will list the known issues.
* install did not finish if you have configured ETH0 as DHCP Server and ETH1 DHCP Client (connected to corporate network, internet access). You have to Swap the ETH interfaces before you start the install.

===LDAP Directory Service on IP Phones via Reverse Proxy===
Currently by default IP phones registered via Reverse Proxy are NOT able to search in the PBX users and in the external LDAP resource (for example the Contacts database) To enable the LDAP search on the Phones we have to do some manual modification.

For more details: [http://wiki.innovaphone.com/index.php?title=Howto:V13_LDAP_IP_Phones_Directory_Services_via_Reverse_Proxy&action=submit: Howto V13 LDAP IP Phones Directory Services via Reverse Proxy]

===PBX Replication===
The PBX LDAP Replication won‘t work if Master and Slave have different major Versions (V13/V12). The reason is that the binding user is different in V13 and V12. The binding user in V12 is called ''_PBX_''. In V13 the binding user is called ''[domain]/_PBX_''. You should either use the same major Version or use the LDAP replicator at Services->LDAP->Replicator.

===Fax App===
The Fax App currently supports only dial plan having all objects in the root node. For details see [[Reference13r1:Concept_App_Fax#Known_issues | Concept App Fax: Known issues]].

===Install No-DNS mode in V13r1 sr7===
The install process in No-DNS mode stops when installing events.
This can be avoided by entering the DNS name in the hosts file of the PC you are installing with. The hosts file can only be edited with admin rights and is located in the folder:
<code> C:\Windows\System32\drivers\etc\hosts </code>

This will be fixed in V13r1 sr8.

== Related Articles ==
*[[Howto:Guideline V5 to V6 upgrade]]
*[[Howto:Upgrade Issues V5 to V6]]
*[[Howto:Firmware Upgrade V6 V7]]
*[[Howto:Firmware Upgrade V7 V8]]
*[[Howto:Firmware Upgrade V8 V9]]
*[[Howto:Firmware Upgrade V9 V10]]
*[[Howto:Firmware Upgrade V10 V11r1]]
*[[Howto:Firmware Upgrade V11r1 V11r2]]
*[[Support:Special_Precaution_required_when_upgrading_IPxx11_Gateways_from_pre-SR14_Firmware_Versions]]
* [[Howto:Firmware Upgrade V11r2 V12r1]]
* [[Howto:Firmware Upgrade V12r1 V12r2]]
* [[Reference13r1:Concept_Number_Resolution_and_LDAP]]
[[Category:Howto|{{PAGENAME}}]]

Reference9:3pty conference on DECT phones

2019-10-28T16:11:09Z

RobinBaur: /* Configuration */

[[Category:Concept|DECT conference]]
This article explains how to configure and use 3pty conference calls on DECT phones.


== Applies To ==
This information applies to

* all innovaphone DECT devices (IP1200 and IP1202) from V9HF11.

== More Information ==
The innovaphone IP-DECT devices are able to use the innovaphone conference hardware (CONF interface) to establish a 3pty conference call with firmware V9 hotfix 11 or later. If the 3pty conference is started by the user, first the IP-DECT device starts a call to the configured conferencing unit number. If this call connects, the connected number is used to connect the other call parties to the conference call.

=== Requirements ===
* innovaphone IP-DECT device with firmware V9 hotfix 11 or later
* innovaphone device with CONF interface with support of connected number (V9 and later)

=== Configuration ===
* PBX: The innovaphone CONF interface is registered to a PBX Trunk Line object (or a Gateway object with the ''Prefix'' check-mark ticked). The Trunk Line must have a number and be called by the gatekeeper the DECT users are registered.

* IP-DECT device: The ''Conferencing Unit Number'' of the DECT Master is to be set to the Trunk Line number appended by ''*1#'' (If Trunk Line is ''8'', set ''Conferencing Unit Number'' to ''8*1#'').

=== Usage ===
To start a conference by a DECT phone use the R-key feature ''R+3'' during a call. You must have at least one inactive call. To stop the conference again use also ''R+3''. ''R+2'' stops the conference and toggles to the last inactive party, or to a waiting call, if present.

== Related Articles ==
* [[Reference9:Gateway/Interfaces#Conferencing_interface_.28CONF.29 | Gateway CONF Interface]]
* [[Reference9:DECT2/Config/Master | Configuration DECT Master]]
* [[Support:DVL-Roadmap_Firmware_V9#IP-DECT:_Three_party_conference_with_innovaphone_PBX | V9 Hotfix11: IP-DECT: Three party conference with innovaphone PBX]]
* [[Howto:Conferences, Resources and Licenses]]

Reference10:Concept Linux Application Platform

2018-02-16T10:10:34Z

RobinBaur: /* Use as Log or Alarm Server */

==Introduction==

The innovaphone Linux Application Platform permits to install innovaphone or custom applications for certain purposes, like Reporting or a Fax Server. 
It also allows to backup/restore configuration files, uninstall applications or see and backup logs. 
 
The Linux distribution Debian 7.1 (Wheezy) is used and linux kernel is 3.4.10 (IPxx10) and 3.2.0.4 (VM) 
 
The architecture of the platform is armel. 
 

==Requirements==

There are three ways to use the innovaphone Linux Application Platform:

===On an IPxx10 Gateway===
* An IP810, IP0010, IP3010 or IP6010 Gateway
* Firmware Version 10
* A compact flash card with UDMA support (minimum 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

===On an IPx11 Gateway===
* An IP0011, IP311, IP411, IP811 or IP3011 Gateway
* Firmware Version 11r2
* An SSD mSATA

===As a Virtual Machine===
* VMWare Player/VMWare Workstation

* Minimal Requirements for the Virtual Machine:
1vCPU ( we run 800 MHZ CPU on our IPXX10 Gateways, so similar speed or higher it's enough, nevertheless depending on the operations/load you could need more CPU speed/vCPU)
512 MB RAM
8GB Disk

==Installation==

Download the latest Linux Application Platform from [https://download.innovaphone.com download.innovaphone.com ]. 
You can download and install two different packages: The IPxx10/IPx11 package to run on the gateways or a VMware image for VMware

===Default Credentials===
* Web/Webdav: '''admin'''/'''linux'''
* Root-Login (e.g. with Putty): '''root'''/'''iplinux'''

===Disk space calculation===
See [[Reference10:Concept_Reporting#Calculation_of_required_disk_space]].


It is strongly recommended that you try to precalculate the needed disk space and that you choose a suiting disk size.


===Disk space usage after first time installation===

====IPxx10/IPx11 Gateways====

* /dev/sda1: 32 MB (fat32 partition with two kernels, which are started by the IPxx10 or IPx11)
* /dev/sda2: 524 MB (ext2 initial installation partition)
* /dev/sda3: 120 MB (swap partition)
* /dev/sda4: 620 MB / xx GB depending of the size of the used CF card (ext4 partition, which is actually booted)

All in all about 1.3 GB are already in use after the initial installation.

====VMWare====

* /dev/sda1: 674 MB (ext2 initial installation partition)
* /dev/sda2: 120 MB (swap partition)
* /dev/sda3: 767 MB / xx GB depending of your pre installation configuration (ext3 partition, which is actually booted)

All in all about 1.6 GB are already in use after the initial installation.

===Linux Application Platform (IPxx10 or IPx11 Gateways)===

It is recommended to use CF-Cards with sizes of 8GB or more and the card '''must''' support UDMA! 
* Enable Linux under Linux General.
[[image:IPxx10_Linux_-_enable.png]]
* Be sure that "Autostart Linux" is disabled until the installation process is finished.
* You need to enable Proxy-ARP on ETH0 or ETH1 [[ Reference:Configuration/ETH/IP|here ]], so your gateway and the linux appliance will share the same physical interface. Simply go to '''IP4 > ETH0 (if used) > IP''' and check '''Proxy ARP'''
* Decompress the downloaded package. You should have an image file like <code>linux_ipxx10_armel.img</code> now. This works for both '''IPxx10''' and '''IPx11''' hardware!
* Upload the decompressed file over the gateways web interface under [[ Reference10:General/Compact-Flash/Image ]] (IPxx10) or [[ Reference12:General/SSD/Image ]] (IPx11). Unmount the CF card/SSD if necessary. Select "Part 1" before starting the upload!
[[image:IPxx10_Linux_-_upload_image.jpg]]
* Reset the box (which also activates the config change of step 1).
* Configure IP under [[ Reference10:Linux/IP ]]: select either "Disabled" to assign a static IP or ETH0/ETH1 to receive an IP-Address from DHCP-Server behind ETH0 or ETH1.
* Configure the kernel file, which you find under [[ Reference10:General/Compact-Flash/General#Browse_CF_Content ]] on [[ Reference10:Linux/General ]] '''Linux kernel file'''
** IPxx10 hardware: <code>Image-6010-3.4.10</code>
** IPx11 hardware: <code>Image-IPx11-4.4.0</code>
* Configure <code>root=/dev/sda2</code> under [[ Reference10:Linux/General ]] '''Kernel command line'''.
* If you want, configure the autostart flag.
* Submit your changes.
* Click the [[ Reference10:Linux/General ]] '''Start'''-Link. The page refreshes until Linux gets an IP and then tries to get a link to the Linux Web Server, which can take some time for the first time installation (~ 5 minutes to 2 hours, for a IP411 ~15 minutes).
[[Image:device_conf.jpg]]
* Open the Linux Web Server to see the installation progress (which might take several minutes too). The default credentials are '''admin'''/'''linux''' for both platforms.
[[Image:installation.jpg]]
* The output of the installation log is stored on the Linux AP under <code>/var/log/init_install.log</code>. In case you have no access to the web server but a console or SSH access, you can check the installation progress in this log file. E.g. login to the console with root/iplinux and run follwong command: <code>more /var/log/init_install.log</code>. In case you have an SSH connection to the Linux AP, you can download this file using [http://winscp.net WinSCP] tool.
* Enter the innovaphone device IP address (optional port allowed) and admin credentials when the installation has finished. Now wait until the page refrehses. The web server credentials are now the innovaphone device admin credentials, e.g. '''admin'''/'''ip6010'''.
** If the device couldn't be reconfigured, you will get an error message '''Command line at the PBX could not be changed...''' In this case, you have to open [[ Reference10:Linux/General ]] on your device, click stop and enter <code>root=/dev/sda4</code> under '''Kernel command line'''. Then start again. Your Linux webserver credentials will be '''admin'''/'''linux''' in this case.
* Linux install has finished.
* You will see now <code>root=/dev/sda4</code> under [[ Reference10:Linux/General ]] since Linux is running in on the fourth partition. You shouldn't change that unless you want to install Linux again.

===Linux Application Platform (VMWare)===

* Decompress the downloaded archive. You should have two files: '''IP-Debian.vmx''' and '''IP-Debian.vmdk'''.
* We can open using Vmware Player/Workstation, if you wish to run on Vsphere 4.x or later please convert it by the same method it's done with the IPVA (see [[Reference10:Concept_Innovaphone_Virtual_Appliance#VMware_vSphere | Using VMware vSphere]])
* Now you have two possibilities (example for VMWare Player, VMWare Workstation should be similar):
** If you want to assign more than 8 GB virtual flash:
*** Do '''not''' directly start/doubleclick the vmx file!
*** Start the VMware Player and Open the vmx file with '''Open a Virtual Machine'''.
*** Open '''Edit virtual machine settings'''.
*** Select the hard disk and '''Expand''' it under '''Utilities''' to the wished size.
*** Apply the change and klick '''Play virtual machine'''.
** If 8 GB are enough, simply double click the vmx file and Linux will start.
* The first time, a script will automatically configure a new partition, the web server etc., which will take some time. The waiting time depends on the CPU of the computer running the vmware player. In some cases the waiting time can be up to 30 minutes, in most cases the installation finishes in about 2-5 minutes.
* In the meantime, fetch your IP from the VMWare Player screen or login as root and get your IP address with the command '''ifconfig'''.
* Login to the web server to see the installation progress (it may take some minutes until the web server is up).
* Linux will restart automatically after the first time installation has finished.
* Linux install has finished.

===Hotfix Installation===
If you have already installed the latest version of the Linux Application Platform, simply download the Linux...HotfixIncremental for your platform (VM or IPxx10/IPx11) or if you have missed some hotfixes, download the Linux...HotfixCumulative archive, which contains all hotfixes since hotfix1.
 
 
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].

====Refreshing issue on installation====
You might get a PHP error when the browser is refreshing during the installation. Just refresh (F5) the page and you'll get the installation progress again.

=== Upgrade from a previous major Release ===
For instructions how to upgrade from a previous major release (such as V9 to V10), see ''Upgrading Linux Application Platform'' in [[Howto:Firmware_Upgrade_V9_V10|Firmware Upgrade V9 V10]].

===Static IP===
The Linux itself '''must''' be running in DHCP client mode to run properly. If you want to assign a static IP address, do it like this:

* On an IPxx10/IPxx11: assign a static IP under [[Reference10:Linux/IP]], this will do an internal DHCP response to the Linux that's running as DHCP client mode.
* On a VMWare: assign a static IP in your local DHCP server for your MAC address defined in the *.vmx file.

===IPxx10/IPxx11 Transit network for Linux===
When running Linux on an innovaphone device IPxx10/IPxx11 there is no dedicated network interface for the Linux machine. Instead we have a special transit network between the Linux and the device. The Linux will always operate as DHCP Client mode.

Any ARP request done by the Linux machine will always get the same ARP result that will be the internal "NIC" inside the device, so all packets are always sent to the same IPxx10/IPxx11 device that works as a router. When the packet sent by the Linux machine arrives the innovaphone device, it will follow the IP routing table of the device itself.

In case we have a single network (voice) we will have no problem since the default gateway is just one. However, if we wish to split into two networks (voice and data) and the Linux machine should have a different default gateway, this has no effect since IP routing is based on the innovaphone device IP routing table, because we can't have two default gateways at the same time.

==Administration==

===General===

====Configure IP====

The IP configuration on the Linux Application Platform is '''only''' available on a '''VM'''! A static IP for a Linux Application Platform for an IPxx10/IPxx11 can be configured on your gateway under Linux/IP.

* Mode: either DHCP Client or Static
* [IP Address]: the desired static IP address
* [Subnet Mask]
* [Gateway]
* [DNS Server]
* [Alternate DNS Server]

The optional parameters in [] can be only configured, if '''Static''' is selected as mode.

====Change the root credentials====

Here you can change the credentials of the Linux root user. 
Default password: '''iplinux'''

====Configure Authenticated URLs====

Configure credentials for authenticated URLs. These credentials will be used in automatic backups. 
You can add/remove Urls with the '''+''' and '''-''' at the right side of the list.

* URL: the URL, e.g. https://172.16.123.123/backup
* User: the user for this URL
* Password: the password for this URL

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

Default is Europe/Berlin but you can change that to a valid timezone (an error is given if timezone not present). 

====Change postgresql admin password====

If innovaphone Reporting is installed, you can configure another password for the postgres admin user. 
Default password: '''postgres'''.

===Web Server===

We use lighttpd version 1.4.32. The linux web server user is '''www-data''' and group user also '''www-data'''. Root directory for the web-server is '''/var/www/innovaphone'''. This information is mainly relevant if you plan to develope custom applications and integrate them into linux application platform.

Default users and password for the different levels on the Linux application plattform (see figure below):
[[image:Linux_Application_hierarki.PNG]]

====Change web server properties and public access to the web/webdav====
* Force HTTPS: enables redirection for HTTP to HTTPS
* Public Web Paths: these paths are not password protected, e.g. '/ap'
* Public Webdav Paths: these webdav paths are not password protected, e.g. '/backup'
** These paths are by default readonly. You can set the 'Write' flag to make the path also writable. This flag will be anyway ignored if credentials are provided. 

''<IPadr>''<code>/webdav/</code> is the root directory for webdav files. If you want to access a directory/file without credentials you have to add this directory to the Public Webdav Paths.

Example: <code>/webdav/background/</code> Here you have the background pictures for your Phones. 
Public Webdav Paths: <code>/background</code> or <code>/background/a</code> 
Now you have a public access to the folder background. 

* Enter a single '<code>/</code>' for a public root directory. All sub directories and files will be also public then. 
* If you enter e.g. '<code>/update/</code>', the directory 'update' and all sub directories/files will be public. 
* If you enter e.g. '<code>/update</code>', only the directory 'update' and its files will be public.

Important: Linux file names are case sensitive (so <code>/Update</code> is not equal <code>/update</code>)!.

====Change the Linux web server credentials====

Here you can change the credentials for Web Server access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change the Linux webdav access credentials====

Here you can change the credentials for webdav access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change application access credentials====

If you have installed an application, which has the lighttpd-auth property set in its configuration file, you can configure a separate user/password for the applications web site. 
If you want to disable the separate authentication, leave the '''user''' field empty and enter the currently configured password. The authentication will be the same as the root web server authentication afterwards. 
One can just login on the application web site with this access.

A configured access overrides a configured public web path to '/apps/application-name'!

====Configure mutual TLS====

If you need mutual TLS for innovaphone devices with a certificate signed by innovaphone, you can activate mutual TLS for a configurable '''port'''. 
Currently we're just supporting client certificates signed by innovaphone's ''innovaphone Device Certification Authority''. 
 
The physical mutual TLS path is '''/var/www/innovaphone/mtls'''. Here you can put your script files, e.g. mtls.php. 
You then call this script file by '''https://linux-ip:mtls-port/mtls.php''', as this path is the document root for the configured port.

'''How to upload the script:'''

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

The current server certificate installed on the web server is shown here. A self signed certificate, innovaphone-linux, is installed by default. It is recommended to change it with your own certificate.

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

The web server can be configured to poll a Command File URL (on a web server). 
The backup process is similar to [[Reference10:Services/Update]]. 

An alarm server can be also configured to receive alarms during an automatic backup: [[ #Alarm_Server | Alarm Server under Diagnostics ]].

At the bottom you will see a list of the current automatic backup serials from the Command File URL and the log of the last automatic backups.

[[Image:backup_restore.jpg]]

====Command File====

Example:
saveinnovaphonecfgs http://172.16.123.123/webdav/backup/cfgs-#i-#b10.tar.gz

The available default commands are:

=====saveinnovaphonecfgs=====

Saves all neccessary configuration files (no application specific files) as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphonelogs=====

Saves all available (also application related) log files as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphone-applicationnamelogs=====

Saves log files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportinglogs'''

=====saveinnovaphone-applicationnamecfgs=====

Saves all neccessary configuration files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingcfgs'''

=====saveinnovaphone-applicationnamedb=====

Saves ddbb if existing as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingdb'''

=====times=====
Executes the following command(s) only, if the specified time matches and only once per hour (independent of poll timeout value). 
Example:

<pre>
# both commands always executed
saveinnovaphonelogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-logs-#i-#m-#b10.tar.gz
saveinnovaphonecfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-cfg-#i-#m-#b10.tar.gz
# commands only from monday till saturday at 10am and 11am executed.
times day:1,2,3,4,5 hour:10,11
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
# commands only Saturdays and Sundays at 00am executed.
times day:6,7 hour:00
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
</pre>

* day goes from 1 (Monday) to 7 (Sunday). 
* hour goes from 00 to 23. 

You can specify multiple times commands to override the last one. 

=====Backup file name macros=====

You can use some macros for the backup filename:

* #i - will be replaced with the current IP address
* #m - will be replaced with the current MAC address
* #d - will be replaced with date/time in format Ymd-His (20110231-111010)
* #bxx - will be replaced with the current backup index, whilst xx is the maximum index

====Save configuration files/data====

Open this link to see all available files/data/logs to download them manually.

Password files for web server authentication won't be saved!

====Restore configuration files/data====

Open this link to restore all available files/data.

Password files for web server authentication won't be restored!

===Relay Hosts===

The Application Platform contains a mail client which speaks SMTP.
The SMTP daemon (postfix) looks up by default the DNS MX record of the recipient email address. 
Relay SMTP hosts can also be configured to deliver the mails. Each relay host is related to a '''sender''' mail address or a '''sender''' mail domain. TLS is used if the host supports it. 
Examples of the server entry:
; mydomain.com: MX record to the domain
; smtphost: host name with MX record lookup
; [gateway.example.com]: host name with DNS lookup
; [an.ip.add.ress]: IP address without DNS lookup
The form [hostname] turns off MX lookups. See also [http://www.postfix.org/postconf.5.html#relayhost the postfix documentation]. 
If anonymous SMTP is to be used, user and password must be left empty.
 

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

Currently innovaphone Reporting and innovaphone Faxserver are using these relay hosts, if entered.

===Database===

The innovaphone database is created to store e.g. relay hosts.
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

The database user is '''innovaphone''' with default password '''innovaphone'''.
This password may be changed here.

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

For the PgAdmin III it is imporant to use innovaphone as Service-DB (Wartungs-DB). Default login credentials - User: innovaphone - Password: innovaphone

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

A list of all currently installed applications. 
If an application has an own web interface, you can reach it by using the application name link. 

====Uninstall====
Use the uninstall link in the list to uninstall an application.

===Upload/Update===

Here all new applications, application updates and application platform updates are installed. 
After uploading the file, the installation will start automatically and the installation process will be shown. The page refreshes until the installation has finished.

==Diagnostics==

===Logs===

Here you can view, download or clear the available log files from the application platform or from installed applications. 
You can also download all log files at once (this archiv also contains older versions from the log files).

===RPCAP===

Enable/disable RPCAP for use with Wireshark. 
A link will be displayed, which you can use within Wireshark.

===Alarm Server===

Configure an innovaphone device as alarm server:

* '''ip''': IP address of the innovaphone device
* ['''port''']
* ['''user''']: user for authentication to the alarm server
* ['''password''']
* ['''https''']: use https to send the alarm

Options in '''[]''' are optional.

Alarms from installed applications or the application platform itself will be sent to this configured server.

===Status===

View the disk usage.

===Reset===
====IPxx10====

Shutdown the application platform. You'll have to restart it over the IPxx10 gateway.

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
You have to add the following scripts as public web path to retrieve the logs/alarms:
* logs: /ap/log.fcgi
* alarms: /ap/alarm.fcgi

So you can make the path '''/ap''' public on the ''Linux Web Server'' or you configure an authenticated URL for these files/this path on your ''innovaphone gateway''. 

If you configure an authenticated URL, don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like
https://111.111.111.111:443/ap or http://111.111.111.111:80/ap

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

You can use the application platform as file server, e.g. for udpate scripts, voicemail etc. 
You can access the server with a webdav client via '''http(s)://Linux-IP/webdav''' 
Public access to certain paths etc. can be configured under the [[Reference10:Concept_Linux_Application_Platform#Web_Server | web server configuration]].

Keep in mind that the Linux Filesystem(ext3) is case sensetive. The PBX will always search for lowercase letters. If you name your file ‘greetings.G711A’ it won’t be found. You have to name the file ‘greetings.g711a’.

==Enable further Tracing==
There are different trace options, which can be enabled by calling a certain php script: 
https://LINUX-IP/trace.php?level=127

The level is calculated by the addition of one or multiple of the following trace options:

{| border=1
|| '''Option''' || '''To add'''
|-
|| TRACE_STD || 1
|-
|| TRACE_DB || 2
|-
|| TRACE_TIME || 4
|-
|| TRACE_CALL_FLOW_TOTAL || 8
|-
|| TRACE_CALL_FLOW || 16
|-
|| TRACE_PARSE_CFG || 32
|-
|| TRACE_LDAP || 64
|-
|| TRACE_XML || 128
|-
|}

So currently all trace options are enabled with the level '''255'''.

Default trace level are "0"

==Appendix==
===Creating own applications===
See [[Reference10:Concept Linux Application]]

===Tools===

====WinSCP====

[https://winscp.net WinSCP] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

===Manual Debian Upgrade===
If you have installed one of our upgrade hotfixes and you had installed packages, which weren't included in innovaphone applications, the upgrade of some packages might have failed. You will see a warning message on your application platform. Something like:

<code type="text">
The following packages couldn't be upgraded due to missing dependencies: php5-cgi php5-cli
Take a look at our wiki to see, what you have to do now!
</code>

Now you have to perfom some actions yourself:
* make sure, your Linux Application Platform has internet access
* login with a terminal client like Putty
* start 'apt-get update'
* start 'apt-get install php5-cgi php5-cli' (list the packages of the warning message)
* delete the file /var/www/innovaphone/log/missing_packages.log to clear the warning message:
** rm /var/www/innovaphone/log/missing_packages.log

Your installation should be now up to date again.

===Configuring a new Kernel===
If you have installed a hotfix with a new kernel, you will see a warning message on your application platform. Something like:

<code type="text">
You're not running the latest kernel Image-6010-3.4.10!
Take a look at our wiki to see, what you have to do now!
</code>

To change to the new kernel, you have to reconfigure something on your device, where the CF card is plugged in.
* First shutdown your Linux (see [[ Reference10:Concept_Linux_Application_Platform#IPxx10 ]])
* Stop Linux under [[ Reference10:Linux/General ]]
* Configure the latest kernel file (currently <code>Image-6010-3.4.10</code>) under [[ Reference10:Linux/General ]] '''Linux kernel file'''
* Start Linux under [[ Reference10:Linux/General ]]

===Alarms of the Application Platform===
If you have configured an [[ #Alarm_Server | Alarm Server]], you will receive certain alarms. 
Currently, the following alarms exist:

* Disk Usage >= 90%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

* adduser
* apt
* apt-utils
* aptitude
* aptitude-common
* base-files
* base-passwd
* bash
* binutils
* bsdmainutils
* bsdutils
* bzip2
* ca-certificates
* comerr-dev
* coreutils
* cpio
* cpp
* cpp-4.7
* cpp-4.6
* cron
* curl
* dash
* db-util
* db5.1-util
* debconf
* debconf-i18n
* debian-archive-keyring
* debianutils
* diffutils
* dmidecode
* dmsetup
* dos2unix
* dovecot-common
* dovecot-core
* dovecot-pgsql
* dovecot-pop3d
* dovecot-sieve
* dpkg
* e2fslibs
* e2fsprogs
* file
* findutils
* gamin
* gcc
* gcc-4.7
* gcc-4.6
* gcc-4.6-base
* gcc-4.7-base
* gettext-base
* gnupg
* gpgv
* grep
* groff-base
* grub-common
* grub-legacy
* gzip
* hdparm
* hostname
* ifupdown
* info
* initramfs-tools
* initscripts
* insserv
* install-info
* iproute
* iptables
* iputils-ping
* isc-dhcp-client
* isc-dhcp-common
* klibc-utils
* kmod
* krb5-multidev
* libacl1
* libapt-inst1.5
* libapt-pkg4.12
* libasprintf0c2
* libattr1
* libblkid1
* libboost-iostreams1.49.0
* libbsd0
* libbz2-1.0
* libbz2-dev
* libc-bin
* libc-client2007e
* libc-dev-bin
* libc6
* libc6-dev
* libcap2
* libclass-isa-perl
* libcomerr2
* libcurl3
* libcurl4-openssl-dev
* libcwidget3
* libdb5.1
* libdevmapper1.02.1
* libedit2
* libept1.4.12
* libexpat1
* libfcgi-dev
* libfcgi0ldbl
* libffi5
* libfreetype6
* libfuse2
* libgamin-dev
* libgamin0
* libgcc1
* libgcrypt11
* libgcrypt11-dev
* libgdbm-dev
* libgdbm3
* libglib2.0-0
* libgmp10
* libgnutls-dev
* libgnutls-openssl27
* libgnutls26
* libgnutlsxx27
* libgomp1
* libgpg-error-dev
* libgpg-error0
* libgpgme11
* libgpm2
* libgssapi-krb5-2
* libgssrpc4
* libidn11
* libidn11-dev
* libitm1
* libk5crypto3
* libkadm5clnt-mit8
* libkadm5srv-mit8
* libkdb5-6
* libkeyutils1
* libklibc
* libkmod2
* libkrb5-3
* libkrb5-dev
* libkrb5support0
* libldap-2.4-2
* libldap2-dev
* liblocale-gettext-perl
* liblzma5
* libmagic1
* libmemcache-dev
* libmemcache0
* libmount1
* libmpc2
* libmpfr4
* libmysqlclient18
* libncurses5
* libncursesw5
* libnewt0.52
* libnfnetlink0
* libonig2
* libopts25
* libp11-kit-dev
* libp11-kit0
* libpam-modules
* libpam-modules-bin
* libpam-pgsql
* libpam-runtime
* libpam0g
* libpam0g-dev
* libparted0debian1
* libpcre3
* libpcre3-dev
* libpcrecpp0
* libpipeline1
* libpng12-0
* libpng12-dev
* libpopt0
* libpq-dev
* libpq5
* libprocps0
* libpth20
* libqdbm14
* libquadmath0
* libreadline6
* librtmp-dev
* librtmp0
* libsasl2-2
* libsasl2-modules
* libselinux1
* libsemanage-common
* libsemanage1
* libsepol1
* libsigc++-2.0-0c2a
* libslang2
* libsqlite3-0
* libsqlite3-dev
* libss2
* libssh2-1
* libssh2-1-dev
* libssl-dev
* libssl1.0.0
* libstdc++6
* libtasn1-3
* libtasn1-3-dev
* libtext-charwidth-perl
* libtext-iconv-perl
* libtext-wrapi18n-perl
* libtinfo5
* libtokyocabinet9
* libudev0
* libusb-0.1-4
* libustr-1.0-1
* libuuid-perl
* libuuid1
* libwrap0
* libxapian22
* libxml2
* libxml2-dev
* libxml2-utils
* linux-base
* linux-image-3.2.0-4-686-pae
* linux-libc-dev
* locales
* login
* logrotate
* lsb-base
* lsb-release
* make
* makedev
* man-db
* manpages
* manpages-dev
* mawk
* mime-support
* mlock
* module-init-tools
* mount
* multiarch-support
* mysql-common
* nano
* ncurses-base
* ncurses-bin
* net-tools
* netbase
* netcat-traditional
* ntp
* ntpdate
* openssh-client
* openssh-server
* openssl
* parted
* passwd
* patch
* perl-base
* php-pear
* php-xml-parser
* php-xml-serializer
* php5-cgi
* php5-cli
* php5-common
* php5-curl
* php5-imap
* php5-pgsql
* php5-xcache
* pkg-config
* postfix
* postfix-pcre
* postfix-pgsql
* postgresql-9.1
* postgresql-client-9.1
* postgresql-client-common
* postgresql-common
* procps
* psmisc
* python
* python-minimal
* python2.7
* python2.7-minimal
* rdate
* readline-common
* rsyslog
* sasl2-bin
* sed
* sensible-utils
* shared-mime-info
* ssh
* ssl-cert
* sudo
* sysv-rc
* sysvinit
* sysvinit-utils
* tar
* tasksel
* tasksel-data
* traceroute
* tzdata
* ucf
* udev
* util-linux
* uuid-dev
* vim
* vim-common
* vim-runtime
* vim-tiny
* wget
* whiptail
* xz-utils
* zlib1g
* zlib1g-dev
* lighttpd-mod-webdav
* lighttpd

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

===Separate authentication for innovaphone applications===
If you configured a separate authentication, it depends on the used browser, whether you have to re-authenticate on switching between the root web and the innovaphone application web access or not.

===Refreshing issue on hotfix installation===
[[ Reference10:Concept_Linux_Application_Platform#Refreshing_issue_on_installation | See here. ]]

===Kernel Update in VM Platform===
The installation of a new kernel fails and this process leaves the system unstable, not being able to install any more debian packages. Hotfix installations will probably fail.

===Outdated packages? Debian Upgrade?===
From time to time we will deliver upgraded debian packages with a new hotfix. As we have to insure compatibility with our applications, we won't perform an upgrade for each hotfix! 
 
Please do '''not''' perform an update/upgrade yourself, as this will break future hotfix/application releases. Sometimes we deliver debian packages in our hotfixes and dependencies might be broken if you update/upgrade yourself.

====I want to do it anyway!!!====
Ok, save your application/ap configuration and data files and install our latest '''FULL''' release without any hotfix. Restore the configuration/data files and perform your update/upgrade. Now you can be happy, if everything still works fine... 
Perform these steps for each new hotfix release, as you might not be able to apply a new hotfix.

=== Database Performance Issues ===
When you run many applications on your LAP (for example, Reporting or Fax for many PBXs), you may run into database performance issues. In this case, you will see messages like

LOG: checkpoints are occurring too frequently (29 seconds apart)
HINT: Consider increasing the configuration parameter "checkpoint_segments".

in the postgresql log file. To fix this, you may carefully increase the setting of <code>checkpoint_segments</code> in <code>/etc/postgresql/9.1/main/postgresql.conf</code>. By default, this value is not set (commented out):

#checkpoint_segments = 3 # in logfile segments, min 1, 16MB each

You can change this to 10

checkpoint_segments = 10 # in logfile segments, min 1, 16MB each

(note the removed comment introducer at the beginning of the line). Please note that this will take 112MB more disk space on the LAP, so be sure you have enough.

For more details on postgresql tuning, see https://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server.

Note that you may need to re-apply this change when you have installed a LAP update.

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

The same can be done for application specific passwords, e.g. Reporting.
In this case, use the file '''/home/lighttpd/innovaphone-reporting-htdigest.user'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

===Howto save and restore Linux AP data/database if the webgui is not available===

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentioned above should be only the last try to get the data and could work or not.
To be always on the save site use a standby Linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

=== How to recover from a broken File System ===
Sometimes you may find messages in the ''kern.log'' log file (in ''var/log'') like

Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): initial error at 1500329378: ext4_journal_start_sb:328
Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): last error at 1500329378: ext4_journal_start_sb:328

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

* Open the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda4'' to <code>root=/dev/sda2</code>
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line
** on the command prompt, use <code>e2fsck -p -f /dev/sda4</code>
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda2'' to <code>root=/dev/sda4</code>
** start Linux again
:: This will run Linux on the original partition.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the LAP and any applications and restore your backups.

<internal>
Internal: How to recover from a disk-is-full Condition: [http://wiki-intern.innovaphone.com/index.php?title=Reporting#Vergr.C3.B6.C3.9Fern_der_Partition_.28VM.29]
</internal>

== Related Articles ==
* [[Howto:Convert a V10 LinuxAP to VHDX to run on Hyper-V]]

[[Category:Concept|Linux Application Platform]]