Reference13r1:Concept myApps

From innovaphone-wiki

Jump to: navigation, search

Contents

Applies To

This information applies to

  • innovaphone PBX from version 13r1

Overview

innovaphone myApps is the client software for innovaphone users and administrators. The base functionality is provided by a web application that is loaded from the PBX. Additionally there are installable versions for Windows, Android and iOS that come with an integrated browser and implement adaptions to the local operating system.

The purpose of myApps is to organize and run apps. All productive functionality is provided by additional apps that run inside myApps.

Requirements

Web version

For opening myApps in the web browser you need the most recent version of one of the following browsers:

  • Chrome
  • Firefox
  • Safari
  • or Edge

The following browser features are required and must not be disabled:

  • JavaScript
  • HTML5 Local Storage


myApps for Windows

  • Windows 10

Media Feature Pack for 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 Microsoft (Windows 10 pack) before you install myApps.

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

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 itself
  • Apps might require licenses

Account

  • A user account (user object) on the PBX is needed in order to use myApps.

Features

myApps comes with the following features:

  • User login including two-factor authentication.
  • Display and set the own presence.
  • List of all available apps.
  • Running apps (inside an iframe).
  • Home screen with user-selected apps and app items that can be organized in collapsible groups.
  • List of all myApps-Logins. Unused or suspicious sessions can be logged out remotely.
  • Color scheme selection (light, dark).
  • Configuration of standard apps for certain functions (like phone calls or chat).
  • Link to account specific settings provided by a separate app (profile).

All other functionality is provided by apps. For example phone calls require a phone app. Chats require a chat app.

Additional features of myApps for Windows

  • Local Outlook contact search
  • Office presence provider
  • Hotkeys
  • Tel-URI handler
  • Application sharing service for phone and softphone apps
  • Video service for phone and softphone apps
  • Audio service for softphone apps
  • Starting external applications for a call

Additional features of myApps for iOS / Android

  • Application sharing service for phone and softphone apps (viewing only)
  • Video service for phone and softphone apps
  • Audio service for softphone apps

Details

Connecting to the PBX

The myApps web application is loaded from the PBX. The corresponding URL for opening myApps in a browser is

 https://<pbx-hostname>/PBX0/APPCLIENT/appclient.htm

The installable versions ask for the "server name" on the first startup. Enter the host name of the PBX to proceed to the login screen. You can change the server afterwards by logging out and clicking the "Change server" link on the login screen.

Authentication and security

For using myApps you need an account (user object) on the pbx with a password. For logging-in you need to enter the username (SIP-URI) or email address and the password.

Permanent sessions

On each successful login on a new browser or new device a permanent session is created that is defined by a session id and a session password. Those are stored both in the local storage of the browser and at the user object in the PBX. If the user closes myApps and opens it again, the stored session is used. Only when logging-out the session is deleted in both places and the login screen is shown again.

Note that the user password is never transmitted over the network or permanently stored in the browser.

The user can keep track of all his permanent sessions in the myApps menu under "Account security". Sessions that are not needed anymore can be deleted here. The corresponding browser or device is logged out on-the-fly.

Two-factor authentication

The purpose of two-factor authentication is to maintain an additional level of security that prevents attackers form logging-in even if they compromised a users password. Therefore we strongly recommend to use it.

It can be activated during installation of the PBX or in the admin UI under PBX/Config/Authentication. If activated, the password alone is not sufficient for logging-in but the user must also verify the new session by

  • Confirming it in a dialog displayed on any existing myApps session.
  • Clicking a link that is sent to the email address configured at the user object.

In both cases a security code is displayed that should be compared to the one that is shown on the login screen of the new session. If it is the same the user can be sure that he is confirming his own login but not the possible concurrent login of an attacker.

The email account for sending the verification emails can be configured during installation of the PBX, in the PBX Manager plugin "Email" or in the admin UI under PBX/Config/Authentication.

If a user is notified about a login attempt he did not do, it means that the user password is compromised. The following should be done in such cases:

  • Reject the session (email link or displayed dialog)
  • Inform the administrator
  • Change the user password

Using Windows passwords

Instead of using the passwords configured at the user object, the Windows password can be used. Please see Reference13r1:Concept_Netlogon_and_myPBX_Windows_Authentication for details.

Logging out

In the installable version a logout can be done in the myApps menu at "Account security" / "Current session".

Resetting passwords

If the user has forgotten the password, he or she can set a new one by clicking the "Forgot password?" link on the login screen and completing an email verification process. This function can be activated or deactivated by the admin by configuring the link at "PBX"/"Config"/"myApps"/"Reset Password Page" or - more conveniently - using a checkmark in the PBX manager plugin of the innovaphone Users app that provides the functionality.

Apps

App runtime

All apps are web applications that consist of

  • An HTML page
  • Javascript files
  • An app icon

myApps starts apps by opening the HTML page in an iframe. All communication between the apps and the myApps client is done using HTML5 window messaging. For example if the user changes the color scheme, myApps sends a window message to all open apps, so they can also switch colors.

App objects

All apps that appear in the myApps client must be configured in the PBX. For apps that are loaded from the innovaphone App Platform or any other external server an App object is used that contains all the needed parameters.

Name
An ID that must be unique per PBX domain. The ID is only used internally to reference that app and is not shown to the user.
Long Name
The display name of the app.
Password
The shared secret between the app instance and the PBX. It corresponds to the password configured at the app instance. This secret is used when a user is authenticated against the app.
URL
The base URL of the app. myApps appends .htm to get the URL of the HTML page and .png to get the URL of the app icon.
Hidden
Some apps don't have a user interface. Their only purpose is to provide functionality (Client APIs) for myApps or other apps using window messaging. They have the "Hidden" flag checked at the app object and are not shown to the user.
Plain website
Checked if the HTML page is not an actual app that requires login and processes the window messages used for apps, but if it is just a reglar website. This flag can be used to integrate websites into myApps.
Please note that this feature is meant for having a possibility to create simple content pages and integrate them into myApps without the need to develop a full-fledged app. Most existing websites can't be integrated, because they do not allow to load them in an iframe.
Websocket
Some apps need a websocket connection from the PBX. This can be used to exchange additional information or to use APIs on the PBX. Those apps need the Websocket flag checked.

Some other PBX objects also provide apps, like the Boolean object.

App permissions

In order to use an app the administrator must grant the permission to the user. This can be done using templates of at the specific user object ("Edit Object"/"Apps"). The same setting can be done in the PBX manager plugin "Templates". The user will find the apps he has access to in the "All apps" view in myApps.

Special case: phone apps

If a user has access to the "phone" or "softphone" app, it will not automatically appear in "All apps". Those apps need to be assigned to a device at the user object and will then be used for the registration on those devices. The admin can configure the app name at the individual devices in the admin UI. The user can assign the app during provisioning of phones in "Edit profile".

Client APIs and default apps

Some apps provide APIs that allow communication with other apps. An app providing an API is called an API provider. Communication is done using HTML5 window messages sent to the myApps client that dispatches them to the right app.

If there are many providers for the same API, the app can send messages to specific provider, to all providers or let the user decide. In the latter case, myApps displays a selection dialog to the user. The user can also mark an app as the default app for an API that will then be used without asking again.

Additionally the user can configure the standard apps in the myApps menu.

The default apps are stored locally on each browser / device. So the user can have a different setting on each device.

Special case: phone API (com.innovaphone.phone)

The phone apps provide a phone API that can be used by other apps to start calls. If a phone app is selected as the default phone app it has the following effects:

  • When dialing a phone number (in a contacts app) the default phone app will be used for the call.
  • On incoming calls the phone app is started and displayed automatically, to handle the call.

If no default phone app is selected on a device

  • The user will be asked what phone app shall be used when dialing (in a contacts app)
  • On incoming calls no phone app will be started

Regardless of the setting, the user can open any phone to start or receive calls.

The standard phone app can be also selected by longpressing the app tile on the home screen.

Home screen

The home screen contains tiles that represent apps or items from apps - generally speaking links to apps. For example the user can place his phone app next to a contact from a contact app. Those tiles can be organized in named groups that can be collapsed, if they are currently not needed.

The presentation of a tile contains an icon, the name of the app or item and optionally a presence and a badge count provided by the app.

There are two ways for the user to add new items to the home screen:

  • Click the home symbol at an app in the "All apps" view.
  • Click an attach icon at an item inside an app.

Apps can be removed again the same way or by longpressing the tile and clicking "Remove from home".

Storage and format

The home screen is stored at the user object in the PBX and is synchronized over all sessions of the user.

The admin can see and configure it in the admin UI at "Edit User"/"User"/"Home Screen Apps". It is a comma-separated string of app links.

The string is limited to 8KB. If the limit is reached no more items or groups can be added to the home screen.

Format: Items starting with a colon are groups. Items starting with two colons are collapsed groups.

For example

   :Apps,chat,users,::Contacts,users?id=jdo#d=John%20Doe&s=jdo

corresponds to

  • Apps (group)
    • Chat
    • Users
  • Contacts (collapsed group)
    • "John Doe" from the app "users"

All apps

This page in myApps shows all apps that the user has access to (see: #App permissions). Apps that are often used can be attached to the home screen.

Edit profile

An app for managing the user profile can be configured in the admin UI at "PBX"/"Config"/"myApps"/"Edit Profile App". Typically the profile app provided by the innovaphone Users app is used for that. If configured a menu item "Edit profile" appears in the myApps menu.

Tracing and logging

You can enable specific traces in the launcher configuration, the launcher writes a rotation of trace files to the folder C:\Users\[UserName]\AppData\Roaming\innovaphone\myApps.

On Android and iOS the log files might be sent via e-Mail. This function is available from the main menu of myApps in "More...", "Trace".

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

The specific trace flags are explained here: Reference13r1:Concept_App_Platform#Tracing

myApps Update Service

During myApps updates, log files are written in %windir%\Temp. The log file names are myAppsInstall.txt and myAppsUpdateService-...txt and may contain information why updates are failing.

Appendix

MSI parameters

The MSI installer of myApps for Windows supports the following parameters and can edited via Microsoft Orca. You can add your parameters in the table property.

If you want to check existing configurations check your registry: Computer\HKEY_CURRENT_USER\Software\innovaphone\myApps

  • SERVER: sets the server name
  • TRACE: sets the tracing options during installation
  • AUTOAPPEAROFFLINE: possible values are 0, 60, 300, 600 or 900 (Never, 1 min, 5 min, 10 min or 15 min)
  • SHOWINTASKBAR: values are 0 for "false" or 1 for "true"
  • HOTKEYS:

Values: F1 - F12 (112 - 123) and optional modifiers: Alt 65536, Ctrl 131072, Shift 262144, Win 524288

  • HOTKEYDIAL: Example, Ctrl + F1 -> 131184
  • HOTKEYACCEPT: Example, Ctrl + Alt + F2 -> 196721
  • HOTKEYREJECT: Example, Alt + Shift + F7 -> 327798‬
  • DOCKING: values are none, left or right (in the registry reflected with 0, 1 and 2)
  • OFFICEPRESENCE: false to disable presence integration in Microsoft Office
  • EXTERNALAPPS: "{\"externalApps\":[{\"id\":1,\"name\":\"Wireshark\",\"path\":\"C:\\Program Files\\Wireshark\\wireshark.exe\",\"param\":\"\"]}"
  • SHOWDESKTOPNOTIFICATIONS: false to disable desktop notifications (default is true)

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:

Codec Windows Android iOS Browser
Audio
G711A
G711u
G722
G729
G729A
G729B
G729AB
OPUS-NB
OPUS-WB
Video
VP8
H264 X X X
Application Sharing
Share X X X
Watch X* X*

* planned for implementation

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.

Related Articles

Known issues

Button on Bluetooth headsets not working on myApps for Android

  • The button of Bluetooth headsets does not work to accept or disconnect calls.The button on wired earphones does.

Application sharing not undockable on myApps for Android & iOS

  • Currently on mobile devices App sharing cannot be undocked from myApps and so cannot be bigger displayed
Personal tools