innovaphone wiki - User contributions [en]

Reference16r1:Concept App Service IP

2026-03-31T10:25:17Z

Wh2a: /* Create instance */

[[Category:Concept|Apps]]
[[Category:Concept|IP]]

The App IP is an app which offers the PBX functionality and further functionalities as App service on our innovaphone App Platform.

== Applies To ==

* innovaphone firmware and apps V16

==Requirements==
* innovaphone Application Platform (image version 140011 or higher)

==Concept==

The App IP offers modules known from innovaphone gateways, like the PBX, TURN server functionality etc.

==How it works==

=== Single instance mode ===
Unlike other App Services, the App IP is a single instance App Service, so you can create '''just''' a single instance and not multiple instances.

== Licensing ==
Standard licensing mechanisms apply to the App IP as they apply to innovaphone gateways.

In addition, every port license requires a dedicated IPAP license (similar to the IPVA license for virtual machines).

== Apps ==

There is no App provided by this App Service.

== PBX Manager Plugins ==

There is no PBX Manager Plugin provided by this App Service.

== Configuration ==

The configuration is done as an innovaphone gateway is configured too.

=== Create instance ===
You have to create one instance for the App IP Service.

[[Courseware:IT Advanced - 04 Setting up the Application Platform#Adding an App Service instance|Here]] are more informations how to do this.

We recommend the following settings: 
'''Name''' = ip 
'''Domain''' = customer domain (system name of the PBX)

'''Password''' = define your password (will be the admin password of the PBX)

=== Install Process ===
Install can be started under the webserver path of the App IP instance and /''install.htm'', e.g.: https://domain.com/ip/install.htm

⚠️ Use standard ports for installation. If necessary, install via a reverse proxy

⚠️ Do not use the localhost (127.0.0.1) address

=== Advanced UI ===
The advanced UI is reachable under the webserver path of the App IP instance and /admin.xml?xsl=admin.xsl, e.g.:
https://domain.com/ip/admin.xml?xsl=admin.xsl

=== IP configuration ===
As the App IP is just an App on an App Platform, there are no IP4/IP6, NTP etc. settings as on other innovaphone devices.

==== Devices App ====
If your App Platform which runs the App IP is connected to a Devices App, you can access the Advanced UI with the '''PBX''' tab of your App Platform device.

==Troubleshooting==

The App IP offers standard tracing mechanism for App Services and in addition mechanisms known from innovaphone gateways. 
You can enable module related trace flags with config change commands or by setting trace flags under Maintenance -> Tracing in the Advanced UI of the App IP.

Trace files are not found under Maintenance -> Tracing but on the App IP service on your App Platform Manager.

==Known issues==

==Related Articles==
* [[Reference16r1:Concept_innovaphone_App_Platform_Docker_Container]]

Reference13r3:Apps/PbxManager/App Calendar

2023-05-22T10:32:02Z

Wh2a: /* Exchange Sync */

The PBX Manager Plugin for the Calendar App allows you to create two kinds of app objects. One is the Calendar Admin, which is just a simple overview of what's going in. The other is the Calendar App itself. Please note that even if the app is named "Calendar", it isn't a calendar like it is known. For now, it's just a tool to synchronize the Outlook / Exchange Calendar with the innovaphone PBX to set the presence of the user to the active or upcomming appointments.

== Applies To ==

innovaphone PBX from version 13r1 (Exchange 365 using OAuth2 needs 13r2 beta 2 or newer).

== Supported Exchange Versions ==

* Exchange 2013 or newer
* Exchange 365

== Configuration ==
In order go get the current users presence synchronized with Exchange, the calendar must be configured. This includes two parts: the configuration for the communication with the PBX and the configuration for the communication with Exchange Server.

=== PBX & Presence ===
The following configuration can be set for the PBX communication:
* Master PBX Name: This is the name of the main PBX. Even if several PBXs are used in your setup, the calendar supports communication with only one of them, usually the main PBX. The name must be specified, even if you use only one.
* Presence language: The language the Calendar uses for presence. This is not necessarily the one that is displayed in myApps or on the phone, since the presence is translated there into the respective language.
* Presence timezone: The time zone in which the time of presence is calculated. As with the language, this is not necessarily the time that is displayed in myApps or on the phone, since the time zone set there is used.
* Subject: Define whether the subject of an appointment should be visible in the presence or not.

=== Exchange Sync ===
*'''Sync-Type:''' Select the type of connection to your Exchange server. On-Premises is to be used for local Exchange installations. Here, the calendar connects to Exchange via NTLM authentication. Cloud is for Exchange 365 (formerly Exchange Online), where AOtuh2 is used for the connection.
*'''User:''' The username to use for the authentication. This use must have the Application Impersonation right and should also have a mailbox, since the user will be used to autodetect the Exchange settings, too. For more information about impersonation right (see below). Example: username@domain.eu
*'''Password:''' (Only available when Sync-Type is On-Premises) The password to use for the connection to Exchange.
*'''Autodiscover Server URL:''' The URL of the Exchange Autodiscover server. For more information, see the section autodiscover below. This value is optional.
*'''Exchange-Server to use:''' The Exchange Server can report two addresses through which it can be reached: an internal and an external one. Normally it is not a problem to use the external address. However, depending on the local network setup, this may not work. In this case it is recommended to use the internal address.
*'''User for name resolving:''' Execute name resolution by either the impersonation user or various user names the calendar can create with the information received from the PBX [[Reference13r3:Release_Notes_Firmware#131908_-_Calendar:_Make_new_way_to_resolve_names_optional_for_compatibility_reasons|(see also release note)]].
*'''Max subscriptions per connection:''' limit number of concurrent query requests vs Exchange. [https://kb.infobridge.com/hc/en-us/articles/115004836973-You-have-exceeded-the-available-subscriptions+ Also crosscheck settings at Exchange!]
*'''EWS debugging protocol:''' de/activate debug output generation for troubleshooting.

=== Exchange Sync for Exchange 365 ===
For this sync type you have some additional configuration steps. When connecting to Exchange 365, Calendar authenticates itself via OAuth2. In order to use this, the Calendar app must first be set up within Azure Active Directory. A description for this setup can be found in the howto article [[Howto:V13r2_Setting_up_Calendar_with_OAuth2|Setting up Calendar with OAuth2]]

=== Presence mapping ===
Here you can set how the presence values from Exchange should be mapped to the PBX. The only presence that can't be mapped is free (appointments with presence free will never show up in the presence), busy or away. The options you have in this sections are:

* Tentative exceptions: An email address for a user who can create appointments setting the presence to tentative. This can be used for example by the human relations department. If a colleague is sick, an appointment with "sick" and presence set to tentative can be entered into the calendar of that colleague by someone at humen relations. This makes humen relations to be the organizer and the mapping for that appointment will be different as the mapping for normal tentative appointments.

The mappings to set are:
* Tentative: Mapping of appointments that are set to tentative in Exchange.
* Tentative exceptions: Mapping of appointments that are set to tentative in Exchange created by the user defined in the tentative exceptions organizer field.
* Out of office: Mapping of appointments that are set to out of office in Exchange.
* Working elswhere: Mapping of appointments that are set to working elsewhere in Exchange.
* No data: Mapping of appointments that don't have any presence information. Should realy up to never happen.

Values you can set the mapping to
* Available: The appointment is handled as free but still be shown as presence (instead of an appointment that is set to free in exchange). Normally, if there is no appointment, available will be shown. If a presence is mapped to free, the format of the presence is like a free presence but with the title of the appointment. For example: the appointment instead of "Available until 2pm (Busy: Meeting)" it will be "Homeoffice until 2pm (Busy: Meeting)", if the appointment with mapped presence has the title "Homeoffice".
* Busy: Presence will be mapped to busy.
* Away: Presence will be mapped to away.
* Do not disturb: Presence will be mapped to do not disturb.
* Ignore for presence: The appointment with a presence mapped to this value will not be shown for the presence (default for tentative appointments which won't be triggered by the tentative exception rule).

== Additional information ==
=== Impersonation user ===
In order to query the appointments of all Exchange users, the user used to connect to Exchange (On-Premise) or to authenticate the connection (OAuth2) must have the Application Impersonation right. This means that this user can act on behalf of all other users. For this reason and the rights associated with this impersonation user, the credentials of this user should be kept highly confidential! The Calendar itself stores the user's password in encrypted form in the AppPlatform database (on-premise only). Since the user is also used to determine Exchange server settings, the user may need to have its own mailbox. An example of how the Application Impersonation right can be assigned to a user can be found here: [https://www.techieshelp.com/exchange-2013-configuring-impersonation-applications/ Exchange 2013 and 2016 Configuring Impersonation For Applications]. Instructions for other Exchange versions or further information about Application Impersonation can be found in the Exchange documentation.

=== Autodiscover ===
The calendar uses autodiscover to determine the server address, the Exchange version used and other user-relevant information. Normally, the calendar automatically determines the address of Exchange's autodiscover service based on the TLD of the impersonation user. For example, if the impersonation user's TLD is "example.com", the calendar will look for the Autodiscover service at "https://autodiscover.example.com", "https://example.com", "http://autodiscover.example.com" and "http://example.com". Depending on the configuration, at least one of these URLs should be the correct one. However, under certain circumstances, this auto-detection may go wrong. Therefore, the address of the autodiscover service can be configured for the calendar. The exact address depends on your Exchange configuration. For Exchange 365 e.g. https://autodiscover-s.outlook.com or https://outlook.office365.com are possibilities. Additional information can be found in the [https://docs.microsoft.com/en-us/exchange/architecture/client-access/autodiscover?view=exchserver-2019 Autodiscover service in Exchange Server Knowledgebase]

=== Users and primary SMTP address ===
The calendar will get a list of users available in the PBX. After that, he tries to resolve the primary SMTP address for each user to be able to get the users appointments. The calendar tries to use username@pbx-domain. If that isn't the users email address, you can add additional addresses to each user object in the PBX. This may help in case that a user can't be resolved.

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

Reference12r2:Concept myPBX

2022-12-01T10:27:38Z

Wh2a: /* Directory search */

[[Category:Concept|myPBX]]
= Overview =
myPBX is the UC client of the innovaphone PBX. It is intended for assisting typical phone users with their everyday tasks. It consists of two parts:
* A '''web application''' that runs in any modern web browser. It provides the functionality needed for audio telephony, instant messaging, monitoring peoples statuses and more.
* The '''myPBX launcher''' is a Windows application that integrates the myPBX web application into the Windows desktop and adds some interesting additional features like video telephony and Outlook integration.

== Web application ==
The main user interface is an HTML5 application that runs in a web browser. It communicates with the PBX using HTTP-Requests (AJAX). The actual session logic is implemented inside the PBX.

The picture shows how call control is done. The myPBX session has access to the phone registration as they are both located in the same PBX. Thus it can monitor and create or modify calls.

[[Image:Mypbx_overview.png]]

The web application also includes a [[{{NAMESPACE}}:Concept myPBX WebRTC Softwarephone|WebRTC Softwarephone]] that works with some browsers.

== myPBX launcher ==
The launcher is a tool for integrating myPBX into the Windows desktop. It is not needed in order to use myPBX but it adds some convenient functions that are not available otherwise.
* Automatically open the myPBX web application on startup.
* Desktop notifications.
* Integrating external applications.
* [[{{NAMESPACE}}:Concept_myPBX_Video|Video telephony]]
* [[{{NAMESPACE}}:Concept myPBX Application Sharing|Application sharing]]
* [[{{NAMESPACE}}:Concept myPBX Office Integration|Office Integration]]
* Hotkey for dialing numbers out of any Windows application.
* Set the status depending on user activity.
* Switch to a standby PBX if the main PBX is down.
* Write trace files.

== Requirements ==
===PBX===
* myPBX license
* Reporting installation (for seeing recent calls in the history), although no reporting license is needed (as opposed to V9)

===Launcher===
* Windows 7 32bit/64bit or higher
* .NET 4.5.2
* Microsoft Visual C++ 2013 Redistributable (x86)
 
; Third party application for MAC OS
:Our partner [http://www.infoso.com Infoso GmbH] has created an application, that mac users can also use the hotkey to dial. Please refer to [http://wiki.innovaphone.com/img_auth.php/b/be/Infoso_mypbx_mac_auncher_en.pdf the manual] and [http://www.infoso.com/downloads/innovaphone/myPBX/myPBX.dmg the dmg file] provided by the Partner.

===Web browser===

If the myPBX is started inside the launcher, an embedded browser is used, so there are no special requirements.

If myPBX is started in a web browser that is installed on the local system, the browser must fulfill the following requirements:

* Current browser version
* JavaScript enabled
* HTML5 XMLHttpRequest (AJAX) enabled
* HTML5 Web Storage (DOMStorage) enabled
* HTML5 Cross-document messaging (postMessage) enabled

''Note: For IE the minimum supported version is IE 10.''

===Email addresses===
myPBX builds an email address of a user with the name (H323) and the System Name of the PBX. 
So if the System Name is '''innovaphone.com''' and the name (H323) of the user is '''test''', the resulting email address is '''test@innovaphone.com'''. 
So for every user an email address with this combination should exist. 
 
This email address should be the primary SMTP address in your Exchange Server. 
If this can't be done, make sure, that there is a SIP address on your Exchange user, which matches this email address.

See [[{{NAMESPACE}}:Configure_Active_Directory_Replication#Notes_on_replicating_the_new-in-V10_email_User_Attribute]] for details on replicating the email attribute from ''Active Directory''.

== Related technology ==
* myPBX uses the [[{{NAMESPACE}}:Concept_Reporting|innovaphone Reporting]] as a database for call lists. Alternatively the local [[{{NAMESPACE}}:Services/Call-Lists|call list service]].
* The [[{{NAMESPACE}}:Concept_Exchange_Calendar_Connector|Exchange Calendar Connector]] sets the presence of PBX users depending on their Exchange Calendar. myPBX can display that presence.
== Features ==
For a feature overview refer to [[Reference12r1:Concept_myPBX_derviates_and_features|myPBX derivates and features]].

= Configuration =

== PBX ==
''' Basic configuration '''
* Make sure you have installed the appropriate licenses.
** ''myPBX'' for the web application.
** ''Video'' for video telephony.
* Activate the licenses for the inidiviual user objects (''License'' tab). This can also be done using config templates.
* Enable myPBX on the page ''PBX/Config/myPBX''.
* To support call lists at the client, configure the ''Call List Service'' in [[{{NAMESPACE}}:PBX/Config/myPBX#Call_List_Service|''PBX/Config/myPBX'']]
''' Additional hints '''
* Only users with a password can login to myPBX.
* There should be a dedicated device configured at the user object for each phone registration.
* To use mobile phones, the mobility device must have a name in the fork config at the user object.
* The LDAP configuration is taken from the phone config at the user object.
* The dialling location has to be configured at the phone config of the user object.
* Phones should be registered using the PBX password so that user can change their login password without affecting the phone registrations.
* If federation is used ("use as domain" checked), the user names and the PBX system name should match the email addresses of people.

== Launcher ==
myPBX supports various ''MSI parameters'' which can be modified using Microsoft's ''Orca'' tool for individually tailored deployment (see the [https://docs.microsoft.com/en-us/windows/desktop/msi/orca-exe respective Microsoft Knowledge Base Article] for details on using Orca). You can then roll-out myPBX using your favourite software deployment tool (or, if you don't have one, using Windows Policies, see [https://support.microsoft.com/en-us/help/816102/how-to-use-group-policy-to-remotely-install-software-in-windows-server this Microsoft Microsoft Knowledge Base Article on ''Group Policies''] for details).

The ''Orca'' tool is now integrated in the [https://developer.microsoft.com/de-de/windows/downloads/windows-10-sdk Windows-SDK]. For Installation activate "MSI Tools" in the Setup Wizard.

''' Basic configuration '''
* The configuration dialog is located in the context menu of the tray icon.
* Configure the ''URL'' in the myPBX tab (e.g. <code>http://x.x.x.x/PBX0/MY/client.htm</code>).
* From v10 beta1 to beta4 the URL was <code>http://x.x.x.x/PBX0/MY/mypbx10.htm</code>. From v10 beta5 the normal URL (<code>client.htm</code>) is used.

''' Deployment '''
* Administrators can specify a default configuration using MSI parameters within the table '''Property''' when deploying the software.
** <code>URL</code> - The primary URL.
** <code>URL2</code> - The secondary URL (standby PBX).
** <code>TRACE</code> - Write trace files (<code>true</code> or <code>false</code>).
** <code>OFFICETRACE</code> - Enable Office Presence Logging (<code>true</code> or <code>false</code>).
** <code>AUTOSTART</code> - Autostart myPBX (<code>true</code> or <code>false</code>).
** <code>AUTOAPPEAROFFLINE</code> - Detect user activity on the computer in order to set the IM status (<code>true</code> or <code>false</code>, or the number of minutes).
** <code>APPNAME</code> - The display name of the external application.
** <code>APPPATH</code> - The path to the executable or the URI of the external application (may contain placeholders).
** <code>APPPARAMS</code> - The command line parameters for the external application (may contain placeholders).
** <code>APPAUTOSTART</code> - Start automatically. (<code>false</code> or <code>0</code> - off, <code>true</code> or <code>1</code> - when the call is connected, <code>2</code> - on each call). Numeric values only supported from 12r2 Service Release 29 and 13r1 Service Release 7.

* Additional parameters from V10 SR3:
** <code>SHOWINTASKBAR</code> - Show the myPBX launcher in the Windows Task Bar (<code>true</code> or <code>false</code>).
** <code>STARTMINIMIZED</code> - Start the myPBX launcher minimized (<code>true</code> or <code>false</code>).
** <code>DOCKING</code> - The docking mode of the launcher window (<code>none</code> or <code>left</code> or <code>right</code>).
** <code>HOTKEY</code> - The hotkey number (see registry of configured launcher).
** <code>HOTKEYMOD</code> - The hotkey modifier number (see registry of configured launcher).
** <code>HOTKEYACTION</code> - (<code>copy</code> or <code>show</code>).
** <code>VIDEO</code> - Enable video telephony and application sharing (<code>true</code> or <code>false</code>).
** <code>VIDEOPROXY</code> - Proxy server for the video websocket connection.
** <code>NOTIFICATIONS</code> - Turns desktop notification on or off (<code>true</code> or <code>false</code>).
** <code>SOUNDS</code> - Turns notification sounds on or off (<code>true</code> or <code>false</code>).
** <code>LANG</code> - A two-letter language code.

* Additional parameters from V10 SR6:
** <code>OFFICEPROVIDER</code> - Set office presence provider (default <code>myPBX</code>, empty string none, otherwise e.g. <code>Communicator</code>).

* Additional parameters from V10 SR7:
** <code>OFFICEPRESENCE</code> - false: removes the office presence provider feature from myPBX (default <code>true</code>, <code>true</code> or <code>false</code>).

* Additional parameters from V11:
** <code>SOFTWAREPHONEAUTOSTART</code> - If "true", the Softwarephone will be started and stopped together with myPBX. Also, the PBX and User Parameters (GK IP-Address, GK-ID, Username and Password) are copied from the myPBX Client into the SoftwarePhone (<code>true</code> or <code>false</code>).

* Additional parameters from 12r2:
** <code>CONFIGHIDEMASK</code> - With that parameter the administrator can hide certain parts of the configuration dialog. To calculate the hide mask add the desired values:
*** 1 - Tab "myPBX"
*** 4 - Tab "Office integration"
*** 8 - Tab "Video and application sharing"
*** 16 - Tab "External application"
*** 32 - Link "Open trace folder"
*** 64 - Tab "Softwarephone" (from 12r2 Service Release 14)
** <code>DEFAULTUSERNAME</code> - The default username for the login
** <code>DEFAULTPASSWORD</code> - The default password for the login
** <code>DEVTOOLS</code> - If "true", the context menu of the browser will show the "Inspect element" function that opens the developer tools.
** <code>OUTLOOKCONTACTSEARCH</code> - If "true", the search for outlook is set.
** <code>FORCERESTART</code> - If "true", myPBX is closed during the installation and restarted aftewards for the currently logged in user

* Additional parameters from 12r2 SR11:
** <code>SOFTWAREPHONEDEVICEPOSTFIX</code> - This postfix will be appended to the user name to determine the registration device for the softwarephone (using the autostart softwarephone feature).

''' Command line parameters '''
* The following command line parameters can be used to specify special options for running the launcher. For example the parameters are useful for starting many instances on the same computer for demonstration purposes.
** <code>/url [URL]</code> - Overrides the URL from the configuration
** <code>/user [USER NAME]</code> - Starts the web application with the given user name
** <code>/password [PASSWORD]</code> - Starts the web application with the given password
** <code>/multi</code> - '''This parameter is for testing purposes, only. Do not use in a productive environment.''' It allows to start multiple instances of the launcher. You may want to combine this option with other configuration options such as <code>/url</code> to use different configurations without the need to re-configure. The parameter also disables saving the configuration to the registry. So changing the configuration in the configuration dialog does not work.

''' Type of Service (ToS) '''
* The settings of the ToS values for video RTP and signalling packets can be done using Policy-based Quality of Service (QoS), as described in this wiki article:
** [[Howto:Set Type of Service %28ToS%29 DiffServ DSCP Values for innovaphone Windows Applications %28SoftwarePhone%2C myPBX_Video%29]]

''' Registry Paths '''

myPBX stores its settings at the following locations:
* <code>HKEY_LOCAL_MACHINE\Software\innovaphone\myPBX</code>
* <code>HKEY_CURRENT_USER\Software\innovaphone\myPBX</code>

Note: The acutal location where windows stores the settings may vary due to windows conventions and settings.

See also: [[Reference10:Concept_myPBX_Office2010_Integration#Outlook_doesn.27t_recognize_myPBX_as_presence_provider]]

== Web application ==
When started in a web browser, the following URL parameters can be used to do a basic configuration.
* <code>lang=fr</code> - Give a two-letter language code to change the language of the user interface
* <code>touch=false</code> - Loads the version for use with mouse and keyboard.
* <code>touch=true</code> - Loads the version for touch devices.
* <code>phys=</code>''location'' - Forces the PBX to assume the physical location of the WebRTC client used in this instance has the specified [[{{NAMESPACE}}:PBX_Locations#The_physical-location | physical location ]]

= Details =
== Login ==

=== PBX stored password ===

* The short name (H.323-ID) of the user object is used as the login user name.
* The password of the user object is used as the login password.
* Users without a password cannot use myPBX.
* The local session information is stored in the DOMStorage of the web browser. It is deleted when the user logs out.

In a multi PBX scenario myPBX must be connected to the same PBX as the phone. Therefore after login the user is redirected like follows:
* PBXes accept the login if they are in charge.
* Slaves redirect to the master if they are not in charge.
: Note: redirection requires previous authentication. The user must be known to the redirecting slave PBX thus.
* The master redirects to the slave that is in charge.
* Inactive standby PBXes redirect to the master.
* Active standby PBXes accept the login.
Additionally you can configure an alternative URL in the myPBX launcher that shall be used when myPBX can't connect to the primary URL.

=== Netlogon ===

See [[{{NAMESPACE}}:Concept_Netlogon_Windows_Authentication]]

== Devices ==
The different phones of the user are addressed by the device of the user object where they are registered at. Therefore there should be no more than a single registration per device. Mobile phones can be integrated using the mobility object. It is mandatory that the mobility has a device name in the fork configuration.

== SIP URIs ==
* The ''use as domain'' checkmark on the page ''PBX/Config/General'' enables addressing users across PBXes using SIP URIs.
** The system name of the PBX is used as the domain-part.
** The short name (H.323-ID) of the user object is used as the local-part.
* The constructed URI looks like an email address (user@example.com) and it should only contain characters that would also be allowed for email addresses.
* In myPBX the URI can be used for telephony and instant messaging. For local users the domain-part can be omitted (<code>user</code> instead of <code>user@example.com</code>).

== Presence ==
* In the innovaphone PBX there are different possible sources of user presence, called ''contacts''.
** <code>tel:</code> - Phone presence
** <code>calendar:</code> - Presence set by the Exchange Calendar Connector
* myPBX sets the presence for the <code>tel:</code> contact.
* The displayed user presence is a mixed presence that is derived from the indiviual presence sources by the PBX. It consists of the following information:
** Activity (<code>available</code>, <code>away</code>, <code>busy</code>, <code>lunch</code>, <code>vacation</code>, <code>dnd</code>)
** Note
** Phone status (<code>open</code> or <code>closed</code>, sometimes displayed as <code>online</code> or <code>offline</code>)
** IM status (<code>open</code> or <code>closed</code>, sometimes displayed as <code>online</code> or <code>offline</code>)
* The activity <code>dnd</code> (do not distrurb) has a special meaning. If it is set, myPBX rejects all incoming chat messages. The phones can also be configured to reject incoming calls, if <code>dnd</code> is set.

== Visibility ==
For presence and dialog monitoring access rights (visibility rules) have to be configured at the individual user objects. The admin can do that in the "Access" dialog. Templates can be used to configure rights at many user objects at a time. In myPBX users can change the values given by the administrator and add their own rules.

'''Rules refer to'''
* A user (by name, <code>alice</code> or <code>alice@example.com</code>).
* All users of a domain (by domain suffix, <code>@example.com</code>).
* or all active users of a group (by group name). Group rules can only be added by the administrator.

'''Rules turn the following rights on or off'''
* Online status (phone and IM status, see chapter Presence)
* Presence (activity and note, see chapter Presence)
* Busy state (if the user has phone calls or not)
* IDs (the remote name and number of phone calls)

If a user is member of a group, all active members of that group have implicit access rights. These rights can be configured as the "Group Default Visibility" at the PBX. If there is no matching rule (implicit or explicit) the monitoring party does not see any information.

Administrators should configure default visibility rules that match the companies privacy policy. Typical users should not have to change the visibility settings. It is recommended to use a template that defines at least a rule for the local domain. If users shall be able to configure the visibility for certain groups, a default rule for each of that groups should also be added.

== Favourites ==
The user can add up to 32 phone numbers or SIP URIs as favourites. The favourites appear in myPBX for quick access. Also the presence and the calls are monitored and displayed, if possible. The user can create multiple lists of favourites and switch between them.

== Directory search ==
Users can search for phone numbers and other information in an internal and an external LDAP directory. The directories are configured in the phone config that is stored at the user object in the PBX. Templates can be used to share the same configuration across multiple users.

The directory is also used for resolving the names of external callers.

Some LDAP servers do not return any results if non-existing name or number attributes are configured. Attribute names are case sensitive.

There is a fixed restriction to display 25 entries.

== Instant messaging ==
myPBX is a chat client that can handle live chats between users. The PBX does not store chat messages, so both users have to be online at the same time.

Chat conferences can be started by adding more people. In this case received text messages are relayed to the other participants. Also the list of participants is transmitted to each endpoint.

'''Smileys'''

myPBX displays emoticons in the text of chat messages as smileys. Here are the text codes that are supported.

[[Image:Emo happy.png]] happy :-) :) (-: (:
[[Image:Emo normal.png]] normal :-| :| |-: |:
[[Image:Emo sad.png]] sad :-( :( )-: ):
[[Image:Emo mixed.png]] mixed :-/ :/ :-\ :\ \-: \:
[[Image:Emo twinkle.png]] twinkle ;-) ;) (-; (;
[[Image:Emo lol.png]] lol :-D :D
[[Image:Emo tongue.png]] tongue :-p :p :-P :P q: q-:

'''Typing indications'''

myPBX transmits a notification when a user is typing a chat message. This can be seen by the other participants of the chat session.

'''Starting a related phone call'''

If there is a single other participant in a chat session, the chat windows shows a call button to start a phone call to the other person. The call button is hidden if the own phone is not registered.

== Application sharing ==
Support for external application sharing is deprecated, since we now have integrated [[{{NAMESPACE}}:Concept myPBX Application Sharing|Application sharing]] in the myPBX launcher.

== Apps ==

From v12r2 there is a new ''Home'' button. It opens a new third area (in addition to the ''buddies'' and ''call history'') where is possible to start ''PBX apps''.

PBX apps available in v12r2:
*[[{{NAMESPACE}}:PBX/Objects/Boolean|Boolean]] (activation, deactivation, timer)
*[[{{NAMESPACE}}:PBX/Objects/Conference#Conference_App|Conference]] (caller list, mute, exclusive speakermode, disconnect participants)
*User [[{{NAMESPACE}}:PBX/Objects/Settings|Settings]] for dynamic group membership

For configuration refer to object specific reference articles.

=== Activation===
*Restart myPBX
*select home symbol at bottom
*select right sided pen
*select apps to be used & store settings

[[Image:Mypbx_activate_apps.png]]

== History ==
The history shows recent calls. The calls are retrieved from an instance of the [[{{NAMESPACE}}:Concept_Reporting|innovaphone Reporting]] service or alternatively the local [[{{NAMESPACE}}:Services/Call-Lists|call list service]]. The call details include the call flow before and after the user was connected. When a user calls someone back from the history, the call is marked as answered in the reporting database. As this is done using the conference ID of the call even other users can see who called back at what time.

When using [[{{NAMESPACE}}:Concept_Reporting|innovaphone Reporting]] history shows the last 20 calls that were made and when we click in the "arrow" button the next 20 calls are appended to the list, if we use the local [[{{NAMESPACE}}:Services/Call-Lists|call list service]] the number calls displayed it's set on the configuration menu.

== Tracing and logging ==
myPBX can write session information to the syslog of the PBX. Check the "myPBX" checkmark on the page Maintenance/Diagnostics/Logging in order to turn it on.

If the checkmark "Write trace" is enabled in the launcher configuration, the launcher writes a rotation of trace files to the folder <code>C:\Users\[UserName]\AppData\Roaming\innovaphone\myPBX</code>.

= Interfaces for integration =
The myPBX launcher has a number of generic interfaces that can be used to integrate it with other applications.

== Protocol handlers ==
During installation myPBX registers protocol handlers for the following URI types:
;tel: start a phone call
;sip: start a phone call
;sips: start a phone call
;phone: start a phone call
;im: start a chat

They can be used to start calls and chats in myPBX from external applications.

=== Dialing from the Windows command prompt ===
Execute the following command to dial the number 012345.
start tel:012345

Execute the following command to call user@example.com.
start sip:user@example.com

Execute the following command to start a chat with user@example.com
start im:user@example.com

=== Dialing from a web page ===
This HTML link dials the number 012345, when clicked.
<a href="tel:012345">012345</a>

This HTML link calls user@example.com, when clicked.
<a href="sip:user@example.com">user@example.com</a>

This HTML link starts a chat with user@example.com, when clicked.
<a href="im:user@example.com">user@example.com</a>

== Hotkey ==
A hotkey can be configured that copies selected phone numbers from most applications to myPBX. There is can be used for dialing, call transfer and so on.

When the hotkey is pressed, myPBX will simulate a CTRL-C key which should instruct the current foreground application to copy whatever is selected in to the Windows clipboard. If the clipboard content changes due to this, myPBX will use it as ''number-to-dial''.

== Starting an external application for a call ==
myPBX can start an external application for calls. Both web applications and applications that are installed on the client PC can be configured. This configuration can be done in the launcher in the tab "External application" or using MSI parameters during installation.

The following settings can be done:
* <code>Name</code> - The name of the application as it should appear in myPBX.
* <code>Path</code> - The path of the application. This can be an URL (<code>http://crm.example.com/customer-by-number/$n</code>) or the path to a local application (<code>C:\crm\application.exe</code>).
* <code>Parameters</code> - The command line parameters of the application. This field can be left empty for web applications.

The <code>Path</code> and the <code>Parameters</code> may contain placeholders that are replaced by phone call information.
* <code>$n</code> - phone number of the remote party as seen
* <code>$N</code> - phone number of the remote party, normalized to national number format, e.g. 070317300988
* <code>$I</code> - phone number of the remote party, normalized to international number format, e.g. +4970317300988
* <code>$u</code> - uri of the remote party
* <code>$d</code> - display name of the remote party
* <code>$c</code> - conference ID (a global ID for the call)

If <code>Name</code> and <code>Path</code> are configured, an additional button will appear in myPBX at phone calls that starts the application.

===Handling 64-bit applications===
Since myPBX Launcher itself is a 32-bit process, if executed on 64-bit Windows, it will run in a WOW64 emulator. This should be considered if a 64-bit application should be started by the launcher.

E.g. the cmd.exe referenced by <code>%WINDIR%\system32</code> will be a 32-bit version. In case a 64-bit version should be started, a special path <code>%windir%\sysnative</code> should be used instead.

Some applications, like <code>curl.exe</code> which is delivered with windows are only available in 64-bit version, therefore can only be reached via the path <code>%windir%\sysnative\curl.exe</code>.

===Sending POST HTTP Requests===
In case no local application should be started, but a POST request to an external web application should be sent, a tool <code>curl.exe</code> provided with Windows 10 can be used.

For example, on an incoming call an HTTP POST request should be sent to <code>http://192.168.0.1/calls.php</code>. Following settings should be done in the launcher:
* <code>Name</code> - AnyWebAppName
* <code>Path</code> - <code>%windir%\sysnative\curl.exe</code>
* <code>Parameters</code> - <code>http://192.168.0.1/calls.php -X POST -d "number=$I&confid=$c"</code>

= Troubleshooting =
== Connection problems / Refreshes ==
Symptom: When in idle state, the myPBX web application reloads every 30 seconds.
 
This might be a problem with the [http://msdn.microsoft.com/en-us/library/aa918417.aspx TCP/IP settings of the PC]. You should set <code>ReceiveTimeOut</code> and <code>KeepAliveTimeout</code> to the default settings if they have been changed to smaller values. Please note that the values must be specified in milliseconds!

== Loss of DOM Storage Information ==
Symptom: myPBX is asking for username and password each time it is started.
 
See [[Howto:MyPBX and roaming Profiles (e.g. Citrix) - myPBX forgetting login info]] for a possible resolution.

= Appendix =

== Known Limitations==

=== WebRTC and Headset ===
Since V12r2, myPBX allow to use WebRTC technology as softwarephone client. In this case, audio and thus headset handling is done by the browser. Please note that headset physical buttons and its functions such as "onhook/offhook" will not be supported by the browser and hence not by myPBX running the WebRTC endpoint.

=== Softwarephone Autostart with long password will not work ===

If the "Start Softwarephone" function it's enabled, the use of passwords with length higher than 12 characters will result in failure to start the softwarephone application since the command used by the launcher to run the softwarephone application will be too long and not accepted.

Solution: If this feature it's enabled set password policy where passwords of myPBX passwords should not be longer than 12 characters.

=== Softwarephone Autostart use default H.323 ===

If you want to change the Protocoll you can deliver <code>config add PHONE SIG /prot SH323</code> via Updatescript after a initial start of Softwarephone by MyPBX.

=== Softwarephone Autostart with MyPBX Netlogon not work ===

If the ''Start Softwarephone'' function is enabled, and you use Netlogon for the MyPBX the Softwarephone recieved a wrong configuration.

Solution: Dont use ''Start Softwarephone'' in the MyPBX Launcher, configure your Softwarephone and use the Windows OS to start the Softwarephone Application after startup.

== Known Issues ==

===Office application crashes===
If you have Lync installed and installed myPBX afterwards and you wanted to use Lync/Communicator as Office presence provider, an office application might have crashed. 
The MSI parameter OFFICEPRESENCE allows you to disable all office presence related installation, so a Lync installation won't be broken. You can't use myPBX as presence provider anymore in this case, but Lync will still work correctly. 
If your installation is already broken, you can simply repair your Lync installation and Office won't crash anymore. 
If you want to use myPBX as presence provider, reinstall myPBX without the MSI parameter.

Update: Latest hotfix (November 2017) for SFB/Lync client fixes the issue of the crash with the Outlook-Plugin or issues with the search on the Lync client, so with this newer version both CTI clients could be installed on the same PC without problems.

===Installation via ORCA fails===
Field reports show failing installation by use of ORCA and error code 2356. Solved by change Orca setting at -> Tools -> Options -> database -> check "copy embedded streams during “Save As”

== CPU usage ==
Connected myPBX sessions need additional resources on the PBX. When all extensions die myPBX, you can have approximately a 1/3 the amount of users per box than without using it.

== Network traffic ==
In idle state the web application needs an empty message exchange every 30 seconds in order to keep the session alive. This messages take about 800 bytes. So per session the minimum network traffic is approximately:
* 1600 B/min
* 94 kB/h
* 2.2 MB/d

== Start Parameters ==
It is possible to pass start parameters from the [https://www.chromium.org/developers Chromium documentation] to the mypbx process.

Such as using a proxy
mypbx.exe --proxy-server="socks5://proxy.org:8080"

It is not guaranteed and supported that all commands of Chromium are accepted.

== Included open source software ==
The myPBX web application contains the following open source software:

'''rc4.js'''
* RC4 symmetric cipher encryption/decryption
* Copyright (c) 2006 by Ali Farhadi.
* released under the terms of the Gnu Public License.
* see the GPL for details.
*
* Email: ali[at]farhadi[dot]ir
* Website: http://farhadi.ir/

'''sha1.js'''
* Secure Hash Algorithm (SHA1)
* http://www.webtoolkit.info/

= Related Documentation =
* [http://wiki.innovaphone.com/index.php?title=Howto:Videos#myPBX Tutorial Videos]

Reference13r2:Concept Push Notifications for iOS and Android

2021-07-01T15:07:02Z

Wh2a: /* Initial configuration */

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

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

=== myPBX for iOS or Android ===
* iOS since Version 12r2sr20
* Android since Version 12r2sr23

=== myApps for iOS or Android ===
* iOS since Version 13r1
* Android since Version 13r1

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

== Configuration ==
=== PBX ===
* create one single PBX object of type [[{{NAMESPACE}}:PBX/Objects/Push|Push]] per system, even in master/slave scenarios
* the App URL must be <code>https://push.innovaphone.com/push/ws</code>
** password doesn't matter
** name and long name can be freely choosen, but must be used in the push field of user objects

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

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

=== myPBX Android specific settings ===
Push notifications are now better supported. There are new parameters in myPBX for Android "Settings/App Settings/Push notifications".

* Auto: (default setting) Operation without push with transition to "Active" at the first reception of a push notification.

* On: Operation with Push. myPBX terminates after 10 seconds of idle time and switches to "Active" the first time a push notification is received.

* Off: Operation without Push. myPBX tries to keep the registration permanently active.

* Active: Operation with Push. Notifications have already been received successfully.

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

[[Image:push.gif]]

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

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

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

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

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

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

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

===myPBX for Android push configuration checks ===

Go through the following steps, to check that in your Android phone, Push is configured correctly.

[[Image:Concept_Push_Notifications_for_myPBX_iOS_and_Android_1.jpg]]

Open myPBX, and check that the registration for the user is up, press the wheel symbol on the top left, then App Settings
# Tap "Calling account" and check that myPBX slide is enabled (to the right)
#Back to the App settings page and tap on "Data Saver" and check that "background data" is enabled.
#Back on the app settings page, tap on "overlaying" and check that "Allow display over other apps" is enabled.
#Check that "push notifications" is enabled (on)

===myPBX for iOS push configuration checks ===
Go through the following steps, to check that in your iPhone, Push is configured correctly.
#Open your Settings app
#Tap Notifications on the left-hand side of your screen.
#Find the myPBX app and make sure notifications are allowed

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

[[Image:Troubleshoot_v13_Push_with_myApps_for_Android and iOS_1.jpg]]

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

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

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

== Known limitations ==
=== Call accept time for users with myPBX client only ===
In case no other endpoints are registered on the User object, but only the myPBX client, the PBX will not provide any alerting message to the calling party, until the myPBX client on the device restores the registration to the PBX via push notification. In case no registration appears after 10 seconds, the PBX will send "no user responding" as cause code to the calling party.

=== Push is not working if no device registered and a CFNR is configured ===
In case no endpoints are registered on the User object, and there is also a CFNR configured. The Push will not be executed and as result the CFNR will be exectuted immediately.

This is a known limitation and is under investigation.

A temporary workarround which will fix this issue has been found.

Solution: Create a Forking on the users object to its own number !

Push will work and if the device is able to register within 10 seconds the myPBX app will ring and the CFNR will be executed with the configured timer.

=== Push does work even when the myPBX app is switched off ===
The Push mechanism will also work when the myPBX app is turned off. This can lead to complains about receiving calls after working ours or during holidays.

There is one solution to prevent the myPBX app from ringing. During Off-bussines hours you can select the DND do not disturb option. Calls will be still signaled, but the phone will not ring.

For longer periods or if you don't want the myPBX to receive calls at all during Holidays.

First shut it down within the app (and swipe to close) so that the myPBX is realy not running anymore.
Then in the iPhone settings, within notifactions, disable the notification for myPBX.
This will prevent the myPBX app to be started again.

An alternative method introduced in August 2019 to prevent myPBX from being started is to configure "Settings", "App settings", "Start automatically" to "Never". Whenever myPBX is closed via the button on the settings screen, a push notification will not start it. Once myPBX has been opened again, push notifications will continue to take effect.

This is a way how the user can stop the push-functionality themself. Of course, after the holiday they have to enable the push notification in the iPhone again themself.

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

==Known issues==

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

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

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

Reference13r2:Concept Push Notifications for iOS and Android

2021-07-01T15:06:10Z

Wh2a: /* Initial configuration */

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

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

=== myPBX for iOS or Android ===
* iOS since Version 12r2sr20
* Android since Version 12r2sr23

=== myApps for iOS or Android ===
* iOS since Version 13r1
* Android since Version 13r1

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

== Configuration ==
=== PBX ===
* create one single PBX object of type [[{{NAMESPACE}}:PBX/Objects/Push|Push]] per system, even in master/slave scenarios
* the App URL must be <code>https://push.innovaphone.com/push/ws</code>
** password doesn't matter
** name and long name can be freely choosen, but must be used in the push field of user objects

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

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

=== myPBX Android specific settings ===
Push notifications are now better supported. There are new parameters in myPBX for Android "Settings/App Settings/Push notifications".

* Auto: (default setting) Operation without push with transition to "Active" at the first reception of a push notification.

* On: Operation with Push. myPBX terminates after 10 seconds of idle time and switches to "Active" the first time a push notification is received.

* Off: Operation without Push. myPBX tries to keep the registration permanently active.

* Active: Operation with Push. Notifications have already been received successfully.

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

[[Image:push.gif]]

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

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

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

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

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

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

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

===myPBX for Android push configuration checks ===

Go through the following steps, to check that in your Android phone, Push is configured correctly.

[[Image:Concept_Push_Notifications_for_myPBX_iOS_and_Android_1.jpg]]

Open myPBX, and check that the registration for the user is up, press the wheel symbol on the top left, then App Settings
# Tap "Calling account" and check that myPBX slide is enabled (to the right)
#Back to the App settings page and tap on "Data Saver" and check that "background data" is enabled.
#Back on the app settings page, tap on "overlaying" and check that "Allow display over other apps" is enabled.
#Check that "push notifications" is enabled (on)

===myPBX for iOS push configuration checks ===
Go through the following steps, to check that in your iPhone, Push is configured correctly.
#Open your Settings app
#Tap Notifications on the left-hand side of your screen.
#Find the myPBX app and make sure notifications are allowed

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

[[Image:Troubleshoot_v13_Push_with_myApps_for_Android and iOS_1.jpg]]

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

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

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

== Known limitations ==
=== Call accept time for users with myPBX client only ===
In case no other endpoints are registered on the User object, but only the myPBX client, the PBX will not provide any alerting message to the calling party, until the myPBX client on the device restores the registration to the PBX via push notification. In case no registration appears after 10 seconds, the PBX will send "no user responding" as cause code to the calling party.

=== Push is not working if no device registered and a CFNR is configured ===
In case no endpoints are registered on the User object, and there is also a CFNR configured. The Push will not be executed and as result the CFNR will be exectuted immediately.

This is a known limitation and is under investigation.

A temporary workarround which will fix this issue has been found.

Solution: Create a Forking on the users object to its own number !

Push will work and if the device is able to register within 10 seconds the myPBX app will ring and the CFNR will be executed with the configured timer.

=== Push does work even when the myPBX app is switched off ===
The Push mechanism will also work when the myPBX app is turned off. This can lead to complains about receiving calls after working ours or during holidays.

There is one solution to prevent the myPBX app from ringing. During Off-bussines hours you can select the DND do not disturb option. Calls will be still signaled, but the phone will not ring.

For longer periods or if you don't want the myPBX to receive calls at all during Holidays.

First shut it down within the app (and swipe to close) so that the myPBX is realy not running anymore.
Then in the iPhone settings, within notifactions, disable the notification for myPBX.
This will prevent the myPBX app to be started again.

An alternative method introduced in August 2019 to prevent myPBX from being started is to configure "Settings", "App settings", "Start automatically" to "Never". Whenever myPBX is closed via the button on the settings screen, a push notification will not start it. Once myPBX has been opened again, push notifications will continue to take effect.

This is a way how the user can stop the push-functionality themself. Of course, after the holiday they have to enable the push notification in the iPhone again themself.

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

==Known issues==

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

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

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

Howto:NL - MOTTO - VaMo Configuration

2019-05-13T11:02:59Z

Wh2a:

==Product Name==
Motto Sim card

==Certification Status==
{{Template:Compat_Status_referral_product_new}}

Vendor test report and configuration hints were received Apr 26th, 2019

==Category==


[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Mobile_Integration}}
[[Category:3rdParty_Mobile Integration|{{PAGENAME}}]]

==Description==

Integrating a normal mobile cellphone or smartphone to your PBX as a SIP-client.

==Features==
Summary of the features:
* Routing options available in the Flux portal:
** Route calls to the PBX
** Route calls to mobile
** Mixed
** Scheduled

Use the native dialer of your mobile phone for internal and/or external calls to PSTN as it is a normal internal user on the PBX.

==Configuration==

This configuration is for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

=PBX configuration=

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)
Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

[[Image:MottoVaMoUserObject.png]]

=Session Border Controller object setup=

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On
Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On
Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

[[Image:MottoVaMoSBCObject.png]]

=Set Sip config on the PBX and SBC=

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

[[Image:MottoVaMoPBXSetting.png]]

=Motto Flux portal SIM card settings=

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)
Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)
DTMF signaling mode: auto

Register the SIM.

Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

[[Image:MottoVaMoReg.png]]

[[Image:MottoVaMoSetting.png]]

[[Image:MottoVaMoRouting.png]]

=Contact=

Aaltjan Evink

WH2A B.V.

Gildenveld 63

3892 DD Zeewolde

Flevoland, Nederland

Email: info@wh2a.com

Support: support@wh2a.com

Tel: +31 36 522 7879

File:MottoVaMoReg.png

2019-05-13T11:02:48Z

Wh2a:

File:MottoVaMoRouting.png

2019-05-13T11:00:52Z

Wh2a:

File:MottoVaMoSetting.png

2019-05-13T11:00:35Z

Wh2a:

File:MottoVaMoPBXSetting.png

2019-05-13T11:00:18Z

Wh2a:

File:MottoVaMoSBCObject.png

2019-05-13T10:59:48Z

Wh2a:

File:MottoVaMoUserObject.png

2019-05-13T10:57:38Z

Wh2a:

Howto:NL - MOTTO - VaMo Configuration

2019-05-13T10:57:09Z

Wh2a:

==Product Name==
Motto Sim card

==Certification Status==
{{Template:Compat_Status_referral_product_new}}

Vendor test report and configuration hints were received Apr 26th, 2019

==Category==


[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_Mobile_Integration}}
[[Category:3rdParty_Mobile Integration|{{PAGENAME}}]]

==Description==

Integrating a normal mobile cellphone or smartphone to your PBX as a SIP-client.

==Features==
Summary of the features:
* Routing options available in the Flux portal:
** Route calls to the PBX
** Route calls to mobile
** Mixed
** Scheduled

Use the native dialer of your mobile phone for internal and/or external calls to PSTN as it is a normal internal user on the PBX.

==Configuration==

This configuration is for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

=PBX configuration=

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)
Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

[[Image:MottoVaMoUserObject.jpg]]

=Session Border Controller object setup=

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On
Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On
Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

=Set Sip config on the PBX and SBC=

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

=Motto Flux portal SIM card settings=

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)
Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)
DTMF signaling mode: auto

Register the SIM.

Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

=Contact=

Aaltjan Evink

WH2A B.V.

Gildenveld 63

3892 DD Zeewolde

Flevoland, Nederland

Email: info@wh2a.com

Support: support@wh2a.com

Tel: +31 36 522 7879

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:55:39Z

Wh2a:

--[[User:Wh2a|Wh2a]] 09:55, 26 April 2019 (CEST)

'''NL Motto VaMo configuration.'''

This configuration if for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

'''PBX configuration:'''

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)
Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

'''Session Border Controller object setup:'''

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On
Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On
Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

'''Set Sip config on the PBX and SBC:'''

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

'''Motto Flux portal SIM card settings:'''

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)
Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)
DTMF signaling mode: auto

Register the SIM.

Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:54:27Z

Wh2a:

'''NL Motto VaMo configuration.'''

This configuration if for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

'''PBX configuration:'''

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)
Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

'''Session Border Controller object setup:'''

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On
Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On
Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

'''Set Sip config on the PBX and SBC:'''

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

'''Motto Flux portal SIM card settings:'''

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)
Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)
DTMF signaling mode: auto

Register the SIM.
Check the registration on the SBC and PBX using the logging.
Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:52:33Z

Wh2a:

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:51:25Z

Wh2a:

'''NL Motto VaMo configuration.'''

This configuration if for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

'''PBX configuration:'''

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)

Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

'''Session Border Controller object setup:'''

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On

Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On

Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

'''Set Sip config on the PBX and SBC:'''

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

'''Motto Flux portal SIM card settings:'''

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)

Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)

DTMF signaling mode: auto

Register the SIM.
Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:50:32Z

Wh2a:

'''NL Motto VaMo configuration.'''

This configuration if for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

'''PBX configuration:'''

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)

Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

'''Session Border Controller object setup:'''

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On

Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On

Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

'''Set Sip config on the PBX and SBC:'''

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

'''Motto Flux portal SIM card settings:'''

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)

Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)

DTMF signaling mode: auto

Register the SIM.
Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:50:11Z

Wh2a:

'''NL Motto VaMo configuration.'''

This configuration if for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

'''PBX configuration:'''

Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)

Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

'''Session Border Controller object setup:'''

On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On

Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On

Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

'''Set Sip config on the PBX and SBC:'''

Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

'''Motto Flux portal SIM card settings:'''

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)

Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)

DTMF signaling mode: auto

Register the SIM.
Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.

Howto:NL - MOTTO - VaMo Configuration

2019-04-26T07:47:52Z

Wh2a: Howto register a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

NL Motto VaMo configuration.

This configuration if for registering a Motto Sim card to the PBX using a Innovaphone Session Border Controller.

'''PBX configuration:'''
Create a new user object.
Description: Motto VaMo
Long Name: Name of the user
Display Name: Name of the user
Name: (international format of the mobile number example: 31612345678)
Number: (extension number for this user)

Password: (password for the SIP registration)
Hardware Id: (international format of the mobile number example: 31612345678)
PBX password: On

'''Session Border Controller object setup:'''
On he SBC create a net Session Border object for the SIM:

Long Name: Name of the user
Password: (password for the SIP registration)
Media Relay: On

Gatekeeper Id: ID of the PBX
Primary Adr: IP of the PBX
Name: (international format of the mobile number example: 31612345678)
PBX Password: On

Name: (extension number for this user)
PBX Password: Off
TLS Only: Off
Press OK

'''Set Sip config on the PBX and SBC:'''
Set this option using Maintenance, Diagnostics, Command.
!config add SIP /take-source-addr-as-contact-addr /x-ice-disabled
!config write
!config activate
reboot the PBX and SBC to be sure these options have been enabled.

'''Motto Flux portal SIM card settings:'''

Device: SIM card
Registration server: IP or DNS name of the Session Border Controller.
SRV option (disabled)
Port: 5060 (SIP port)
From user: (extension of the user object)

Username: (international format of the mobile number example: 31612345678)
Password: (password of the user object)

DTMF signaling mode: auto

Register the SIM.
Check the registration on the SBC and PBX using the logging.

Adjust the settings on the portal to route calls to the PBX / mobile or scheduled mixed.