innovaphone wiki - User contributions [en]

Reference13r2:Gateway/Interfaces/SIP

2025-04-25T11:53:48Z

Aci:

== SIP Registration section ==
The entry fields for a '''SIP registration''' are:
{|
|valign=top nowrap=true|'''Name'''
|Descriptive name for this registration.
|-
|valign=top nowrap=true|'''Disable'''
|A switch to temporarily disable this interface without deleting the configuration.
|-
|valign=top nowrap=true|'''Type'''
|
*Provider: Creates a registration at a remote SIP server (of a SIP provider)
*Open Federation: SIP/TLS interface without registration used to send and receive calls to federation partners.
*Closed Federation: Like 'Open Federation' but even more restricted to pre-configured set of federation partners. In the 'Closed Federation' mode, the DNS queries for resolving the domain name of the federation partner are made without the '''Recursion Desired''' (RD) Flag. This means only DNS entries configured on the local DNS server are resolved, so the list of the partners for 'Closed Federation' must be maintained on the local DNS server.
|-
|valign=top nowrap=true|'''Transport'''
|
*UDP: SIP signaling using UDP as transport protocol (RFC 3261).
*TCP: SIP signaling using TCP as transport protocol (RFC 3261).
*TLS: SIP signaling using TLS as transport protocol (RFC 3261). [[Howto:Security works with innovaphone]]
*Without registration: By default sip trunks are using with registration. Can be disabled here.
|-
|valign=top nowrap=true|'''AOR'''
|Address of Record: SIP-URI used to register. Enter the registration ID followed by the SIP provider domain name (for example 8111111e0@sipgate.de or 8111111e0@x.x.x.x:5080 if you need to use the IP-address and a different Port number).
|-
|valign=top nowrap=true|'''Local Hostname'''
|The Local Domain for SIP Federation enables to select the TLS Certificate according to the Domain Name. On the incoming SIP calls the host part of the URI is removed if equals with the Local Domain configured here, and the user part is used as Name (H323-ID) or Number (E164).
|-
|valign=top nowrap=true|'''Local Port'''
|The local source port for SIP signalling can be configured here. If its empty a random port will be used. ''Dont use the same static port on multiple SIP Accounts!''
|-
|valign=top nowrap=true|'''Proxy'''
|DNS name or IP address of the SIP proxy where SIP messages (REGISTER,INVITE,etc) are to be sent to. Proxy can be omitted if domain part of AOR can be used as remote signaling destination. (append ":<port>" if you need a different destination Port)
|-
|valign=top nowrap=true|'''STUN Server'''
|The STUN servers to use. See [[{{NAMESPACE}}:IP4/General/STUN | STUN]] for details regarding the format.
|}

== Authorization ==
Username and password for authorization. Username can be omitted if equal to userpart of AOR.

== Media Properties ==

The configuration of the media properties is evaluated for calls from/to this interface to/from a physical (ISDN, analog, TEST, ...) only. If media relay is active for a call using this interface an 'exclusive' coder config is used to prohibit the use of any other coder. This 'exclusive code media-relay' config can be used to solve interop problems with other equipment which does not support media renegotiation, because with this config no media renegotiation will be performed.

For more information see [[{{NAMESPACE}}:Gateway/Interfaces/Media_Properties | Media Properties]] and [[Howto:Security works with innovaphone]]

== SIP Interop Tweaks ==

{|
|valign=top nowrap=true|'''Proposed Registration Interval'''
|Set in seconds, default is 120 seconds
|-
|valign=top nowrap=true|'''Accept INVITE's from Anywhere'''
|If disabled, registered interfaces will reject INVITE's not coming from the SIP server with "305 Use Proxy".
|-
|valign=top nowrap=true|'''Enforce Sending Complete'''
|Affects handling of "484 Address Incomplete" responses. If enabled and "484 Address Incomplete" is received, the call is cleared. If not enabled and "484 Address Incomplete" is received, the call is retained and re-initiated in case of new dialing digits.
|-
|valign=top nowrap=true|'''No Video'''
|Removes Video Capabilities from outgoing media offer.
|-

|valign=top nowrap=true|'''To Header when Sending INVITE'''
|Affects only outgoing diverted calls .
*'''Called Party''': If set we write CDPN into To header of outgoing INVITE (and DGPN into History-Info header).
*'''Original Called Party''': If set we write the DGPN into To header of outgoing INVITE (and CDPN into Request-URI).
|-
|valign=top nowrap=true|'''From Header when Sending INVITE'''
|Controls the local URI (From header) of outgoing calls. Applys to registered interfaces only.
*'''Fixed AOR''': Fixed AOR is used as From-URI regardless of the actual calling party number.
*'''AOR with CGPN as Display''': Fixed AOR is used as From-URI and calling party number is added as display string.
*'''CGPN in user part of URI''': Variable From-URI with actual calling party number.
|-
|valign=top nowrap=true|'''Identity Header when Sending INVITE'''
|Controls the identity header (P-Preferred-Identity, P-Asserted-Identity and Remote-Party-Id) sent on outgoing calls
*'''CGPN in user part of URI''': Variable Identity-URI with actual calling party number
*'''Fixed AOR''': Fixed AOR is used as Identity-URI regardless of the actual calling party number
*'''UUI''': the relayed call must include ''user-to-user-info'' (UUI). This UUI is used as Identity-URI. [[Howto:How_to_customize_the_From/Identity_header_value_at_SIP_interfaces|In the UUI]], the string <code>{initiator}</code> is replaced by the the call's ''diversion-info'' (a.k.a. ''leg-2-info'') if available or the calling party number otherwise
|-
|valign=top nowrap=true|'''Reliability of Provisional Responses'''
|Controls the support of PRACK (RFC-3262).
*'''Supported''': Supported as optional extension.
*'''Required''': Required as mandatory extension.
*'''Disabled''': Hide support for PRACK extension.
|-
|valign=top nowrap=true|'''Advanced'''
|Allows the configuration of additional, not further documented, interop tweaks(e.g. /pai on). The same tweaks can be configured also globally(i.e. not for this SIP-Interface) at the SIP(or TSIP/SIPS)-module. Any tweaks configured at the SIP-Interface will overwrite globally configured tweaks.
|}

=== More frequently used ''Advanced'' Parameters ===
There are some options which influence the stack behaviour to handle ambiguities in the SIP standard:

; /pai on : send identity URI in <code>P-Asserted-Identity</code> header. By default, it is sent in the <code>P-Asserted-Identity</code> header for calls from the PBX to the endpoint, in the <code>P-Preferred-Identity</code> header otherwise
; /ppi on : send identity URI in <code>P-Preferred-Identity</code> header

Other options are available which instruct the stack to use non-standard or deprecated behaviour. Note that this should only be used in rare cases. Better have the vendor of your 3rd party SIP equipment fix its stack implementation:

; /send-deprecated-diversion-header on : send call history information in the deprecated <code>Diversion</code> header in addition to the <code>History-Info</code> header
; /single-audio-description : don't send SAVP+AVP, but SAVP or AVP media description in SDP
; /no-authentication-info : don't send <code>Authentication-Info</code> header in REGISTER response
; /send-no-historyinfo : don't send call history information (i.e. call forward) in outgoing Invite
; /contact-addr [option] : adjust the Contact header to a fixed value necessary in scenarios of SIP Provider trunk without registration using TCP/TLS and uses Contact Header for Authentication. Example /contact-addr x.x.x.x:5061;user=phone;transport=TLS
; /options-interval n : Send SIP options every "n" seconds to the configured remote SIP Address configured on the Interface.
; /get-cdpn-from-to-uri : get CDPN of incoming provider-calls from To-URI instead of Request-URI
; /prefer-pai : get CGPN from PAI/PPI/RPID if present
; /no-diverting-name: don't add display name to diverting party URI

=== Extra Options ===
{{3rd_Party_Input}}

==== Disable Interworking of Hold Notifications to SIP Provider ====

During the tests we concluded that when interworking the hold-notify message to SIP and sending to the SIP Provider two consecutive Re-Invites with "send-only" attributes, the IMS platform replies to the second re-invite with "inactive". By doing so this call is put on hold without any Music on Hold - just silence.
To avoid this behaviour we need to disable the interworking of the hold-notify message by this setting:

!config add SIP /no-hr-notify (Alternative: TSIP / SIPS)
!config write
!config activate

==== SIP Options Interval (Optional) ====

Some Provider uses SIP Options to monitor the SIP Trunks, so it's mandatory that Innovaphone replies to incoming SIP Options received. This is done by default. Additionally we can also send SIP Options to the SIP Proxy and have similar mechanism for redundancy. If the remote Proxy doesn't reply to outgoing SIP Options, the Innovaphone Gateway will send the call to the next interface. To enable sending of Options - messages, the following setting must be done:

!config add SIP /options-interval 30 (Alternative: TSIP / SIPS)
!config write
!config activate

This option will only take effect on connections "without registration". In connections with a registration there already exist a keep alive.

==== Remove Comfort Noise (CN) Capability from SDP ====

During the tests we found out that some specific 3rd party devices connected to the IMS network support only a single coder/payload in the offer. When doing the coder negotiation, this devices repeat the coder negotiation until they have only 1 coder in the offer or until they reach a specific number of retries. Since Innovaphone by default always include the payload 13 (Comfort Noise) in addition to the used voice coder/payload, this would make the remote device to do multiple re-invites to try to reach the single coder/payload in the offer.
To avoid unnecessary signalling, we should disable the sending of Comfort Noise capability.

!config add SIP /rem-cn-capability (Alternative: TSIP / SIPS)
!config write
!config activate

==== Setting of P-Asserted ID instead of P-Preferred ID ====

When using the feature of ReRouting the call (SIP 302 Move Temporary) to the SIP Trunk, the IMS platform checks the P-Asserted ID setting. By default we send as P-Preferred ID instead, so that will not work. As a result, we need to configure the following setting:

!config add SIP /pai (Alternative: TSIP / SIPS)
!config write
!config activate

Reference15r1:IP1202/IP1203 DECT System

2025-04-24T17:39:22Z

Aci:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

'''All IPv4 TLS Traffic'''

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

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

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

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

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

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

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

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

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

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


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

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

===No Multicell License Required===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Test-SARI ==

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

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

31100422072149

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

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

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

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

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

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

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

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

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

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

Following status are indicated:

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

IP1202 operational and no traffic on the IP1202/IP1203.

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

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

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

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

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

Fully occupied with speech traffic.

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

Firmware download in progress.

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

The IP1202 is in mini firmware mode.

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

TFTP mode.

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

No Ethernet connection.

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

Fatal hardware error.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

config add MSP0 /ec-type 1

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

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

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

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

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



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

Reference14r2:Concept App Service Contacts

2024-10-16T10:00:24Z

Aci:

[[Category:Concept|Apps]]
= Applies To =
* App Contacts version 14r2

= Overview =
The App Service Contacts is an App Service which can be installed on an innovaphone App Platform. It is used for information retrieval of a database of contact entries, as well as maintaining personal contact books.

Inside Contacts, personal and general entries can be searched (forward lookup) or be used to resolve incoming numbers to their respective name (reverse lookup).

= Features =
*Import: Semicolon (;) separated CSV file
*Database for contact entries: A user interface for retrieval purposes is available.
*API: Search API and Lookup API for other apps
*Edit Functionality: Contact entries are editable.
*Personal Address Book: Every user can maintain one or more personal address books.
*Access Right Management: Owners can maintain access privileges for single users or even groups of users, in order to control visibility of an address book.
== 14r2 Features ==
Features added to the version 14r2
;User-Interface improvements
: Contact entries retrieved are rendered in a condensed card representation. A '''Details'''-button expands and displays remaining contact information
;Presence Updates
:Useful in federation scenarios. For displayed and currently visible contact entries, presence monitoring calls are placed, in order to display availablity status. Underlying resources are going to be freed immediately for entries scrolled out of visibility.
;Fax button
:Placing a call to a fax number is going to start the fax application
;Adding Contacts from within the Softphone App or Call List App
:Contacts can be added by means of a button '''Softphone/Call List/<entry>/"Add Contact"'''
;Import, export for personal directories
New buttons '''Hamburger/Directories/<directory>/Import,Export''' allow for CSV-download and -upload respectively.

= Requirements =
innovaphone PBX and App Platform from on version 13r3 - version 14r2 is recommended.
==Upgrade Considerations==
From 13r3 to 14r2 no special upgrade scenarios need to be considered as the database structure remains the same. On the other hand, if the new com.innovaphone.contacts API will be used (which helps to add contacts from within the phone apps) and a manual update is performed then the Websocket Checkmark should be set on the PBX App Object.

For prior versions please consider the following:

As always, don't forget to backup an existing App Platform in prior. This 13r3 App Contacts does alter the underlying database scheme.
;13r3 App on 13r1 App Platform, 13r1 PBX:Doesn't work. The 13r3 Contacts App does not work on an 13r1 Application Platform/Environment.
;13r3 App on 13r2 App Platform, 13r2 PBX:The 13r3 Contacts App works with the restriction, that the reverse lookup for private address books doesn't work. For full feature set, also upgrade the App Platform and PBX to 13r3.

=Apps=
=== Contacts App (innovaphone-contacts) ===
The regular app
=== Contacts Admin App (innovaphone-contacts-admin) ===
Features a menu (top-right) to manually upload a CSV file
=== Contacts Search API (innovaphone-contacts-searchapi) ===
This hidden app rovides a search API and a lookup API to other apps, e.g. for the Phone App

= Concept =
General contact entries and entries for personal directories are stored within the same database. With the table '''acl''' which is acting as an access control list, restricted views and edit rights for personal directories can be granted.

This way, only the owner of a personal directory (and granted user or groups) can see the content.

==Number handling==
In principle, two versions of a phone number are always stored in the contacts database.
;Original Number
:This is the unchanged number imported by the user. This version includes all decorative characters, spaces, etc. (eg. +49-(7031) 730090)
;Formatted number
:A filter is applied to the original number before saving to remove all non-dialable characters. (This means that only <code>0-9,+,*,#</code> remain after that) This formatted version of the call number is saved in addition to the data set. (eg. +497031730090)

If a number is searched for (reverse lookup), the cleaned version is searched for. Thus, it does not matter which decorative characters or formats are imported.
If an entry is displayed to the user, the originally entered call number (incl. decoration characters) is displayed.

It is therefore best practice to import only international format numbers (Decorations can be imported as they will be removed anyway), as the PBX always converts the number into the international format for a reverse lookup, if the [[Reference13r1:Concept_Number_Adjustments_%28Dialing_Location%29 |dialing location]] was configured correct.

==Assign unique IDs for contacts entries==
It is recommended to upload CSV files with an additional column ''extAnchor''. The column extAnchor allows to identify individual entries uniquely and independent of renaming operations. The column ''extAnchor'' is supposed to contain an external unique database id, alike a guid. If ''extAnchor'' was provided the import procedure will perform an UPDATE of previously existing entries, instead of deleting and re-INSERTing the entries. Entries pinned on home are going to remain functional.

==List of Attributes==
The list of currently available attributes for a contacts entry follows:
;extAnchor
: unique id identifying the entry within the database
;givenname
:First name
;sn
:Surname/Family name
;company
:Corporation
;displayname
:Name to be displayed
;email
:e.g. ''example@example.com''
;telephonenumber
:Internationalized land-line telephone number, e.g.'' +49 7031 730090''
;mobile
:Internationalized mobile telephone number
;homephone
:Internationalized home phone number
;facsimiletelephonenumber
:Internationalized fax number
;city
:City/Town, e.g. ''Milano''
;street
;postalcode
;state
:Federal state, e.g. some US states: ''Ca, Wa, Fl''
;country
:e.g. ''Deutschland, Italia''
;privatecity
:Home address
;privatestreet
;privatepostalcode
;privatestate
;privatecountry
;title
:Academic title
;position
:Position within company, department
;department
;description
:Common description
;roomnumber
;info
:Common info
;url
:Company URL
;sip
:Dialable SIP address
;uuid
:A constant universal unique id as string. Internally assigned during entry creation.

==List of Text-Indexable Attributes==
Attributes to be considered for the full-text index
*cn
*sn
*givenname
*company
*displayname
*city
*street
*postalcode
*country
*state
*private_city
*private_street
*private_postalcode
*private_country
*private_state
*title
*position
*department
*description
*roomnumber
*sip

==Built-in LDAP Server==
The App incorporates a proprietary LDAP server functionality. The purpose of the LDAP server functionality is to service innovaphone LDAP clients, such as desk phones.
The LDAP server only supports a proprietary search by means of a meta attribute<ref>Meta attribute: Here an attribute with a special meaning and that is non-physical, not existing within the database</ref>, whereby LDAP is just utilized as a transport vehicle for a user's search input one-to-one.
*E.g. a user searching for ''John Doe innovaphone''
**Possible user input ''jo do inno''
**Resulting LDAP filter ''(metaSearchText=jo do inno)''

'''Important:'''

Note, that access to restricted/personal phone books requires the proprietary scheme within the LDAP client, mentioned above.

Currently, this is available in the innovaphone IP phone LDAP clients from 13r3 on, but not on 3rd party devices nor our DECT gateways (IP120x). On these clients, only contact data in unrestricted phone books is searched.

===Sample Phone Configuration, innovaphone===
Phone/User-X/Directories/External LDAP Server
;Enable: Active
;Use TLS: Active
;Server: <host adddress of App Platform>
;Port: <can be left empty>
;Username,Pw: <Credentials for LDAP Bind operation>
;Search Base: ''dc=entries''
;Mode: <can be left on "basic">
;Object Filter: <leave empty>
;Sort Results: Inactive
;Name Attributes: ''givenName,sn,company''
;Number Attributes: <can be left empty>
;H323 ID Attribute:'' sip''
;Detail Attributes: ''title,company,street,postalCode,city,country,email,url''
;Meta Name Attribute: ''metaSearchText''
;Meta Number Attribute: ''metaSearchNumber''

= Personal Address Book Details =
Contact entries can be added, edited and deleted. It is also possible to create and maintain personal address book(s), as well as share them with other users or whole user groups.

Only user/groups with sufficient rights, will be able to see other address books. An Access control list (acl) is used, to control these rights.

Groups correspond to PBX-groups. The Contacts App gets to know only active PBX-group memberships.

By default, only the user who created an address book, is able to see the content.

==Maintain a Personal Address Book==
;Creating a Personal Address Book
:Click on '''+Contact''' and proceed. If no directory existed before, one will be automatically created by the name pattern '''Personal Directory: <user's short name>'''.
:Or click on the burger menu in the top right corner inside the Contacts-App, and there on the '''"Directories"'''. Now click on the '''"+"'''-Symbol, choose a suitable name and confirm your name via '''"Save"''' button. A new address book is created.
;Adding a new contact
Click on the '''"+"'''-Symbol in the top right corner inside the Contacts-App and select an address book, where you want the contact to be stored in. Now fill in the contact information (the fields ''"name"'' and ''"last name"'' '''have to be filled''') and save it via '''"Save"'''-button.
;Editing an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, click on the entry you want to edit and after your change, save it via '''"Save"'''-button on the bottom.
;Delete an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, and on the '''"trashcan"'''-symbol at the top. After confirmation, the entry is deleted.

==Sharing of Address Book==
;Share globally
*Either remove all rules from a personal directory. Such a configuration corresponds to pre-13r3 capabilities. Up to 13r2 there weren't any visibility rules available.
*Or make every PBX user an active member of a group e.g. "everybody" and add a directory rule for that group "everybody".

;Share with single user(s)
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"User"''' as type. In the input field, you can enter and therefore filter for all available users. Select the user, whom you want to give access and select either if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''.

;Share with a group
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"Group"''' as type. In the input field, you can enter and therefore filter for all available PBX groups. Also select, if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''-button.

;Revoke of granted rights
You can also revoke previous granted rights by just clicking on the user/group at the access control list, and click on the '''trashcan''' symbol. Now submit your change with another click on '''Ok'''-button.

==Upload a new Directory==
The Contacts Admin App allows uploading a CSV file as known from the 13r2 version ('''Hamburger/Import'''). In the course of an upload operation, a new directory will be created. The newly assigned directory name will be the name of the CSV file.
After uploading, the visibility setting of the new directory should be administrated as stated before under [[#Sharing_of_Address_Book|Sharing of Address Book]]

==Terminology==
;ACL: Access control list. Refers the database table ''acl'' and rows/entries therein.
;Directory: Refers the database table ''dbs'' and rows/entries therein. All contact entries referencing a ''dbs''-row make up the content of a directory.
;Address Book: Synonymous with ''Directory''
;Contacts Admin: A user utilizing the Contacts Admin App (via App URL, ending with ../innovaphone-contacts-admin)
;Directory Admin: A user entitled the admin right for a directory. Either by user-wise or by group-wise ACL entry.
;Directory User/Viewer: A user entitled the viewing right for a directory. Either by user-wise or by group-wise ACL entry.

==Database Changes==
Three tables realize the functionality for personal directories.
*Table '''dbs'''. Each row represents a directory. Two new columns ''displayname, sip'' where added.
**'''displayname''' Name display.
**'''sip''' Creator's sip name, if available.
*Table '''acl'''.New table acting as access control list. Each row references a directory as listed by table ''dbs'' and is going to grant view- and admin-right to a specific user or group.
**'''dbsid''' Reference into table dbs.
**'''name''' The name of a user or a group.
**'''acltype''' A numeric value: user(0), group(1)
**'''admin''' Granting edit right: admin(true), non-admin(false)
*Table '''entries'''. Each row within this pre-exisisting table represents a contact entry. The column ''dbsid'' informs about whether an entry belongs to a specific directory.

<pre>
#Excerpt for an additional directory ''Persönliches Verzeichnis: mst'' with one contact entry.

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri | displayname | sip
----+------------------------------------------------------+--------------------------------+-----
7 | file:///4eaae395-9971-40fb-9a05-dfae1d023f12?sip=mst | Persönliches Verzeichnis: mst | mst # Specification for directory ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from acl"
id | dbsid | name | acltype | admin
----+-------+------+---------+-------
5 | 7 | mst | 0 | t #user 'mst' can view and edit directory with dbsid=7 ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select sn,givenname,company,id,dbsid from entries where dbsid=7"
sn | givenname | company | id | dbsid
----------+-----------+--------------+-------+-------
Duck | Dagobert | Duck Corp. | 51394 | 7 # main table entries contains 1 entry belonging to ('Persönliches Verzeichnis: mst')

</pre>

==Reverse Number Lookup for Personal Directories==
Queries into directories are access-checked by looking-up and enforcing ACL-rules. The information on whose name is being queried and which group memberships are taking effect is needed for this process.

Websocket connections to the Contacts App service carry those infos within the SDK method ''AppWebsocketConnectComplete()''.
LDAP connections pass this information within a proprietary LDAP control together with an LDAP searchRequest message.

The PBX's centralized Reverse Lookup service (see ''PBX/Config/General/Reverse Lookup URL'') does support this mechanism. That is, for every LDAP searchRequest the affected user's name and active group memberships are going to be sent towards the Contacts App's LDAP server.

See also [[{{NAMESPACE}}:Concept_Reverse_Lookup|concept article on reverse lookup]].

=Upload Data by HTTP Post=
A CSV file can be uploaded by means of an HTTP POST request.
The following powershell script aims to demonstrate this procedure with the help of CURL<ref>For a windows distribution: e.g.: https://curl.haxx.se/download.html </ref><ref>CURL is recommended(rather required), because it supports the simple POST mechanism with an initial tentative POST with the data length of 0, in order to get through the authentication phase</ref>
The required user and password content corresponds to the configuration underneath '''PBX Manager/AP Contacts/Configuration/User(HTTP Post)''' and '''Password(HTTP Post)'''
<syntaxhighlight lang="powershell">
# csv.ps1
# Sample powershell script demonstrating how to HTTP POST a CSV file towards the Contacts App service.
# .\bin\curl must be present, e.g. from https://curl.haxx.se/download.html
# Examples:
# powershell -ExecutionPolicy Bypass -Command .\csv.ps1 -Dest 172.16.18.215 -File ".\myContacts.utf8" -User "contacts01" -Pw "pwd01" -Url "/example.com/contacts01/post/myContacts.utf8?op=csv"

param(
[Parameter(Mandatory=$false, HelpMessage="Destination host")]
[string]$Dest,
[Parameter(Mandatory=$false, HelpMessage="Name of file to be POSTed")]
[string]$File,
[Parameter(Mandatory=$false, HelpMessage="Authentication: User")]
[string]$User,
[Parameter(Mandatory=$false, HelpMessage="Authentication: Password")]
[string]$Pw,
[Parameter(Mandatory=$false, HelpMessage="URL, e.g.: /example.com/contacts01/post/myContacts.csv?op=csv&xml-stats=true")]
[string]$Url
)

Add-Type -AssemblyName System.Web

$Uri = "http://" + $Dest + $Url

function UploadToContacts {
# Ensure file's there and has content
if (!(Test-Path -Path $File)) {
echo $File+" not downloaded!"
exit 1
}
$lines = 0
Get-Content $File |%{ $lines++ }
echo "Lines of $File=$lines"
if($lines -le 2) {
echo "No Data to upload!"
exit 1
}

$auth = "${User}:${Pw}"

echo "POSTing towards $Uri"
.\bin\curl "--digest" -s -S --trace-time -u $auth -i -H "Content-Type:application/octet-stream" -X POST --data-binary "@${File}" "${Uri}"
echo "POSTed towards $Dest"
}

$timeStart = Get-Date
echo "===Begin: ${timeStart} ==="
UploadToContacts
$timeEnd = Get-Date
echo "===End: ${timeEnd} ==="
echo ""
</syntaxhighlight>
== The URL ==
The first part of the URL (''example.com/contacts01'') is the ''Webserver path'' configured for the ''Contacts'' instance in the ''App Platform Manager''. It must be followed by the literal <code>post</code>. The last part (''myContacts.csv'') can be chosen freely.

Note that the last part of the URL used to post the file (''myContacts.csv'' in the example above) needs to be chose carefully. ''Contacts'' will remember this name as source for each of the uploaded entries. When the file is posted again (that is, when a new POST using this last URL part is done), ''Contacts'' will first delete all existing entries previously uploaded with this name and then add the new ones.

=Troubleshooting=
To collect debugging data, activate the '''''App''''' and '''''App WebSocket''''' trace options at the contacts instance on the App Platform Manager. Now reproduce the issue and save the logfile.

==Manually Deleting an uploaded File==
A directory is deleteable by clicking '''Hamburger/Directories/<directory>/Delete(Symbol: Trash-Can)''' and a progressing through the confirmation dialog afterwards.

==Manually Deleting all Contacts==
Sometimes it may become necessary to delete all contacts from the database. This task can be accomplished by simply deleting the main table ''entries''. The deletion will cascade from there into all sub-tables.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<syntaxhighlight lang="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
94
(1 row)

#Delete
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from entries *"
DELETE 94

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
0
(1 row)
</syntaxhighlight>



= Known Issues =
* [[Support:Contacts_on_HomeScreen_can%27t_be_open_after_modification_on_ContactsAPP | Contacts on HomeScreen can't be open after modification on ContactsAPP]]
* [[Support:Contacts_Upload_Fails_From_Within_myApps_Launcher | Contacts Upload Fails From Within myApps Launcher]]
* [[Support:Forward_search_shows_no_result | Forward Search shows "no result"]]
== DECT Phones and IP101/IP102 Cannot Access Personal Directories ==
DECT gateways and IP101/IP102 Phones do not support the mechanism required to query into directories with restricted access rules. Hence, DECT mobile phones and IP101/IP102 cannot search into such directories.

== No automatic ACL update on name changes ==
If a users h323 name is changed, all ACL entries in address books, to which the user has rights, also need to be changed manually, since there is no automatic update between the PBX and the address books.

= Related =
<references/>

Reference13r3:Concept App Service Contacts

2024-10-16T09:59:18Z

Aci:

[[Category:Concept|Apps]]
= Applies To =
* App Contacts version 13r3

= Overview =
The App Service Contacts is an App Service which can be installed on an innovaphone App Platform. It is used for information retrieval of a database of contact entries, as well as maintaining personal contact books.

Inside Contacts, personal and general entries can be searched (forward lookup) or be used to resolve incoming numbers to their respective name (reverse lookup).

= Features =
*Import: Semicolon (;) separated CSV file
*Database for contact entries: A user interface for retrieval purposes is available.
*API: Search API for other apps
*Edit Functionality: Contact entries are editable.
*Personal Address Book: Every user can maintain one or more personal address books.
*Access Right Management: Owners can maintain access privileges for single users or even groups of users, in order to control visibility of an address book.

= Requirements =
innovaphone PBX and App Platform from on version 13r3.
==Upgrade Considerations==
As always, don't forget to backup an existing App Platform in prior. This 13r3 App Contacts does alter the underlying database scheme.
;13r3 App on 13r1 App Platform, 13r1 PBX:Doesn't work. This 13r3 Contacts App does not work on an 13r1 Application Platform/Environment.
;13r3 App on 13r2 App Platform, 13r2 PBX:The 13r3 Contacts App works with the restriction, that the reverse lookup for private address books doesn't work. For full feature set, also upgrade the App Platform and PBX to 13r3.

=Apps=
=== Contacts App (innovaphone-contacts) ===
The regular app
=== Contacts Admin App (innovaphone-contacts-admin) ===
Features a menu (top-right) to manually upload a CSV file
=== Contacts Search API (innovaphone-contacts-searchapi) ===
This hidden app rovides a search API to other apps, e.g. for the Phone App

= Concept =
General contact entries and entries for personal directories are stored within the same database. With the table '''acl''' which is acting as an access control list, restricted views and edit rights for personal directories can be granted.

This way, only the owner of a personal directory (and granted user or groups) can see the content.

==Number handling==
In principle, two versions of a phone number are always stored in the contacts database.
;Original Number
:This is the unchanged number imported by the user. This version includes all decorative characters, spaces, etc. (eg. +49-(7031) 730090)
;Formatted number
:A filter is applied to the original number before saving to remove all non-dialable characters. (This means that only <code>0-9,+,*,#</code> remain after that) This formatted version of the call number is saved in addition to the data set. (eg. +497031730090)

If a number is searched for (reverse lookup), the cleaned version is searched for. Thus, it does not matter which decorative characters or formats are imported.
If an entry is displayed to the user, the originally entered call number (incl. decoration characters) is displayed.

It is therefore best practice to import only international format numbers (Decorations can be imported as they will be removed anyway), as the PBX always converts the number into the international format for a reverse lookup, if the [[Reference13r1:Concept_Number_Adjustments_%28Dialing_Location%29 |dialing location]] was configured correct.

==Assign unique IDs for contacts entries==
It is recommended to upload CSV files with an additional column ''extAnchor''. The column extAnchor allows to identify individual entries uniquely and independent of renaming operations. The column ''extAnchor'' is supposed to contain an external unique database id, alike a guid. If ''extAnchor'' was provided the import procedure will perform an UPDATE of previously existing entries, instead of deleting and re-INSERTing the entries. Entries pinned on home are going to remain functional.

==List of Attributes==
The list of currently available attributes for a contacts entry follows:
;extAnchor
: unique id identifying the entry within the database
;givenname
:First name
;sn
:Surname/Family name
;company
:Corporation
;displayname
:Name to be displayed
;email
:e.g. ''example@example.com''
;telephonenumber
:Internationalized land-line telephone number, e.g.'' +49 7031 730090''
;mobile
:Internationalized mobile telephone number
;homephone
:Internationalized home phone number
;facsimiletelephonenumber
:Internationalized fax number
;city
:City/Town, e.g. ''Milano''
;street
;postalcode
;state
:Federal state, e.g. some US states: ''Ca, Wa, Fl''
;country
:e.g. ''Deutschland, Italia''
;privatecity
:Home address
;privatestreet
;privatepostalcode
;privatestate
;privatecountry
;title
:Academic title
;position
:Position within company, department
;department
;description
:Common description
;roomnumber
;info
:Common info
;url
:Company URL
;sip
:Dialable SIP address

==List of Text-Indexable Attributes==
Attributes to be considered for the full-text index
*cn
*sn
*givenname
*company
*displayname
*city
*street
*postalcode
*country
*state
*private_city
*private_street
*private_postalcode
*private_country
*private_state
*title
*position
*department
*description
*roomnumber
*sip

==Built-in LDAP Server==
The App incorporates a proprietary LDAP server functionality. The purpose of the LDAP server functionality is to service innovaphone LDAP clients, such as desk phones.
The LDAP server only supports a proprietary search by means of a meta attribute<ref>Meta attribute: Here an attribute with a special meaning and that is non-physical, not existing within the database</ref>, whereby LDAP is just utilized as a transport vehicle for a user's search input one-to-one.
*E.g. a user searching for ''John Doe innovaphone''
**Possible user input ''jo do inno''
**Resulting LDAP filter ''(metaSearchText=jo do inno)''

'''Important:'''

Note, that access to restricted/personal phone books requires the proprietary scheme within the LDAP client, mentioned above.

Currently, this is available in the innovaphone IP phone LDAP clients from 13r3 on, but not on 3rd party devices nor our DECT gateways (IP120x). On these clients, only contact data in unrestricted phone books is searched.

===Sample Phone Configuration, innovaphone===
Phone/User-X/Directories/External LDAP Server
;Enable: Active
;Use TLS: Active
;Server: <host adddress of App Platform>
;Port: <can be left empty>
;Username,Pw: <Credentials for LDAP Bind operation>
;Search Base: ''dc=entries''
;Mode: <can be left on "basic">
;Object Filter: <leave empty>
;Sort Results: Inactive
;Name Attributes: ''givenName,sn,company''
;Number Attributes: <can be left empty>
;H323 ID Attribute:'' sip''
;Detail Attributes: ''title,company,street,postalCode,city,country,email,url''
;Meta Name Attribute: ''metaSearchText''
;Meta Number Attribute: ''metaSearchNumber''

= Personal Address Book Details =
With version 13r3 it is now possible, to add, editing and delete contacts. It is also possible to create and maintain personal address book(s), as well as share them with other users or whole user groups.

Only user/groups with sufficient rights, will be able to see other address books. An Access control list (acl) is used, to control these rights.

Groups correspond to PBX-groups. The Contacts App gets to know only active PBX-group memberships.

By default, only the user who created an address book, is able to see the content.

==Maintain a Personal Address Book==
;Creating a Personal Address Book
Click on the burger menu in the top right corner inside the Contacts-App, and there on the '''"Directories"'''. Now click on the '''"+"'''-Symbol, choose a suitable name and confirm your name via '''"Save"''' button. A new address book is created.
;Adding a new contact
Click on the '''"+"'''-Symbol in the top right corner inside the Contacts-App and select an address book, where you want the contact to be stored in. Now fill in the contact information (the fields ''"name"'' and ''"last name"'' '''have to be filled''') and save it via '''"Save"'''-button.
;Editing an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, click on the entry you want to edit and after your change, save it via '''"Save"'''-button on the bottom.
;Delete an existing contact
Search for the contact you want to edit via the search box inside the Contacts-App. Click on the '''"Details"'''-field on the right of the contact entry. Now click on the bottom on the '''"Edit"'''-button, and on the '''"trashcan"'''-symbol at the top. After confirmation, the entry is deleted.

==Sharing of Address Book==
;Share globally
*Either remove all rules from a personal directory. Such a configuration corresponds to pre-13r3 capabilities. Up to 13r2 there weren't any visibility rules available.
*Or make every PBX user an active member of a group e.g. "everybody" and add a directory rule for that group "everybody".

;Share with single user(s)
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"User"''' as type. In the input field, you can enter and therefore filter for all available users. Select the user, whom you want to give access and select either if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''.

;Share with a group
Click on the menu in the top right corner inside the Contacts-App, click on '''"directories"''' and select a directory, you want to share.

Now click on the '''"+"'''-symbol and select '''"Group"''' as type. In the input field, you can enter and therefore filter for all available PBX groups. Also select, if the user should have admin-rights or not. Now click on '''Ok''' and submit your change with another click on '''Ok'''-button.

;Revoke of granted rights
You can also revoke previous granted rights by just clicking on the user/group at the access control list, and click on the '''trashcan''' symbol. Now submit your change with another click on '''Ok'''-button.

==Upload a new Directory==
The Contacts Admin App allows uploading a CSV file as known from the 13r2 version ('''Hamburger/Import'''). In the course of an upload operation, a new directory will be created. The newly assigned directory name will be the name of the CSV file.
After uploading, the visibility setting of the new directory should be administrated as stated before under [[#Sharing_of_Address_Book|Sharing of Address Book]]

==Terminology==
;ACL: Access control list. Refers the database table ''acl'' and rows/entries therein.
;Directory: Refers the database table ''dbs'' and rows/entries therein. All contact entries referencing a ''dbs''-row make up the content of a directory.
;Address Book: Synonymous with ''Directory''
;Contacts Admin: A user utilizing the Contacts Admin App (via App URL, ending with ../innovaphone-contacts-admin)
;Directory Admin: A user entitled the admin right for a directory. Either by user-wise or by group-wise ACL entry.
;Directory User/Viewer: A user entitled the viewing right for a directory. Either by user-wise or by group-wise ACL entry.

==Database Changes==
Three tables realize the functionality for personal directories.
*Table '''dbs'''. Each row represents a directory. Two new columns ''displayname, sip'' where added.
**'''displayname''' Name display.
**'''sip''' Creator's sip name, if available.
*Table '''acl'''.New table acting as access control list. Each row references a directory as listed by table ''dbs'' and is going to grant view- and admin-right to a specific user or group.
**'''dbsid''' Reference into table dbs.
**'''name''' The name of a user or a group.
**'''acltype''' A numeric value: user(0), group(1)
**'''admin''' Granting edit right: admin(true), non-admin(false)
*Table '''entries'''. Each row within this pre-exisisting table represents a contact entry. The column ''dbsid'' informs about whether an entry belongs to a specific directory.

<pre>
#Excerpt for an additional directory ''Persönliches Verzeichnis: mst'' with one contact entry.

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri | displayname | sip
----+------------------------------------------------------+--------------------------------+-----
7 | file:///4eaae395-9971-40fb-9a05-dfae1d023f12?sip=mst | Persönliches Verzeichnis: mst | mst # Specification for directory ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from acl"
id | dbsid | name | acltype | admin
----+-------+------+---------+-------
5 | 7 | mst | 0 | t #user 'mst' can view and edit directory with dbsid=7 ('Persönliches Verzeichnis: mst')

root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select sn,givenname,company,id,dbsid from entries where dbsid=7"
sn | givenname | company | id | dbsid
----------+-----------+--------------+-------+-------
Duck | Dagobert | Duck Corp. | 51394 | 7 # main table entries contains 1 entry belonging to ('Persönliches Verzeichnis: mst')

</pre>

==Reverse Number Lookup for Personal Directories==
Queries into directories are access-checked by looking-up and enforcing ACL-rules. The information on whose name is being queried and which group memberships are taking effect is needed for this process.

Websocket connections to the Contacts App service carry those infos within the SDK method ''AppWebsocketConnectComplete()''.
LDAP connections pass this information within a proprietary LDAP control together with an LDAP searchRequest message.

The PBX's centralized Reverse Lookup service (see ''PBX/Config/General/Reverse Lookup URL'') does support this mechanism. That is, for every LDAP searchRequest the affected user's name and active group memberships are going to be sent towards the Contacts App's LDAP server.

See also [[{{NAMESPACE}}:Concept_Reverse_Lookup|concept article on reverse lookup]].

=Upload Data by HTTP Post=
A CSV file can be uploaded by means of an HTTP POST request.
The following powershell script aims to demonstrate this procedure with the help of CURL<ref>For a windows distribution: e.g.: https://curl.haxx.se/download.html </ref><ref>CURL is recommended(rather required), because it supports the simple POST mechanism with an initial tentative POST with the data length of 0, in order to get through the authentication phase</ref>
The required user and password content corresponds to the configuration underneath '''PBX Manager/AP Contacts/Configuration/User(HTTP Post)''' and '''Password(HTTP Post)'''
<syntaxhighlight lang="powershell">
# csv.ps1
# Sample powershell script demonstrating how to HTTP POST a CSV file towards the Contacts App service.
# .\bin\curl must be present, e.g. from https://curl.haxx.se/download.html
# Examples:
# powershell -ExecutionPolicy Bypass -Command .\csv.ps1 -Dest 172.16.18.215 -File ".\myContacts.utf8" -User "contacts01" -Pw "pwd01" -Url "/example.com/contacts01/post/myContacts.utf8?op=csv"

param(
[Parameter(Mandatory=$false, HelpMessage="Destination host")]
[string]$Dest,
[Parameter(Mandatory=$false, HelpMessage="Name of file to be POSTed")]
[string]$File,
[Parameter(Mandatory=$false, HelpMessage="Authentication: User")]
[string]$User,
[Parameter(Mandatory=$false, HelpMessage="Authentication: Password")]
[string]$Pw,
[Parameter(Mandatory=$false, HelpMessage="URL, e.g.: /example.com/contacts01/post/myContacts.csv?op=csv&xml-stats=true")]
[string]$Url
)

Add-Type -AssemblyName System.Web

$Uri = "http://" + $Dest + $Url

function UploadToContacts {
# Ensure file's there and has content
if (!(Test-Path -Path $File)) {
echo $File+" not downloaded!"
exit 1
}
$lines = 0
Get-Content $File |%{ $lines++ }
echo "Lines of $File=$lines"
if($lines -le 2) {
echo "No Data to upload!"
exit 1
}

$auth = "${User}:${Pw}"

echo "POSTing towards $Uri"
.\bin\curl "--digest" -s -S --trace-time -u $auth -i -H "Content-Type:application/octet-stream" -X POST --data-binary "@${File}" "${Uri}"
echo "POSTed towards $Dest"
}

$timeStart = Get-Date
echo "===Begin: ${timeStart} ==="
UploadToContacts
$timeEnd = Get-Date
echo "===End: ${timeEnd} ==="
echo ""
</syntaxhighlight>
== The URL ==
The first part of the URL (''example.com/contacts01'') is the ''Webserver path'' configured for the ''Contacts'' instance in the ''App Platform Manager''. It must be followed by the literal <code>post</code>. The last part (''myContacts.csv'') can be chosen freely.

Note that the last part of the URL used to post the file (''myContacts.csv'' in the example above) needs to be chose carefully. ''Contacts'' will remember this name as source for each of the uploaded entries. When the file is posted again (that is, when a new POST using this last URL part is done), ''Contacts'' will first delete all existing entries previously uploaded with this name and then add the new ones.

=Troubleshooting=
To collect debugging data, activate the '''''App''''' and '''''App WebSocket''''' trace options at the contacts instance on the App Platform Manager. Now reproduce the issue and save the logfile.

==Manually Deleting an uploaded File==
If multiple files or multiple versions of a CSV file were uploaded, it might not be clear how to delete an old data set. Here is an example for how to accomplish a deletion of a particular data set related to an imported CSV file:
*2 Files were previously imported
**''allcontacts.csv''
**''brs%20testimport.csv''
*The file ''brs%20testimport.csv'' shall be deleted
*Hints
**Within the Contacts database, the table ''dbs'' contains the names of files once imported.
**The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<syntaxhighlight lang="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#Command 'psql'. Printing the table 'dbs'. Contains 2 file names.
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri
----+----------------------
1 | allcontacts.csv
5 | brs%20testimport.csv
(2 rows)

#Delete the file "brs%20testimport.csv" via its table-ID 5.
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from dbs where id=5"
DELETE 1

#Printing the table 'dbs'. Contains 1 file name.
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select * from dbs"
id | uri
----+-----------------
1 | allcontacts.csv
(1 row)

root@app-platform|/mnt/sda2/home/admin>

</syntaxhighlight>

==Manually Deleting all Contacts==
Sometimes it may become necessary to delete all contacts from the database. This task can be accomplished by simply deleting the main table ''entries''. The deletion will cascade from there into all sub-tables.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<syntaxhighlight lang="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
94
(1 row)

#Delete
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "delete from entries *"
DELETE 94

#List number of contacts in main table entries
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "select count(*) from entries"
count
-------
0
(1 row)
</syntaxhighlight>

==Manually Exporting all Contacts==
Sometimes it may become necessary to export all contacts from the database.
This task can be accomplished by reading the main table ''entries'', separate attributes by ; and store the result in a given csv-file.
The csv-file has to be located in a separate folder with appropriate access rights.
*The database name, here: ''innovaphone.com_contacts'' can be retrieved from the settings within in the App Manager for the Contacts App.
Establish an SSH-session by means of e.g. putty<ref>putty: https://putty.org</ref>
<syntaxhighlight lang="bash">
#Login
#===================================================================
login as: admin
Using keyboard-interactive authentication.
Password:

#Elevate to super-user rights, Command 'su'
#===================================================================
admin@app-platform|/mnt/sda2/home/admin> su
Password:

#create new folder export and grant access rights
root@app-platform|/mnt/sda2/home/admin> mkdir export
root@app-platform|/mnt/sda2/home/admin> chmod 777 export

#Retrieve all database entries, separate them by ; and store in file
#===================================================================
root@app-platform|/mnt/sda2/home/admin> psql -d "innovaphone.com_contacts" -c "copy entries to '/mnt/sda2/home/admin/export/contacts.csv' delimiter ';' CSV HEADER"

</syntaxhighlight>

The generated csv-file can be downloaded by use of an sftp-client (e.g. WinSCP) and login to the AP with admin credentials.



= Known Issues =
* [[Support:Contacts_on_HomeScreen_can%27t_be_open_after_modification_on_ContactsAPP | Contacts on HomeScreen can't be open after modification on ContactsAPP]]
* [[Support:Contacts_Upload_Fails_From_Within_myApps_Launcher | Contacts Upload Fails From Within myApps Launcher]]
* [[Support:Forward_search_shows_no_result | Forward Search shows "no result"]]
== DECT Phones and IP101/IP102 Cannot Access Personal Directories ==
DECT gateways and IP101/IP102 Phones do not support the mechanism required to query into directories with restricted access rules. Hence, DECT mobile phones and IP101/IP102 cannot search into such directories.

== No automatic ACL update on name changes ==
If a users h323 name is changed, all ACL entries in address books, to which the user has rights, also need to be changed manually, since there is no automatic update between the PBX and the address books.

= Related =
<references/>

Reference12r2:Concept Softwarephone

2022-09-06T08:44:22Z

Aci:

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

= General =

Innovaphone SoftwarePhone is the implementation of innovaphones HW phones software as a Windows process. So all the features native to the hardwarephones are present in SoftwarePhone as well. SoftwarePhone has no UI, it is operated via myPBX or 3rd Party CTI client (ex: Estos Procall).

=System Requirements=
The innovaphone SoftwarePhone requires:
*Windows 7 or higher
*innovaphone PBX with SoftwarePhones<v> License.
*innovaphone myPBX UC-Client as frontend with myPBX- or UC-license

= Installation =

Prior to installing the 10.00 Version of innovaphone SoftwarePhone an eventually installed 9.00 version must be manually deinstalled. From version 10.00 to 12r1 subsequent releases can be updated without first deinstalling the older version. From 12r2 on prior versions must be manually deinstalled.
When updating the installation, the previous configuration (if existing) is reused. Otherwise a default configuration is installed.
There are 2 ways to install Softwarephone:

* SetupSWPhone.exe. This is the preferred method if no installation parameters are required. It automatically installs all 3rd party SW to operate the headsets
* softwarephone.msi AND SpokesSDKNativeRuntime.msi. If the Softwarephone installation needs to be parametrized via Orca first install SpokesSDKNativeRuntime.msi, then
softwarephone.msi
* In our newest download packet, if you aren't using our exe file please install first HubSDKNativeRuntime.msi, Sennheiser_SDK_v7.5.9600.msi and than softwarephone.msi. Delete first the old pakets and install than the new ones.

The following items are installed:

* SoftwarePhone .exe and related files (dll) in Program files (x86)\innovaphone\SoftwarePhone
* Hid.tbl (the code definitoins of supported USB headsets) in Program files (x86) \innovaphone\SoftwarePhone
* The config files „swphone_config.cfg“ and „swphone_command.cfg” in the User Roaming directory (if no previous configuration is located there, otherwise the old configuration is used, Roaming Directory Location : <drive>:\Users\<User>\AppData\Roaming\innovaphone\SoftwarePhone\)

Installation Process:

* http port 80 ist checked to be available as the SoftwarePhone ’s web configuration port. If not free, a search starting at port 10006 is executed to find a free port. The URL file, containing the configuration servers web @ is adjusted to the determined free port
* SoftwarePhone is startet.

Resetting to defaults:

*Resetting to default configuration could be done by deleting the config files in the Roaming Directory.

Unattended Installation of softwarephone for ALLUSERS:

*It's possible to install softwarephone for ALLUSERS by using the command:
Msiexec /i softwarephone.msi ALLUSERS=1

= Configuration =

The configuration is opened by selecting “Configuration” from the start menu. A browser connection is opend to the server running as part of SoftwarePhone and the configuration menu is displayed.

Default login is admin/swphone.

The configuration options are the same as for the hardware phones with a few specifics referring to SoftwarePhone running as a Windows process:

* Application
The Applicatons run mode and priority can be set and whether to register with the computers name at the PBX.
* Audio
The desired audio devices can be selected.
* Audio
The Audio –Input, -Output and –Ringing device can be selected.
* USB
Legacy configuration for customers who use a previous installation with a headset other than Jabra, Sennheiser or Plantronics. Headsets from these vendors are handled automatically and need not be configured.

The default credentials are admin / swphone

== '''„Audio and USB Configuration"''' ==

This config GUI is unique in the way that it can only be accessed (right click on the softwarephone icon) from the computer SoftwarePhone is running on. Here the typical End User Configurations are set: Audio and USB-headset parameters.

[[Image:default-usercfg.png]]

Above image shows the default configuration without any headset from vendors Jabra, Plantronics or Sennheiser plugged in. "Headset" in this case means any headset of beforementioned vendors that is detected. Note: The FIRST detected headset will become the active one, if more than 1 headset is plugged in. In case you have more than 1 headset plugged in and want to use a specific for Softwarephone operation you must configure it in the "USB Configuration | USB device" droplist.
The column on the right shows the actual values

[[Image:usercfg-headset-plugged-no-preferred.png]]

Above image shows a default configuration "Headset" with currently a "Sennheiser SC260 .." being plugged in and detected

[[Image:usercfg-headset-plugged-preffered-active.png]]

Above image shows the "Sennheiser SC260 .." configured as the prefered (USB Device) and being active.

Note: If you have configured a specific headset and you don't plug it in but instead another one then this other is fully operational and it stays that way until the prefered one is plugged in, then it becomes the active one.

'''Microphone:'''

The microphone selection.

'''Speaker:'''

The speaker selection

'''Ringer:'''

The Ringing device selection

'''Handsfree:'''

The open listening device selection. The device that plays the incoming audio stream when the speaker button is pressed in myPBX.

'''USB Device:'''

The USB headset selction.

'''USB Map:'''

Legacy for non Jabra, Plantronics and Sennheiser headsets. The codepage selection for the selected usb device. Here one or two choices are presented. If a selection item that refers to the selected USB Device use this. If only “generic HID Telephonie Page” is available you can try to use the headsets button (some headsets support the generic codes)

'''NOTE:''' If the headsets buttons do not work for call control, then call control is solely available through myPbx. Nevertheless the USB headset can be used as the audio-in/output device.

== '''[Tab:„Application“]''' ==

Admin mode Application configuration.

[[Image:swphone_application.jpg]]

'''Application Run Mode:'''

* Manual: SoftwarePhone needs to be started manually
* Login: SoftwarePhone will be started when the user logs in (don't set this option if myPBX Launcher have option "Run Softwarephone" in the same PC).

'''Application Priority:'''
* Normal: As every standard Windows Process. Sufficient in almost all cases
* High: Elevated Priority.

'''Register Mode:'''
* Default: Registration modes like the HW phones.

'''NOTE:''' Anonymous registration might not work in all environments, especially those that prevent multicasts. For example, when using SoftwarePhone over a vpn connection ensure that multicast forwarding is guaranteed. Also, if a virtual machine is running on the same computer it might prevent
multicasts being sent on the LAN.

* Computername:
The best way for registering SoftwarePhone at the PBX. It uses the computername as it is visible on the LAN. The computername is determined by SoftwarePhone and the appropriate parameters are set for the “Phone” modul. This configuration appears in the field “Name” under the “Phone” tab (Example for computer„LBU-VOSTRO-W7“ ):

[[Image:swphone_registration.jpg]]

== '''[Tab:"Audio”]:''' ==

Admin mode Audio configuration. Items see „Audio and USB Configuration“

== '''[Tab:“USB”]:''' ==

Admin mode Audio configuration. Items see „Audio and USB Configuration“

= Rollout =

Especially in larger installations it is desirable to have a mechanism for automatic configuration of the SoftwarePhones. This can be accomplished in the following way:

SoftwarePhones installation package (softwarephone .msi)can be parametrized by creating an [https://docs.microsoft.com/en-us/windows/desktop/msi/orca-exe Orca MSI database editor] transform with the parameters:
URL and POLL. Theses parameters are entered in the “Property” table

[[Image:download_orca.jpg]]

Saving Embedded Streams

By default, when saving a database to a new file with File and Save As…, Orca does not copy streams that are embedded in the database but not a member of any table. Select Copy embedded streams during 'Save As' to save streams to the new file when saving a database using the File with the Save As… option.

[[Image:orca_openfile.jpg]]

[[Image:orca_addrows.jpg]]

[[Image:orca_rows_content.jpg]]

[[Image:orca_savefile.jpg]]

It is recommended that the “POLL” value be set to “1” (shortest time: 1minute).
When SoftwarePhone is installed with the transform it starts, waits 1 min (poll period) then accesses the script file specified in the “POLL” parameter and executes the commands therein.
To register SoftwarePhone with the computername at the PBX the script file should look as follows (example showing the PBX @ “192.168.178.22” with the identifier „IP800-06-25-6e” :

…
#set the PBX @ and Identifier
config change PHONE SIG /prot H323 /gk-addr 192.168.178.22 /gk-id IP800-06-25-6e

#register with computername
mod cmd APP0 app-set /op OK /reg_mode ComputerName

#reset the automatic configuration update
config add UP1 /url

#reset SoftwarePhone and apply config
reset

Another method to provide configurations to the installed SoftwarePhone s is preparing a configuration template by configuring one SoftwarePhone entity, then using the generated “swphone_commands.cfg” file in the <users roaming directory >\innovaphone\SoftwarePhone
as the template, copying it to the update location and using it in the script file:

#invoke configuration template
mod cmd UP0 cfg <update directory location>/swphone_commands.cfg

This method is particularly helpful when many USB headset of the same type are used.

= Setting QoS =
See [[Howto:Softphone recommended settings]].

= Supported USB headsets =

The following USB headsets are supported for onhook/offhook and mute (MyPBX) functionality:

All Jabra, Plantronics and Sennheiser headsets that are supported by these vendors SDKs. Please check their
sites for more information.

https://www.plantronics.com/us/en/support/downloads-apps/hub-desktop

https://developer.jabra.com/site/global/sdks/windows/documentation/core.gsp

https://en-us.sennheiser.com/headset-software-pc

= Troubleshooting Connectivity Problems =

If you experience problems with softwarephone attaching to the PBX or not being able to make calls please check the following:

* '''check in the “Phone” tab whether the state is “up”'''

* '''check in the “General” tab if License is “Valid”'''

* '''Start a command window as Administrator and issue a "netstat –a –b > swphone_netstat.txt"'''

In the “swphone_netstat.txt” file search for “1720”. There should be an entry like this:

'''''TCP 0.0.0.0:1720 LBU-VOSTRO-W7:0 LISTENING'''''
'''[softwarephone.exe].'''

Please search for other occurances of “'''1720'''” to ensure that no other processes listen to this port.

* '''Make a softwarephone trace to see if the packets are received by softwarephone'''

In the “Maintenance” tab “Tracing” enable “'''H.323 Signaling'''”, “'''Phone'''” and “'''All TCP/UDP Traffic'''”. Then try to make the call. In the resulting trace you should see the events like the following:

'''''0:0103:337:3 - RECV RESULT[](662 from pla(192.168.178.22:60003) type: 1)
0:0103:337:3 - PHONE_LISTEN.1 -> PHONE_REG.1 : SIG_SETUP faststart=3ac8bec cmd=PROPOSAL cdpn=400'''''

If these events are no present in the trace it could be that the firewall settings prevent some of softwarephone’s functions. This could be the Firewall.

* '''Check the firewall settings for softwarephone'''

Please open the “System Administration\Windows-Firewall\Allow Program.. Ensure that softwarephone is enabled on the required interfaces. If this doesn’t solve the problem then temporaryly disable the firewall completely and try again.
Now even with the firewall disabled there could be some other security software that causes the problem. To find out if packets to the “h323hostcall” port (1720) are filtered by the firewall you can use the commands “'''netsh wfp capture start'''” to start a trace of the test and “'''netsh wfp capture stop'''” to stop the trace. The trace is written into the file: “'''wfpdiag.cab'''” . Extract the file: “'''wfpdiag.xml'''”. In this file search for “1720”. If the packet is filtered by the firewall an entry like the following can be found:

<netEvent>
<header>
<timeStamp>2013-11-05T11:20:27.367Z</timeStamp>
<flags numItems="8">
<item>FWPM_NET_EVENT_FLAG_IP_PROTOCOL_SET</item>
<item>FWPM_NET_EVENT_FLAG_LOCAL_ADDR_SET</item>
<item>FWPM_NET_EVENT_FLAG_REMOTE_ADDR_SET</item>
<item>FWPM_NET_EVENT_FLAG_LOCAL_PORT_SET</item>
<item>FWPM_NET_EVENT_FLAG_REMOTE_PORT_SET</item>
<item>FWPM_NET_EVENT_FLAG_APP_ID_SET</item>
<item>FWPM_NET_EVENT_FLAG_USER_ID_SET</item>
<item>FWPM_NET_EVENT_FLAG_IP_VERSION_SET</item>
</flags>
<ipVersion>FWP_IP_VERSION_V4</ipVersion>
<ipProtocol>6</ipProtocol>
'''<localAddrV4>192.168.178.21</localAddrV4>'''
'''<remoteAddrV4>192.168.178.22</remoteAddrV4>'''
<localPort>'''1720'''</localPort>
<remotePort>60007</remotePort>
<scopeId>0</scopeId>
<appId>
<data> …</data>
<asString>...</asString>
</appId>
<userId>S-1-5-21-3364624427-3176291796-194291593-006</userId>
</header>
<type>FWPM_NET_EVENT_TYPE_CLASSIFY_DROP</type>
<classifyDrop>
<filterId>105267</filterId>
<layerId>44</layerId>
<reauthReason>0</reauthReason>
<originalProfile>2</originalProfile>
<currentProfile>2</currentProfile>
</classifyDrop>
</netEvent>

where the

<localAddrV4>192.168.178.21</localAddrV4>

and the

<remoteAddrV4>192.168.178.22</remoteAddrV4>

should be your computers and the PBX’s @.

* Check if the setup from the PBX is received at the local computer and what happens with it

Sometimes, Antivirus Packages can implement their own network access policy. This can result in a h323 release complete with cause “User Busy” to an incoming Setup from the PBX before any other softwarephone is reached. To see which process Sends/Receives the packets in a flow you can use the “netmon”, Microsofts free Packet tracer.

= How to obtain debug traces of softwarephone using icollect =

Included in the installation path (C:\Program Files (x86)\innovaphone\SoftwarePhone) there is a tool called '''icollect.exe'''(accessible via start menu entry). After we reproduce a problem we can run this tool to generate debug files that are saved in the roaming folder (C:\Users\<User>\AppData\Roaming\innovaphone) as "debug-info.zip".

Before you reproduce the problem, please set the appropriate trace flags. Some flags like the KEYS flag must be set at "http://localhost:10006/debug.xml"
Which flags for which problem:

; Softwarephone looses registration at PBX: H.323/RAS, H.323/H.225, H.323/H.245
; Call setup phase: Signalling, H.323/RAS, H.323/H.225, H.323/H.245
; Audio problems: Signalling, H.323/ICE, H.323/DTLS, DSP trace, DSP Audiochannel. Please enable "DSP Audiocapture" only if specifically asked by innovaphone since it captures the complete audio stream and thus can generates huge files on the HD
; Headset button problems: Signalling, KEYS

'''NOTE: Please when providing a crash dump captured by icollect always use the latest SR (service release) of the softwarephone. Don't send us crash dumps of older versions since this will just take more time/effort to be analysed by our developer team.'''

== Important files for support in the debug-info.zip==
* '''trace.txt''' -> Trace File, created when '''File Trace''' is activated in debug.xml. Also contains version number (to find it, search for Build: )
* '''swphone_config.cfg''' -> one part of the config, can be used to check trace-flags.
* '''swphone_commands.cfg''' -> second part of the config, can be used to check trace-flags. Also contains version number
* '''dmp'''-file: named innovaphone '''SoftwarePhone#[version]#[id].dmp''' contains crash dump
** if crash without dmp file, '''StartTrace.txt''' contains trace of swphone start
* '''Wave-in/Wave-out''': created when DSP & DSP Audiochannel & DSP Audiocapture are activated.

=Known Issue=

=== Things to do before starting ===
Before starting debugging softwarephone issues, is always the best thing to:

- check if audio drivers on the PC/Laptop are updated to the last version

- check if the headset drivers are updated to the last version

- check that the Headset SDK is updated to the latest version

- check that network drivers are updated to the last version

- change registration protocol of softwarephone from UDP (H323) to TCP or TLS (H323/TCP or H323 TLS) to avoid any signaling issue

After updating the driver, please reboot the PC even if not requested by the OS.

Most cases are solved after updating drivers/software, especially if softwarephone won't start or no ringtones/audio device is automatically selected.

Also, please check that the files " swphone_config.cfg " and " swphone_commands.cfg " in the C:\Users\%user%\AppData\Roaming\innovaphone\softwarephone\ are not 0 Kbyte.
In this case, best is to reinstall the softwarephone with the latest version, and, after configuring it, restart it and check that the file " swphone_commands.cfg " is bigger then 6 KB.
If something is overwriting it (Windows policy, Antivirus), do the following:

- uninstall softwarephone

- reinstall it with Administrator rights

- start softwarephone and configure it (saving the changes)

- without closing it, navigate to the " C:\Users\%user%\AppData\Roaming\innovaphone\softwarephone\ " folder and put " swphone_config.cfg " and " swphone_commands.cfg " in read-only. Doing this, softwarephone will save the changes. Remember that doing this, if you want to changes some settings on softwarephone, you need to remove the "read-only" flag on the files (and re-apply it after the changes)

=== G.711 only and G729 Optional===
The software phone does support G.711 and Opus codec only, no G.723 or G.722.
Optionally we can use G729 if G729 Channel licenses are present and available on the PBX.

===Another program is blocking the softphone===

Another program (e.g XCAPI) might be listening on tcp port 1720 as well. If you want to use both programs simultaneously you can change the signaling port of the softphone to another port like 1721.

<nowiki>http://localhost/!config add PHONE SIG /ep-addr 0.0.0.0:1721</nowiki>

If you want to find out which program is listening on which port we recommend using a little tool called TCP View. You’ll find it here:

http://technet.microsoft.com/en-us/sysinternals/bb897437.aspx

=== No license obtained from PBX if SIP Protocol is used===

When using Innovaphone softwarephone with SIP Protocol no license it's obtained from the PBX. It's necessary to use H.323 always.

=== Headset Basestation doesn't Ring ===

Often it's reported that the Basestation of Wireless Headsets doesn't Ring on incoming call, this is a feature that is missing and there exist already a Feature Request for it - [[Support:DVL-Feature_Requests#Alerting_on_Wireless_headset_base_also | Alerting on Wireless headset base also]] .

=== Windows Volume lowers automatically when receiving a call ===

The volume can be set for swphone exclusively by the Windows mixer. It appears in the mixer because it has a Audio stream Interface to the Windows Audio System, but no way adjust the volume by itself. When such an effect occurs it is best to check the Windows configuration: if it is set to Change volume for applications when certain Events occur:

[http://superuser.com/questions/74116/windows-7-lowers-applications-volume-automatically Windows 7 lowers applications' volume automatically]

=== H.323/TLS Connection not Trusted by Default ===

Please check the [[Reference11r1:Concept_H.323_over_TCP/TLS_(H.460.17)#Known_Issues|H.323/TLS Known Issues article]].

=== Softwarephone does not work on Terminal Server ===
The software phone can only run once on a single system. This also implies that it does not work for terminals server systems such as e.g. Citrix, as only the first client session running on a server would be able to start a software phone. Furthermore, multiple RTP streams would impose quit a bit of load on the server.

=== Softwarephone can't place calls (call setup disappear as I press the "call" button") ===

After windows major update, some windows systems had their microphone rights turned off for all the application using it. This prevent the softwarephone to properly use the microphone.
To check this, press "windows key + i", navigate in "Privacy" - "Microphone" - and check that "Allow apps to access you microphone" is turned on. Sometimes, even if turned on, there is the need to turn "Allow apps to access you microphone" completely off and the on to "refresh" the app rights (softwarephone included)

Also check that windows firewall is not blocking softwarephone communication.

Please check also this page: " http://wiki.innovaphone.com/index.php?title=Howto:Softwarephone_recommended_settings#Registration_Protocol ". With softwarephone, is recommended to not use H323/UDP as protocol.

=== When PC is not used for some time, softwarephone won't work anymore ===

We noticed this behaviour on some Windows PC. This was due to the power management settings of Windows, that was turning off the USB ports to save power (this happen most on laptops)
To avoid this, open "Control Panel" (with Category view) - "Hardware and sound" - "Power options" . Under "Preferred plan" click the "Change plan settings" for the plan you are currently using.
Click the "Change advanced power settings" link
Expand "USB selective suspend settings"
Select "Disabled" form the drop-down menu
Click "Apply" and the "ok"

If you're changing the settings on a laptop, you'll see two options: On Battery and Plugged in, so make sure to change those settings accordingly.
This will prevent Windows 10 to power off USB devices connected to your computer (so your usb bluetooth headset connector)

=== Softwarephone doesn't start after upgrade to new version ===

On windows 10 PC, can happen that after installing the new softwarephone version without manually uninstalling the old one, softwarephone won't start anymore, and in the Windows event viewer you will see the softwarephone app crash with relative ntdll.dll error.
To solve this, manually uninstall the softwarephone, reboot the PC and install the new version.

=== Softwarephone 12r2 keep crashing on Windows 10 ===

We noticed some issue between Softwarephone 12r2 and Windows 10. If your softwarephone after Windows 10 major update 1809, doesn't start or start and keep restarting, uninstall Softwarephone 12r2, delete the Softwarephone folder in the AppData/Roaming/Innovaphone/ path, restart the PC and install Softwarephone 12r1 with Administrator rights. This should solve the issue.

=== Issue with permission on Appdata folder ===

After major windows update, can happen that permission for the appdata/Roaming folder are reset. To restore them please do the following:

Open "Run" by pressing Windows + R keys together.
Type: as C:\Users\USERNAME\AppData
Note: Replace C: with the letter of the drive where Windows is installed. Also replace USERNAME with the username of the account you’re logged in.

Click OK

Right-click on the Roaming folder

Click Properties

Go to the Security tab

Click “Edit -> Add”

Type “Everyone”

Click “Check names -> Ok -> Full control”

Click OK to save the changes

Restart your computer

Now softwarephone should be able to access all necessary files again.

=== Not removed system tray icons ===
Sometimes if the softwarephone loose connection, wifi/copper/vpn will be switched or crashes the application in the system tray will not removed.

=== Headset not recognize by softwarephone on Windows 10 ===

After Major windows update, headset is not recognize anymore. This can happen in case authorization by the OS for softwarephone to bind the headset to the softphone is denied.
To restore the headset detection, uninstall softwarephone 12r2 version and install the latest 12r1 softwarephone release. Doing this, NET framework 3.5 will be reinstalled, authorization restored, and headset should be recognized again.
Once headset is recognize, you can reinstall softwarephone 12r2 (latest) version and headset will work with the 12r2 version of softwarephone again.

=== Softwarephone Mac address is 00000000000 ===

To be able to obtain a Mac address, on the PC network card, netbios must be enabled.

=== Kaspersky antivirus ===

We have reports that this antivirus can interfere with softwarephone if the client is not configured to allow softwarephone to work properly (softwarephone start but no calls are possible). Please disable it or configure an exception for the softwarephone so softwarephone can make calls.

=== Softwarephone doesn't ring, or does not receive call ===

According to this wiki page, http://wiki.innovaphone.com/index.php?title=DND if you press the mute button on the headset while softwarephone is in idle (no active calls) you activate the DND mode. This information won't be displayed in myApps/myPBX but is something between headset and softwarephone. You can check in this case if this line:

vars create PHONE/USER-DND/00000 p 1 <--------- 1 means DND is on, 0 is off.

is present in the softwarephone configuration file. If this is the case, pressing the mute button in the headset again when no calls are active, will set the value to 0 and DND will be disabled.

You can also lock the DND function on the softwarephone in PHONE/Protect/ Fine grained Function Locking and configure in the field:

0x00080000

Doing so the user won't be able to set the softwarephone in DND anymore.

Update: solved with the latest softwarephone release. Now is not possible to set the softwarephone in DND mode via the headset.

=== Crash if 4 or more network interfaces on PC ===

The Softwarephone will crash when started continuously or crash when a call is done (and the ICE candidates for the call are generated). As a workaround, don't activate more than 3 interfaces or use the v13 myApps-softphoneApp.

===Softwarephone doesn't start with myPBX===
After a Windows update, some PC requires to run myPBX as administrator in order to start softwarephone automatically. Please, run myPBX as administrator and softwarephone should start also.

===Using + character when changing the password via myPBX===
When using special character + while trying to change the password via myPBX, the + sign is not correctly decrypted which results on the Softwarephone not to be able to register to the PBX.
Please refrain from using + characters in the password while changing it manually via myPBX menu.
There is no issue if the password is only changed via the UI of the PBX on the user object.

===Softwarephone looses registration on PBX but "keeps" is registration locally ===
It could happen when the PC goes into sleep mode and TCP connections are stale, when the PC resumes the Softwarephone registration it's lost already (since already passed long time) but locally the Softwarephone have his "TCP" connection UP as "Stale" so you see locally at User-1 that's registered what is wrong. This would be solved with the next RAS keepalive that usually it's every 120 seconds however if we use H.323/TCP or H.323/TLS this value it's 3600 seconds instead so need to wait 1 hour for the phone retry registration on the PBX or manually restart the softwarephone.

We can reduce the RAS TTL value to 120 seconds with the following command on the PBX.

!config change H323 /ras-h225-factor 1

= Related Articles =
* [[{{NAMESPACE}}:Concept_myPBX]]

Reference9:Phone/User/Function-Keys/Switch

2020-02-06T12:41:50Z

Aci:

== Switch ==

Once several users have been registered, this function can be used to switch to another user as the active user.

The Switch fkey parameters need to be exactly configured as the registration.
When pressed, the fkey parameters are compared against reg-config.
E.g. If no number configured on registration, you MUST NOT configure the number field on the fkey config. Otherwise the phone does not identify the registration which is to be activated.

''Tip: If the new registration has become active after use, the function key assignment of the new registration also applies. It therefore makes sense to configure a deregistration on this key in the user's configuration.''

Reference13r1:Concept myAPPs Search in local-Outlook Contacts

2020-01-28T13:36:18Z

Aci: /* Configuration */

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

* Microsoft Office Outlook
* PBX Version 13r1 
* myAPPs Windows launcher version 13r1 
* configured MAPI profile in Outlook (Exchange Account)

== Configuration ==

The feature is by default always enabled.

=== Search Attributes ===

Search can be performed for firstname and/or lastname

=== Result Attributes ===

Following attributes within Outlook are displayed upon name search (if available):

* OFFICE_TELEPHONE_NUMBER
* MOBILE_TELEPHONE_NUMBER
* BUSINESS_FAX_NUMBER

== Usage ==
Outlook Search will find contacts in all exchange accounts.

== Known limitations ==
<ul><li>Works only with windows launcher and so Windows compliant only. </li>
<li>Not compatible with the reverse name resolution, based on incoming calling party numbers.</li>
</ul>

== Related Articles ==

Reference13r1:Concept myAPPs Search in local-Outlook Contacts

2020-01-28T13:32:45Z

Aci:

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

* Microsoft Office Outlook
* PBX Version 13r1 
* myAPPs Windows launcher version 13r1 
* configured MAPI profile in Outlook (Exchange Account)

== Configuration ==

The feature is by default always enabled.

=== Result Attributes ===

Following attributes within Outlook are displayed upon name search (if available):

* OFFICE_TELEPHONE_NUMBER
* MOBILE_TELEPHONE_NUMBER
* BUSINESS_FAX_NUMBER

== Usage ==
Outlook Search will find contacts in all exchange accounts.

== Known limitations ==
<ul><li>Works only with windows launcher and so Windows compliant only. </li>
<li>Not compatible with the reverse name resolution, based on incoming calling party numbers.</li>
</ul>

== Related Articles ==

Howto:Gigaset N510 PRO - Gigaset - Testreport

2020-01-22T16:51:55Z

Aci:

==Summary==

The Gigaset N510IP PRO DECT base-station supports all required innovaphone features and is therefore qualified as [[Howto:What_is_a_%22recommended_product%22%3F|recommended product]].

The usage of wideband codecs of the phone were tested successfully. The integration of the innovaphone voicemail in the Gigaset solution is possible. The message waiting indication will be displayed on the handsets. The handsets support 3-party conference calls.

The Gigaset N510IP PRO DECT base-station was tested successfully also in a [[Howto:Hosting#Overview | hosted setup]]. The test results are the same as if the N510IP is used in a normal (in the same LAN as the PBX) setup. It is not required to activate MediaRelay on the Frontend.

==Certification Status==

{{Template:Compat Status "tested"}}





Testing of this product has been finalized September 6th, 2013.

==Version==
Firmware Version:
* 42.078 (420780000000 / V42.00)

innovaphone Firmware:
* V10 SR3
* TSP 8150

== Test Setup ==
[[Image:Testreport_Terminals_SIP_or_H323_1.PNG]]

==Device Setup==

{| border="1"
!Tested feature
!Result
|----
|Register Device w/o specific configuration (requires DHCP)
|No
|----
|DHCP is default
|Yes
|----
|DHCP yields timeserver and time displays correctly
|No, set static to public NTP server
|----
|SNTP config has TZ string for timezone/dst autoconfig
|No, set static to public NTP server
|----
|DHCP yields correct default gateway
|Yes
|----
|Device supports magic registration (e.g. by serial)
|No
|----
|Fixed registrations works
|Yes
|----
|Device registers w/o Extension (just by name)
|Yes
|----
|Device registers by name with non-latin1 characters (e.g. UserÄÖÜ)
|Yes
|----
|Device registers by extension
|Yes
|----
|Device registers with password
|Yes
|----
|Device registers multiple identities
|Yes
|----
|2nd GK is supported
|According to [https://gigaset.atlassian.net/wiki/pages/viewpage.action?pageId=28540959 gigaset-wiki] only by DNS according to RFC3263
|----
|Device supports Redirection of Registration (Master redirects to Slave)
|No
|----
|Device supports STUN protocol
|Yes
|----
|Device sends NAT - keepalive messages
|Yes
|----
|Device refreshes the PBX registration
|Yes
|----
|Device supports SIP over TCP
|Not tested in LAN setup. Not usable for Hosting Setup, TCP connection is close immediately after SIP-TCP messages was sent. As a result - in a hosting setup the phone is not reachable for incoming calls.
|----
|Device supports SRTP
|Not tested, needs SIPS
|----
|Device supports SIPS (SIP over TLS)
|Not OK, registration fails
|----
|Device supports HTTPS
|Not for Admin access on the Web-page, probably as HTTP-client to retrieve firmware/configuration from remote servers
|----
|Device supports VAD (Voice activity detection)
|Not tested, according to manual supported
|----
|Supported menu languages
|many, check [http://gigaset.com/de/de/pages/index.html product specifications]
|----
|3-party conference
|Yes
|}

==Test Results==

=== Basic Call ===

{| border="1"
!Tested feature
!Result with MR
|----
|call using g711a
|Yes
|----
|call using g711u
|Yes
|----
|call using g729
|Yes
|----
|call using g722
|Yes
|----
|Overlapped sending
|No
|----
|Device sets up an early media channel for incoming calls
|N/A
|----
|Device sets up an early media channel for outgoing calls
|Yes
|----
|Device shows called id number
|Yes
|----
|Device shows called id name
|Yes
|----
|Device shows called id display info
|Yes
|----
|Fax using T.38
|N/A
|----
|CGPN can be suppressed
|Yes
|----
|Reverse Media Negotiation
|Yes
|----
|Device shows CDPN/CGPN on incoming call
|Yes
|----
|Device shows CDPN/CGPN on outgoing call
|Yes
|----
|Device shows connected number
|No
|----
|Device shows diverting number
|No
|----
|Device supports distinctive ringing
|Yes
|----
|Device supports asymetric codec negotiation
|Not tested
|----
|Device supports codec renegotiation during a conversation
|Yes
|----
|Device shows correct display message in case of busy CDPN
|Yes
|----
|Device shows correct display message in case of not existing CDPN
|No, it says "Not available"
|----
|Device shows correct display message in case that the call is declined
|Yes
|----
|3party conference possible
|Yes
|----
|Device supports display updates during call(needed for Directory Search object)
|No
|----
|Long Time Call (>30 min) works?
|Yes
|----
|Incoming SRTP call - SRTP not enabled on DUT
|Yes
|----
|Incoming SRTP call - SRTP enabled on DUT
|Not tested, requires sips
|----
|Voice Quality OK?
|Yes
|}

=== DTMF ===

{| border="1"
!Tested feature
!Result
|----
|DTMF tones sent correctly
|OK
|----
|DTMF tones received correctly
|OK, DTMFs are sent as RTP-Events (no DTMF dependent function on Gigaset device)
|}

=== Hold/Retrieve ===

{| border="1"
!Tested feature
!Result
|----
|Device handles incoming hold correctly
|Yes
|----
|Device can put a call on hold using correctly(inactive or sendonly)
|Yes
|}

=== Transfer with consultation ===

{| border="1"
!Tested feature
!Voice Ok?
!MoH Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|Yes
|----
||inno1 calls inno2. inno1 transfers to testphone.
|Yes
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|Yes
|Yes
|}

=== Transfer without consultation (alerting only) ===

{| border="1"
!Tested feature
!Voice Ok?
!MoH Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|Yes
|----
||inno1 calls inno2. inno1 transfers to testphone.
|Yes
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|Yes
|Yes
|}

=== Blind Transfer ===

{| border="1"
!Tested feature
!Voice Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|----
|inno1 calls inno2. inno1 transfers to testphone.
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|}

=== Blind Transfer (alerting only)===

{| border="1"
!Tested feature
!Voice Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|}

=== Broadcast Group & Waiting Queue ===

{| border="1"
!Tested feature
!Result
|----
|testphone makes call to a Broadcast Group. inno1 picks up.
|Yes
|----
|inno1 makes call to a Broadcast Group. testphone picks up.
|Yes
|----
|testphone makes call to a Waiting Queue. inno1 picks up before announcement is played.
|Yes
|----
|testphone makes call to a Waiting Queue. inno1 picks up after announcement is played.
|Yes
|----
|inno1 makes call to a Waiting Queue. testphone picks up.
|Yes
|}

=== DTMF Features ===

{| border="1"
!Tested feature
!Result
|----
|CFU Activate/Deactivate
|Ok
|----
|CFB Activate/Deactivate
|Ok
|----
|CFNR Activate/Deactivate
|Ok
|----
|Pickup Group
|Ok
|----
|Pickup Directed
|Ok
|----
|Park/Unpark
|Ok
|----
|Park To/Unpark From
|Ok
|----
|Call Completion Busy
|Nok, Gigaset rejects incoming call for starting CCBS/CCNR
|----
|Call Completion Cancel
|Not tested, since CCBS/CCNR does not work
|----
|Join Group/Leave Group
|Ok
|----
|Join All Groups/Leave All Groups
|Ok
|----
|Enable mobility/Disable mobility
|Not tested, feature is invoked by mobile phone
|----
|Enable mobility cw/Disable mobility cw
|Not tested, feature is invoked by mobile phone
|----
|Set presence
|Ok
|}

==Other Features==

===Directory===

{| border="1"
!Tested feature
!Result
|----
|Device built-in directory
|----
|Exists
|Yes
|----
|Can be dialled from
|Yes
|----
|Does CLI resolution
|Yes
|----
|display update if directory object is used?
|Yes
|}

*It is possible to configure a connection to an online source like DE - Klicktel. Please take a look into the manual or configuration.
*It is possible to import and export the local Phonebook.
*You can add the call to the local phonebook from the call-list.

{| border="1"
!Tested feature
!Result
|----
|External LDAP Server supported
|Yes, tested with Estos Metadir. PBX not supported as external LDAP server and LDAPS not supported.
|----
|Can be dialled from
|Yes
|----
|Does CLI resolution
|Yes
|----
|display update if directory object is used?
|Yes
|}

===Keys===

{| border="1"
!Tested feature
!Result
|----
|Device has speed dial keys
|Yes, depending on handset
|----
|Device has programmable function keys
|Yes, depending on handset
|----
|Device has partner keys
|No
|}

===CTI Features (with SOAP / TAPI / myPBX) ===

{| border="1"
!Tested feature
!Result
|----
|User Call - outgoing call
|Ok
|----
|User Connect - Answer incoming call
|Ok
|----
|User Reject - Reject alerting call
|Ok
|----
|User Disconnect - Disconnect active call
|Ok
|----
|User Hold - Put connected call on hold
|Ok
|----
|User Hold Retrieve - Retrieve call on hold
|Ok
|----
|User Transfer - Transfer with Consult
|Nok(myPBX), Ok(Tapi/Soap)
|----
|User Transfer - Transfer with Consult (Alerting only)
|Nok(myPBX), Ok(Tapi/Soap)
|----
|User Transfer - Blind Transfer
|Ok, Ok(Tapi/Soap)
|----
|3PTY - Make 3rd Party Call
|Nok(myPBX), Nok(Tapi/Soap)
|----
|Connected Number Update on Display
|No
|}

* tested with myPBX and TSP(8150)only

== Configuration ==

=== innovaphone configuration ===
Add a new PBX object of type "user": 
[[Image:Siemens Gigaset N510IP PRO - PBX_Userobject.png]]

=== 3rd party product configuration ===

====IP Configuration====

First you have to configure the general ''IP Configuration'' for the base-station.

* IP Address
* Subnet Mask
* Default Gateway
* DNS

[[Image:Siemens Gigaset N510IP PRO - Gigaset_IP_Configuration_ENG.png]]

====Telephony Connection====

In the next step you have to create a registration from the DECT/IP base-station to the PBX. Go to ''Telephony->Connections'' and ''edit'' the first entry.

Click on ''Select Provider'' and choose your country and ''innovaphonePBX''. This will ensure that all settings are configured correctly.

The device still needs the IP address of the PBX to register at and the name of the user for whom the registration shall be made. Click on ''Show advanced settings'' in order to enter as ''Domain'' name the IP address of your innovaphone PBX.

Please note that the registration credentials configured at the Gigaset phone use the ''number'' of the corresponding PBX object, not its name. Registration by using the name is also possible, but will result in CGPN display problems when making calls from the Gigaset phone to a mobility enabled user.

When using the Reverse Proxy, you have to set the protocol to TCP instead of UDP

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Telefonie_Connection_ENG.png]]

====Number Assignment====

If you have more than one DECT handset registered to your base-station, you can use the ''Telephony->Number Assignment'' menu to assign a DECT handset to a specific PBX registration.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Number_Assignment.png]]

To work with CTI clients like myPBX we need to configure the Call Manager with the handset that should handle this CTI calls and the mode (headset/handsfree).

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Call_Manager.png]]

====Voicemail====
To get the current voicemail status displayed on your DECT handset, you have to enter the corresponding innovaphone voicemail number in the ''Telephony->Network Mailbox'' menu.
[[Image:Siemens Gigaset N510IP PRO - Gigaset_VM_ENG.png]]

====Phone Directory - Adress Book====

You can import/export and save the local phonebook. Have a look at the configuration description in the Gigaset manual.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Phone_Directory_ENG.png]]

====Enhanced VoIP Settings====

If the device is used in a hosted setup, make sure that the following settings are configured:
* Automatic Negotiation of DTMF transmission: '''Yes'''
* Find target addr. automatically: '''Yes'''

At last you can configure some enhanced VoIP Settings like the handling of the "R" button. For more information have a look at the configuration description in the Gigaset manual.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_advanced_VoIP_Settings_ENG.png]]

=== Known problems ===

==== innovaphone PBX Version 12 ====

With the upcoming version 12 from innovaphone AG we have implemented the security feature [https://tools.ietf.org/html/rfc3261#section-22.4 SIP digest authentication] . If the client does not support this feature the PBX will reject the registration.

There is a config option to avoid this if you use a older firmware.

http://ip-of-pbx/!config change SIP /disable-digest-replay-check
http://ip-of-pbx/!config write
http://ip-of-pbx/!config activate

This problem has been '''fixed by Gigaset with N510 Firmware 42.240''', November 2016 and later

==== MoH ====
Customer reported that even when choosing as Providerprofile ''innovaphonePBX'', MoH was not audible when a call was put on hold by the Gigaset device. The reason for this is that the Gigaset signals the hold using a "sendonly" instead of an "inactive" SDP-attribute.
To fix this error, you can configure the innovaphone PBX to ignore the wrong hold-signaling:

http://ip-of-pbx/!config add SIP /take-sendonly-as-inactive
http://ip-of-pbx/!config write
http://ip-of-pbx/!config activate

Please keep in mind that this option will affect all SIP/UDP communication. So if you have for example another 3rd party SIP-device, which wants to play its own MOH - it will not work anymore.

==== Usernames with whitespace ====
Customer reported that when registering a Gigaset-device at an object-name with whitespace (e.g. John Doe), because of a bug on the Gigaset SIP-stack ut will not be possible to put a remote device on hold. As a workaround, don't remove the whitespace from the object-name (e.g. JohnDoe).

==== Recalling DECT device after transfer ====
With firmware v43, when you make a call transfer from a DECT phone to somewhere else, ~15 seconds you receive a recall call on the DECT phone.
Make a downgrade to v42 to work arround the problem.
The same happens in the gigaset N720 multi cell environment with firmwares above 098

==== innovaphone PBX Version 13 and Chat App ====
When using myApps to send chat messages to a user, the PBX broadcasts the IM-SETUP (instant-message) to all registered endpoints of the addressed user. Customer reported that Gigaset seems to take this as a regular media call and the phone starts ringing upon receiving a chat message, where in fact this is an instant messaging call. Bug needs to be reported to Gigaset. (Some newer systems of the N5xx series have an option to activate or disable the response to those IM messages.)

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

Howto:Gigaset N510 PRO - Gigaset - Testreport

2020-01-22T12:52:17Z

Aci:

Reference13r1:Apps/PbxManager/Waiting Queues

2020-01-09T08:48:11Z

Aci:

Configure your Waiting Queues

== Add a Waiting Queue ==
; Waiting Queue
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

== Edit a Waiting Queue ==
; Waiting Queue
: Long Name of the PBX object

; SIP
: Name of the PBX object

; Number
: Number of the PBX object

=== Call forwarding ===
Configure Call forwardings

Structure of a forwarding rule:
{| class="wikitable" border="1" cellspacing="0" cellpadding="5"
! Parameter
! Type
! Target
! Condition
! Boolean
! Save
! Delete
|-
! Hint
| Always (cfu) On busy (cfb) On no repsonse (cfnr)
| Number or Name
| true/false
|
|
|
|}

=== Announcements ===

The 1st announcement is played once when the call is connected. When the 1st announcement is complete, the 2nd announcement is played repeatedly. If there is no 2nd announcement, the caller will be disconnected when the 1st announcement is completed.

; Announcement 1
: [[{{NAMESPACE}}:PBX/Objects/Waiting_Queue#Announcements|See Announcement specific configuration]]

; Announcement 2
: [[{{NAMESPACE}}:PBX/Objects/Waiting_Queue#Announcements|See Announcement specific configuration]]

=== Agents ===
Select the Agents

=== Settings ===
[[{{NAMESPACE}}:PBX/Objects/Waiting_Queue|See Waiting Queue specific configuration options]]

=== DMTF two stage dialing ===
[[{{NAMESPACE}}:PBX/Objects/Waiting_Queue##DTMF_destinations|See DTMF specific configuration]]

= Related Articles =
* [[Course13:IT_Connect_-_07_Waiting_Queues]]
* [[{{NAMESPACE}}:PBX/Objects/Waiting_Queue]]

Reference13r1:Apps/PbxManager/Trunks

2020-01-09T08:44:27Z

Aci:

Configure your Trunklines

== Add Trunk ==

Create a new Trunk object on the PBX

; Name
: The Long Name of the PBX object

; Number
: The number of the object

; Loopback
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Incomplete
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Invalid
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Busy
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Rejected
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; No anwser
: [[{{NAMESPACE}}:PBX/Objects/Trunk_Line#Trunk_Object_specific_configuration|See Trunk specific configurations]]

; Interfaces/SBC
: You have first to create the Trunk. Afterwards you can reopen the Trunk configuration and configure the connected Interface/SBC

== Edit Trunk ==

; Interfaces/SBC
: Select the target Gateway and the Interface (BRI/PRI/TEL) or an SBC Interface (SIP1-SIP16) for the Trunk

= Related Articles =
* [[Course13:IT_Connect_-_05_Using_Trunks]]
* [[{{NAMESPACE}}:PBX/Objects/Trunk_Line]]

Reference13r1:Apps/PbxManager/APs

2020-01-09T08:41:55Z

Aci:

Configure connected App Platforms

== Add App Platform ==

Create a new AP object on the PBX

; Title
: The Long Name of the PBX object

; SIP ID
: The Name of the PBX object

; Host name
: The Hostname of the target AP without "https://"

== App Platforms ==

You see your configured AP Platforms

; Title
: The Long Name of the PBX object

; Host name
: The Hostname of the target AP without "https://"

; Checkmark
: If the checkmark is shown then the AP is successfully connected

= Related Articles =
* [[Course13:IT_Connect_-_13_Design_of_the_Application_Platform]]
* [[Reference13r1:Concept_App_Platform]]
* [[Howto:V13_Hosting_-_Central_AP_for_multiple_customers]]
* [[Howto:V13_Hosting_-_Dedicated_AP_for_every_customer]]

Howto13r1:Firewall Settings

2019-08-20T13:39:22Z

Aci:

==Applies To==
This information applies to

V13 and up

==Scenario: Reverse Proxy in a DMZ==

Here we would like to give an overview of the necessary ports and protocols for a reverse proxy in a DMZ.

The scenario would be that a reverse proxy is used in a DMZ. The DMZ has a link to the WAN and LAN.

===Configuration===

*Before you can setup your Firewall you have to read the book [[Course13:IT_Connect_-_10.0_Reverse_Proxy|Reverse Proxy]] in the [[Special:Prefixindex/Course13:|V13 IT Connect Training]].
*You can see the full [http://class.innovaphone.com/moodle2/file.php/701/Course_Data%2FReverse_Proxy%2FInnovaphone_Workload.png visual presentation] in the book of the [[Course12:Advanced_-_Reverse_Proxy|V12 Reverse Proxy Lesson]].

{| class="wikitable" border="1" cellspacing="0" cellpadding="10"
! style="background-color: #EAECF0;text-align:center"|WAN ⇒ DMZ (Reverse Proxy) !! style="background-color: #EAECF0;text-align:center"|DMZ (Reverse Proxy) ⇒ inside (PBX) !! style="background-color: #EAECF0;text-align:center"|DMZ (Reverse Proxy) ⇒ inside (Application Platform) !! style="background-color: #EAECF0;text-align:center"|inside ⇒ DMZ (Reverse Proxy) !! style="background-color: #EAECF0;text-align:center"|DMZ (Reverse Proxy) ⇒ WAN
|-
| STUN/TURN (udp/tcp/3478) || / || / || STUN/TURN (udp/tcp/3478) || /
|-
| LDAPS (tcp/636) 
''• optionally LDAP (tcp/389) if you need plaintext'' 
''• needed if you want to offer LDAP lookups''
|| LDAPS (tcp/636) 
''• optionally LDAP (tcp/389) if you need plaintext'' 
''• needed if you want to offer LDAP lookups''
|| LDAPS (tcp/636) 
''• optionally LDAP (tcp/389) if you need plaintext'' 
''• needed if you want to offer LDAP lookups''
|| /
|| /
|-
| HTTPS (tcp/443) 
''• optionally HTTP (tcp/80) if you need plaintext'' 
''• needed if you want to offer myApps'' 
''• please also allow wss/ws (websocket) connections''
|| HTTPS (tcp/443) 
''• optionally HTTP (tcp/80) if you need plaintext'' 
''• needed if you want to offer myApps'' 
''• please also allow wss/ws (websocket) connections''
|| HTTPS (tcp/443) 
''• optionally HTTP (tcp/80) if you need plaintext'' 
''• needed if you want to offer myApps'' 
''• please also allow wss/ws (websocket) connections''
|| HTTPS (tcp/<your custom port>) 
''• Advanced UI admin access''
|| /
|-
| H.323 (tcp/1300) 
''• optionally H.323 (tcp/1720) if you need plaintext'' 
''• needed if you want to offer Phone registrations''
|| H.323 (tcp/1300) 
''• optionally H.323 (tcp/1720) if you need plaintext or username/password auths with invalid certificates'' 
''• needed if you want to offer Phone registrations''
|| /
|| /
|| /
|-
| SIPS (tcp/5061) 
''• optionally SIP (tcp/5060) if you need plaintext'' 
''• needed '''only''' if you want to accept SIP registrations''
|| SIPS (tcp/5061) 
''• optionally SIP (tcp/5060) if you need plaintext'' 
''• needed '''only''' if you want to accept SIP registrations''
|| /
|| /
|| SIPS (tcp/5061) 
''• optionally SIP (tcp/5060) if you need plaintext'' 
''• needed if you want to register a SIP Trunk from the RP to Provider and your Provider doesn't support TURN''
|-
| / || / || / || RTP (udp/16384-32767) 
''• needed if you want to register a SIP Trunk from the RP to Provider and your Provider doesn't support TURN''
|| RTP (udp/16384-32767) 
''• needed if you want to register a SIP Trunk from the RP to Provider and your Provider doesn't Support TURN''
|}

== Related Articles ==
* [[Course13:IT_Connect_-_10.0_Reverse_Proxy]]
* [[Course12:Advanced_-_Reverse_Proxy]]

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

Reference12r2:Concept myPBX for iOS

2019-07-24T07:16:55Z

Aci:

[[Category:Concept|iOS Softwarephone]]
Version 12r1 introduces myPBX for iOS, an iOS app for iPhone and iPad that provides similar features than the desktop phones IP222 and IP232 in the WLAN via H.323.

== Requirements ==
=== PBX ===
* myPBX license matching the PBX version (enabled at the user object)
* Uses Port-Lic since does an active registration on the PBX like an IP Phone.

=== iPhone/iPad ===
* An iPhone or iPad running iOS 8.0 or higher for best user experience but interoperability with earlier iOS versions beginning with 6.0 is supported.

== Features ==
For a feature overview refer to [[{{NAMESPACE}}:Concept_myPBX_derviates_and_features|myPBX derivates and features]].

== Installation ==
Install the app from the App Store. Search for "innovaphone" and "myPBX" to locate it.
Start the myPBX for iOS app and enter the credentials for registration on your PBX in the setup screen.

== Configuration via WEB browser ==
For configuration via WEB browser determine the IP address that has been assigned to the iPhone in the WLAN. It's shown on the setup screen of the app and in the WLAN settings. Access http on port 10006 or https on port 10007 from the browser of an iMac or PC. Make sure that myPBX for iOS is started and running in the foreground on the iPhone:
<nowiki>http://xx.xx.xx.xx:10006</nowiki>
<nowiki>https://xx.xx.xx.xx:10007</nowiki>

To log in to the configuration enter
User name: admin
Password: mypbx

== Configuration via e-mail ==
Since 12r1 sr 8 and 12r2 beta 4 configuration commands can be passed to the app via an URI. The URI might be sent to the iPhone by e-mail or made available as link in a web page. The URI must start with
<nowiki>com.innovaphone.commands://</nowiki>
I.e. URI scheme "com.innovaphone.commands". It might be followed by any sequence of configuration commands to set module parameters or variables. Please refer to the update script documentation. Commands must be separated by newline which needs to be replaced by "%0d%0a". Spaces might be replaced by '+'. E.g.
<nowiki>ser</nowiki>
<nowiki>config change PHONE SIG /h323 user /prot SH323 /gk-addr thepbx.company.com /gk-id company.com</nowiki>
<nowiki>vars create PHONE/USER-PWD/00000 pc 1234567890abcdef</nowiki>
<nowiki>config change MEDIA /stun thestun.company.com /turn theturn.company.com /turn-user turnuser</nowiki>
<nowiki>vars create MEDIA/TURN-PWD pc 8cb5df61335a13ea6a9f540db8224d99cecfe54ec663f29ea94df478ccc1c285</nowiki>
<nowiki>config change UP1 /url http://updateserver.company.com/init /poll 1</nowiki>
<nowiki>config change MAIN /deny-uri-commands 1</nowiki>
<nowiki>config activate</nowiki>
<nowiki>config write</nowiki>
<nowiki>reset</nowiki>
Results in the following prepared link
<nowiki>com.innovaphone.commands://ser%0d%0a</nowiki>
<nowiki>config+change+PHONE+SIG+/h323+user+/prot+SH323+/gk-addr+thepbx.company.com+/gk-id+company.com%0d%0a</nowiki>
<nowiki>vars+create+PHONE/USER-PWD/00000+pc+1234567890abcdef%0d%0a</nowiki>
<nowiki>config+change+MEDIA+/stun+thestun.company.com+/turn+theturn.company.com+/turn-user+turnuser%0d%0a</nowiki>
<nowiki>vars+create+MEDIA/TURN-PWD+pc+8cb5df61335a13ea6a9f540db8224d99cecfe54ec663f29ea94df478ccc1c285%0d%0a</nowiki>
<nowiki>config+change+UP1+/url+http://updateserver.company.com/init+/poll+1%0d%0a</nowiki>
<nowiki>config+change+MAIN+/deny-uri-commands+1%0d%0a</nowiki>
<nowiki>config+activate%0d%0a</nowiki>
<nowiki>config+write%0d%0a</nowiki>
<nowiki>reset%0d%0a</nowiki>
It might be placed as hypertext link into a mail and sent to the iPhone for first provisioning. Once the user clicks the link, the app starts and carries out the commands.

Note: [[{{NAMESPACE}}:Concept_myPBX_for_iOS#Configuration_via_e-mail_not_working_with_all_mail_clients]]

Note that the command
<nowiki>config change MAIN /deny-uri-commands 1</nowiki>
prevents further provisioning commands via this mechanism.

=== Considerations for vars create ===
The vars create command needs its value URL encoded. Spaces must be denoted as %2520 to leave %20 after the first step of URL decoding or as %2b to leave + which means space. A plus seen as %2b in the command must we re-written as %252b. E.g. the configuration command
<nowiki>vars create PHONE/USER-REG/00001 p %3creg+gk-addr=%27172.16.1.1%27+e164=%27123%27+h323=%27user%2btest%27+/%3e</nowiki>
needs to be embedded in the mail as one of these
<nowiki>vars+create+PHONE/USER-REG/00001+p+%3creg%2bgk-addr=%27172.16.1.1%27%2be164=%27123%27%2bh323=%27user%252btest%27%2b/%3e</nowiki>
<nowiki>vars+create+PHONE/USER-REG/00001+p+%3creg%2520gk-addr=%27172.16.1.1%27%2520e164=%27123%27%2520h323=%27user%252btest%27%2520/%3e</nowiki>

=== Issue with some older myPBX iOS Versions ===
Some older myPBX iOS versions garble the first command. It is therefore recommended that you insert a first, useless command (e.g. <code>ser</code>) as first command in to your command sequence.

== Settings ==
Most of the configuration of myPBX for iOS in the config screen is identical to the one of the desktop telephone IP222. Instead of the device settings you will find the app settings, which are specific to iOS.

[[Image:mypbx_ios_app_settings_reference.jpg]]

==== Start automatically ====
This setting controls when myPBX for iOS should be active in background. Note that incoming calls are only indicated if the app is started and either visible or put in background via short press of the home button. If it has been stopped via the "Off" button at the headline of the settings screen or kicked away in the task manager, incoming calls are not indicated.

- "If connected to WiFi": The app stays active in background if connectivity is through WiFi. It quits background activity if connectivity changes to other than WiFi to make sure that it doesn't generate charges due to mobile data traffic. This is the default.

- "If mobile data/WiFi available": It stays active in background if connectivity is through WiFi or mobile data. Note that this may generate charges due to mobile data traffic.

- "Always": It always stays active in background.

- "Never": It never stays active in background. If telephone functions are needed myPBX for iOS must be started manually by click on its app icon.

==== GSM use ====
These are the options in which situation a call initiated in myPBX for iOS is deferred to the GSM dialer of the iPhone. The options are

- "Never": myPBX for iOS dials all calls itself and presents "no channel available" if the registration is not up. This is the default.

- "If registering isn't possible": Calls are deferred to GSM if the registration is not up, i.e. if no WiFi or mobile data connectivity exists.

- "Always for external calls": External calls are deferred to GSM.

- "For all calls": All calls are deferred to the GSM dialer.

- "If not connected to WiFi": myPBX for iOS dials all calls itself only if connectivity is through WiFi. Without WiFi all calls are deferred to the GSM dialer.

The last three options are useful if the WiFi or mobile data performance is not good enough for VoIP or if there is a quota on the mobile data traffic. Then the directory and presence information is still available and the calls use the GSM network.

==== Hang up with docking station ====
If the iPhone is used with a docking or charging station this option enables automatic call acceptance if the iPhone is lift from the dock and call disconnection if it is put back to the dock. Keep this setting off if the iPhone might be plugged for re-charging during a call as plugging would disconnect the call. The default of this setting if "off".

==== Auto-rotate screen ====
Keep this setting on if you want myPBX to automatically react to orientation changes.

==== Display brightness in docking station ====
This setting is useful in conjunction with a docking or charging station on the desk. It lets the iPhone keep its screen on while it is put in the station.

- "Display off": The iPhone doesn't keep its screen on when it is in the docking station. This is the default.

- "Dimmed": The iPhone keeps its screen on with lower brightness while it is in the docking station.

- "Bright": The iPhone keeps its screen bright while it is in the docking station.

==== Text ====
For iOS versions prior to 7.0 this setting chooses the font size used in the app. Large ("L") is the default.

- "XS": Very small

- "S": Small

- "M": Medium

- "L": Large

- "XL": Extra large

- "XXL": Extra, extra large

- "XXXL": Largest possible

==== WLAN MAC Address ====
The iOS operating system doesn't disclose the real WLAN MAC address to an application. It pretends on all devices that it's 020000000000. In this case myPBX for iOS assumes a random value based on the timestamp at installation of the app. This might be overwritten e.g. with the real value that is still shown in the iOS settings app.

==== Save log ====
Starts and stops saving a debug trace on the iPhone. To get the trace files connect the iPhone via USB to the iMac or PC, start iTunes and locate "Apps", "Shared Files", "myPBX". The file names are trace.txt, trace0.txt, trace1.txt, trace2.txt, trace3.txt.

==== Send logs via e-mail ====
Prepares an e-mail that contains all log files ready to send after a support ticket has been opened at innovaphone. Please insert the ticket number in the e-mail subject line prior to sending it.

== Update ==
App updates of myPBX for iOS are distributed regularly via iTunes.

Update scripts may be used with myPBX for iOS in the same manner as with the desktop phones. The default name of the script is
update-MYPBXI.htm

App updates via update script are not possible. These script lines are ignored.

== Push Service ==

As of V12r2sr20 push notifications are supported. For details please refer to [[Reference12r2:Concept_Push_Notifications_for_myPBX_on_iOS]]

== Taking traces ==
innovaphone always works on improving myPBX for iOS and making it as stable as possible on every iPhone and iPad model. If there is a problem please try to capture a trace by turning trace logging on (Settings/App settings/Save log). Re-do the steps to reproduce the problem. Stop logging and get the trace files via USB connection to iMac or PC or send them by e-mail (Settings/App settings/Send logs via e-mail).

=== Mobile Data (3G/4G) pcap traces ===

If there are iOS problems in 3G / 4G which do not occur in the WLAN, you can still create with our trace options pcaps.
1. myPBX app under "Settings" -> "Web Configuration". In our webGUI (For my Android 6.0.1 only with chrome usable not with the Android browser (easy chrome open and
127.0.0.1 if no default) and the necessary trace options.

2. myPBX app -> app settings -> "save log"

3. Make calls and in the app settings "Send logs via mail" or even via USB.

4. Important! Deactivate the trace options in the webgui or deactivate logging again!
Otherwise, the phone_logcat gradually becomes too large ... even without calls.

== Adding ring tones ==

To add a ring tone create a MP3 file with a few seconds of audio and place it into the Ringtones subdirectory of myPBX for iOS. This directory is accessible via the browser of an iMAC or PC via
<nowiki>http://xx.xx.xx.xx:10006/drive/cf0</nowiki>
<nowiki>https://xx.xx.xx.xx:10007/drive/cf0</nowiki>
myPBX for iOS must be running in the foreground for this and must be terminated and started again to make the new file selectable as ring tone.

== Known limitations ==

=== H.323/UDP not supported ===
H.323/UDP is not supported on myPBX for iOS. The signalling link to the PBX must be TCP or TLS.

=== SIP protocol not supported as User-1 ===
If we set the protocol SIP the application will not obtain the mypbx license from the PBX and for that reason will not work, H.323/TCP or H323/TLS must be used.

=== No synchronisation with GSM call list ===
It is not possible to synchronize myPBX for iOS and GSM call list.

=== Button on Bluetooth headsets not functional ===
The button of Bluetooth headsets doesn't provide for accepting or disconnecting calls. The button on wired earphones does.

=== H.323/TLS Connection not Trusted by Default ===
Please check the [[Reference11r1:Concept_H.323_over_TCP/TLS_(H.460.17)#Known_Issues|H.323/TLS Known Issues article]].

=== Delayed re-registration if mobile data use not permitted ===
The option "Start automatically" set to "If connected to WiFi" means that the use of mobile data traffic is not permitted. In this case it can take up to 10 minutes to re-gain registration if WiFi is available again after connectivity had been through mobile data.

=== Some WebUI operations are not possible on the iPhone itself ===
The button "Web Configuration" of the app shows the Web UI which allows extended configuration but has some limitations due to the browser window. E.g. it is not possible to download a certificate. These operations might be carried out via a Web browser on a remote computer. Note that myPBX iOS needs to be running in foreground to be accessible.

=== Configuration via e-mail not working with all mail clients ===
Configuration via e-mail doesn't work with all e-mail clients. It does however work with the native mail client of iOS.

== Known issues ==
===Incoming GSM calls===
:An incoming GSM call, puts the VoIP app in background and the remote IP-peer hears nothing until you switch back to the VoIP app.

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

==Related Articles==
*[[{{NAMESPACE}}:Concept myPBX for Android]]

Reference12r2:Concept Push Notifications for myPBX iOS and Android

2019-06-11T09:50:01Z

Aci:

[[Category:Concept|iOS Softwarephone]]
With firmware version 12r2 sr20 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 12r2sr20 [125501] or higher
* Internet access via HTTPS

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

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

== Configuration ==
=== PBX ===
* Check the '''System Name''' of the PBX - it must be globally unique. We recommend to use the DNS domain name of the company using the PBX.

* '''For the next steps, do not use ''Internet Explorer'', ''Edge'' or ''FrontMotion Firefox'' Browser at the moment. It will not work!'''

* Create a new PBX object of type [[Reference12r2:PBX/Objects/Push|Push]].
** The Name of the Push object is case sensitive and will be used in the User objects to identify the push service.
** Do '''NOT''' set a password - this is later-on filled-in automatically!
** Make sure to click on ''OK'' or ''Apply'' button before proceeding with next steps.
* Navigate to the Push tab of the Push object and provide a valid E-Mail address that can be used to send an HTTP link for verification.
** E-Mail must not be an E-Mail already used as E-Mail of another object.
* Press ''Connect'' button, '''do not close the window''' until E-Mail verification is done.
* Wait for the E-Mail and open the verification link in the browser.
* Press ''OK'' button after ''Connect succeeded'' appears.
* Navigate to [[Reference9:General/Certificates]] and trust to certificate ''*.innovaphone.com'' that should appear on the list of rejected certificates. You have to do this on every slave and/or standby PBX.
(as of version 12r2 SR22 the certificate ''*.innovaphone.com'' is already included in the firmware, so you can skip this step)

[[Image:Rejected certs.png]]
* The trust list should look like this afterwards:
[[Image:Trusted certs.png]]

=== User Objects ===
* For each user who is to receive push notifications on his myPBX-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 app.

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

== Troubleshooting ==
* Check the trust list for certificate of the innovaphone AG.
* Make sure the PBX can resolve the DNS host ''services.innovaphone.com''.
* Make sure the PBX can reach ''services.innovaphone.com'' via HTTPS.
* Make sure you do not use Internet Explorer or Edge.
* Make sure the mail used for Push is not used by another PBX object.
* If there are problems with setting up the Push Service or if individual subscribers can not be reached, open a Support Ticket.
* Only if you are not sure if the push service is operational at the moment, open a support ticket and send an email to ''push-support@innovaphone.com''.
* Make sure the myPBX 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).
* Once a domain is already registered with an email address, this domain cannot be authenticated with another email address. In this case you will not receive any email from our push service.

== Known limitations ==
=== Push object creation and configuration of the connection is not working with Internet Explorer/Edge.===
Use Firefox or Chrome to create and configure the Push object.

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

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

Howto:SIP redundancy / failover

2019-05-14T15:01:30Z

Aci:

{{FIXME|reason= this article is still in progress and not finished yet}}



==Overview==
We often encounter scenarios in which the reliability of the SIP connection is to be ensured. There are several approaches and scenarios how to achieve this SIP redundancy or failover.

How well SIP redundancy and/or failover works, depends on the interaction between the PBX and the carrier providing the SIP account.

==PBX / Gateway==
To support various carriers, innovaphone has already implemented the following configurable features:
* Accepting trunk registrations from multiples Sources (GWs)
* Always place the call on a primary trunk and in case of an error, on a secondary trunk or round robin
* Receive calls from multiple trunk registrations
* Route calls between GWs back and forth
* Rerouting of failed calls

==Carrier scenarios==
Of course your possibilities here depend on the carrier's feature-set

=== Two permanent active SIP Interfaces ===

The best practice would be if the Carrier accepts two registrations from different sources with the same credentials

* SIP Interfaces on two Gateways with identical configuration
** Both Interfaces register to the Trunk Object in the PBX
* The routing configuration on the Gateway should be identical
* The call distribution is not critical, but needs to be considered in the configuration
** Some carriers send all incoming calls on the ''primary'' trunk only and expect all outgoing calls over the same ''primary'' trunk
*** Outgoing Calls must be first sent to the ''primary'' Interface, then to the ''secondary'' one
** Some carriers use both trunks for incoming and outgoing calls

=== Active SIP Interface, secondary disabled SIP Interface===

If the Carrier doesn't accept two registrations from different sources with the same credentials then you can prepare the failover scenario, but you have to switch here manually.

* SIP Interfaces on two Gateways with identical configuration
** The ''primary'' Interface should be enabled
** The ''secondary'' Interface should be disabled
** Both Interfaces register to the Trunk Object in the PBX
* Routing on the Gateway should be identical
* The call distribution is straight-forward because there is only one single active Interface at the same time
* If the ''primary'' trunk fails, it must be disabled manually and the secondary one activated

- There are some ideas to achieve this with the help of some lines of codes and your monitoring appliance which would trigger and be able to disable/enable these Interfaces via HTTP(S) commands.

- There are some ideas to achieve this with the help of [[Reference13r1:Concept_App_Platform|V13 App Platform]] and the [https://github.com/innovaphone/13r1-SDK SDK] by developing your own App to automate this process suiting your needs

- Today we have no automatic mechanism for SIP Interfaces which enable a SIP interface if the other one fails, but there is a [http://forum.innovaphone.com/moodle2/mod/forum/discuss.php?d=22972 feature request] where you can vote for it.



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

Reference9:Services/HTTP/Client

2019-02-12T12:26:00Z

Aci:

== Authenticated URLs ==
Some files that the device must access via HTTP (update commands, MoH, announcements, voicemail, etc.) may be located in a password-protected area. A list of URLs with the respective user names and passwords can be configured. The URLs in the list usually specify only the path to a file (or a part of it). The longest string match of the list defines the user name and the password used for authentication.

Note that the log server always includes the port number in the URL. If a URL for the logserver needs a password a version the URL that includes the port number needs be specified here to generate a match.

{|
|valign=top nowrap=true|'''URL'''
|An URL, for example <nowiki>http://192.168.0.1/update</nowiki>, specifying a password protected folder
|-
|valign=top nowrap=true|'''User/Password'''
|Authentication needed for the folder (The length of the password is limited to 16 characters)
|}

== Proxy Servers ==
Individual proxy servers can be configured for HTTP and HTTPS operations.

{|
|valign=top nowrap=true|'''Host'''
|The domain name (e.g. proxy.example.com) or IP address (e.g. 192.168.0.1) of the proxy server.
|-
|valign=top nowrap=true|'''Port'''
|The port of the proxy server.
|}

== No Proxy Server for ==
Here you can define networks and domains that shall be accessed directly without using a proxy server.

{|
|valign=top nowrap=true|'''Address'''/'''Mask'''
|The base address and network mask of a network (e.g. 192.168.0.0 / 255.255.255.0)
|-
|valign=top nowrap=true|'''Domain suffix'''
|The suffix of a DNS name (e.g. .example.com or host.example.com)
|}

Note that exceptions that are defined using base address and network mask only apply to requests using an IP address (e.g. <nowiki>http://192.168.0.1/update</nowiki>).
Exceptions that are defined using a domain suffix only apply to requests using a domain name (e.g. <nowiki>http://host.example.com/update</nowiki>).

Howto:How to customize the From/Identity header value at SIP interfaces

2019-01-17T08:22:38Z

Aci:

In some cases, SIP providers ask for From/Identity Header values which we cannot build automatically.
In such circumstances we can use the "add UUI" in Route Map and a specific configuration in the SIP interface for this.

==Applies To==
This information applies to all innovaphone gateways

* V12r2 and higher

==More Information==

===Problem Details===

If we look into the configuration of From or Identity Header in the SIP interface, we see that the innovaphone system tries to build these headers with either one of the following:
* for FROM: Fixed AOR, AOR with CGPN as Display, CGPN in user part of URI
* for IDENTITY: CGPN in user part of URI, Fixed AOR

In this case, the header is built automatically with parts of information already known by the system as CGPN or AOR.
But in some cases, the provider requires a value in these Headers which is not related to any other known values. In such an event, we need a way to store and apply this "fixed" value.
So we will use both configuration parameters:
* "add UUI" in route map : [http://wiki.innovaphone.com/index.php?title=Reference12r2:Gateway/Routes/Map]
* the UUI option in the SIP interface configuration : [http://wiki.innovaphone.com/index.php?title=Reference12r2:Gateway/Interfaces/SIP]

=== Route Map Configuration===
The goal here is to use a MAP '''generally used for all outgoing calls'''. In order to achieve this, the better approach is to use the last one, which should be the MAP that sends the call to the SIP interface.

[[Image:Routesmaps.PNG]]

Open this map and add the required value in "add UUI" field.

[[Image:AddUUI.PNG]]

As the UUI will be used in the SIP header, we should write here a valid SIP URI: "<sip:UriUserPart@UriDomainPart>"

=== SIP interface configuration ===

In SIP interface select the UUI options in "From/Identity Header when Sending INVITE".

[[Image:IdentityUUI.PNG]]

At this point, you should also check your provider's requirements, as we have also a few other possibilities to adjust: UUI in From or UUI in Identity.
We can also go further with Advanced Tweaks like "/pai on" used for P-Asserted-Identity or P-Preferred-Identity as Identity header.

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

Reference13r1:Concept Offline Provisioning

2018-12-20T12:36:53Z

Aci: /* Requirements */

=Overview=
In some cases or environments, PBXs, Gateways and phones do not have Internet access. In this case ''service.innovaphone.com'' will not be reachable and a provisioning of new devices is not possible.

In order to be able to provision devices without Internet access, there is an option to provide the service itself in the local environment.

=Requirements=

* Version 13r1 (Phone and PBX)
* a running App Platform

= How it works =
* The client (e.g. Phone) which is waiting for a provisioning, logs into the local provisioning service which is located on a gateway.
* As soon as the user adds a new device via the ''User App'', a new code is fetched from the local provisioning system.
* When the code is entered on the phone, the client sends the code to the local provisioning system.
** If the code is valid, the client will receive some configuration about the environment and connect himself to the ''Devices App''

This is the same flow like we use it on the regular provisioning with Internet access.

=Configuration=

== Provisioning System ==

There is no need to activate the Provisioning System on a Gateway.
It's already available and you can use it on every Gateway.

== Devices APP ==

You need to configure your own Provisioning Service in the Devices App

# Open the ''Devices APP'' from your myApps Launcher
# Select the desired domain from the list and use the tab ''edit''
##Here you can insert you own Provisioning URL: <code>https://pbx.domain.tld/INSTALL/get-provisioning-code.htm</code>

==Client Setup==

You need to tell the Client, that he should not try to connect to the global Provisioning System. Instead he must connect to your local System.

Set the [[{{NAMESPACE}}:Services/Update|Update URL]] in the Client to: <code>https://pbx.domain.tld/INSTALL/provisioning.htm?mac=#m&provisioning-code=#p&localip=#i</code>

In the same way to distribute the Update URL to multiple Clients:
* Use a local [[{{NAMESPACE}}:DHCP_client#Supported_Options | DHCP Server]] with vendor options
* Use [[Reference:My_Innovaphone#Properties | my.innovaphone.com redirection]] (works only if the client is able to connect to ''https://config.innovaphone.com'')

=Related Articles=
* [[{{NAMESPACE}}:Services/Provisioning]]
* [[{{NAMESPACE}}:Services/Update]]

Reference13r1:Concept Offline Provisioning

2018-12-20T12:36:28Z

Aci: /* Provisioning System */

=Overview=
In some cases or environments, PBXs, Gateways and phones do not have Internet access. In this case ''service.innovaphone.com'' will not be reachable and a provisioning of new devices is not possible.

In order to be able to provision devices without Internet access, there is an option to provide the service itself in the local environment.

=Requirements=

* Version 13r1 (Phone and PBX)
* Running App Platform

= How it works =
* The client (e.g. Phone) which is waiting for a provisioning, logs into the local provisioning service which is located on a gateway.
* As soon as the user adds a new device via the ''User App'', a new code is fetched from the local provisioning system.
* When the code is entered on the phone, the client sends the code to the local provisioning system.
** If the code is valid, the client will receive some configuration about the environment and connect himself to the ''Devices App''

This is the same flow like we use it on the regular provisioning with Internet access.

=Configuration=

== Provisioning System ==

There is no need to activate the Provisioning System on a Gateway.
It's already available and you can use it on every Gateway.

== Devices APP ==

You need to configure your own Provisioning Service in the Devices App

# Open the ''Devices APP'' from your myApps Launcher
# Select the desired domain from the list and use the tab ''edit''
##Here you can insert you own Provisioning URL: <code>https://pbx.domain.tld/INSTALL/get-provisioning-code.htm</code>

==Client Setup==

You need to tell the Client, that he should not try to connect to the global Provisioning System. Instead he must connect to your local System.

Set the [[{{NAMESPACE}}:Services/Update|Update URL]] in the Client to: <code>https://pbx.domain.tld/INSTALL/provisioning.htm?mac=#m&provisioning-code=#p&localip=#i</code>

In the same way to distribute the Update URL to multiple Clients:
* Use a local [[{{NAMESPACE}}:DHCP_client#Supported_Options | DHCP Server]] with vendor options
* Use [[Reference:My_Innovaphone#Properties | my.innovaphone.com redirection]] (works only if the client is able to connect to ''https://config.innovaphone.com'')

=Related Articles=
* [[{{NAMESPACE}}:Services/Provisioning]]
* [[{{NAMESPACE}}:Services/Update]]

Reference13r1:Concept Offline Provisioning

2018-12-20T12:24:09Z

Aci:

=Overview=
In some cases or environments, PBXs, Gateways and phones do not have Internet access. In this case ''service.innovaphone.com'' will not be reachable and a provisioning of new devices is not possible.

In order to be able to provision devices without Internet access, there is an option to provide the service itself in the local environment.

=Requirements=

* Version 13r1 (Phone and PBX)
* Running App Platform

= How it works =
* The client (e.g. Phone) which is waiting for a provisioning, logs into the local provisioning service which is located on a gateway.
* As soon as the user adds a new device via the ''User App'', a new code is fetched from the local provisioning system.
* When the code is entered on the phone, the client sends the code to the local provisioning system.
** If the code is valid, the client will receive some configuration about the environment and connect himself to the ''Devices App''

This is the same flow like we use it on the regular provisioning with Internet access.

=Configuration=

== Provisioning System ==

There is no need to activate the Provisioning System on a Gateway.
It pre-activated and you can use it on every Gateway.

== Devices APP ==

You need to configure your own Provisioning Service in the Devices App

# Open the ''Devices APP'' from your myApps Launcher
# Select the desired domain from the list and use the tab ''edit''
##Here you can insert you own Provisioning URL: <code>https://pbx.domain.tld/INSTALL/get-provisioning-code.htm</code>

==Client Setup==

You need to tell the Client, that he should not try to connect to the global Provisioning System. Instead he must connect to your local System.

Set the [[{{NAMESPACE}}:Services/Update|Update URL]] in the Client to: <code>https://pbx.domain.tld/INSTALL/provisioning.htm?mac=#m&provisioning-code=#p&localip=#i</code>

In the same way to distribute the Update URL to multiple Clients:
* Use a local [[{{NAMESPACE}}:DHCP_client#Supported_Options | DHCP Server]] with vendor options
* Use [[Reference:My_Innovaphone#Properties | my.innovaphone.com redirection]] (works only if the client is able to connect to ''https://config.innovaphone.com'')

=Related Articles=
* [[{{NAMESPACE}}:Services/Provisioning]]
* [[{{NAMESPACE}}:Services/Update]]

Reference13r1:Services/Provisioning

2018-12-20T12:13:21Z

Aci:

Overview of all devices which currently use the local provisioning system.

* MAC Address
* IP Address

=Related Articles=
* [[{{NAMESPACE}}:Concept_Offline_Provisioning]]

Reference9:DECT2/Config/Phone Book

2018-10-02T09:35:35Z

Aci:

In this menu the LDAP directory to be searched for telephone numbers of remote parties can be configured and enabled.



'''General settings'''

* Introductory Text: This text is added to the message with returned phone book entries. It is not used in all device models. The maximum length is 20 characters.
* No Search Result Text: This text is used as a response to the portable device when there is no match. It is not used in all device models. The maximum length is 20 characters.
* Discarded Results Text: This text is added to the message when there are too many matches. It is not used in all device models. The maximum length is 20 characters.
* Result Format: The format of the displayed entry.
* Phone Book Number: Number used by the phone to access the phone book, this number shall not conflict with any of the handsets in the system. '''Important:''' ''*'' and ''#'' must not be used in the number, number length must be 6 digits. '''Please do not change the default value if not necessary.''' If nevertheless the parameter is changed here, it must be also '''changed on the DECT handsets''' (using WinPDM Software, under ''Systems / System X / PBX Settings / Numbers / Central Phonebook Number'' ).

'''PBX'''

* Enable: Enable usage of the innovaphone PBX directory.
* Server: The IP and port of the LDAP server (IP:port).
* User: User name for authentication at the LDAP server.
* Password: Password for authentication at the LDAP server.

'''External LDAP Server'''

* Enable: Enable usage of the external LDAP directory.
* Server: The IP and port of the LDAP server (IP:port).
* User: User name for authentication at the LDAP server.
* Password: Password for authentication at the LDAP server.
* Search Base: The search base for your LDAP query, e.g. ''dn=base''.
* Search Filter: The search filter for your LDAP query.
* Search Attributes: The search attributes, which are used to search in, e.g. ''givenName,sn''. The IP61 and IP63 have got two search line inputs. The first line is assigned the first search attribute, the second line to the second attribute. To use more than two search attributes the further ones can be appended in the second search line delimited with blanks.
* Number Attributes: The number attributes, which are returned by queries (optional with a description of the number, e.g. ''e164: (office),mobile: (mobile)'').
* Display/Sort Attributes: The display attributes, which are returned by queries, used to sort the results and are shown in the search result.
(for LDAP directory look up for incoming calls is used "LDAP Directory Search" in [[Reference11r1:DECT2/Config/Master]])

'''Dialing Location'''

The dialing location is an optional setting. If a directory maintains telephone numbers in international form with a leading '+' sign, a mechanism must be available to convert or normalize such a number into a dialable number with all the required prefixes.
* Country Code: The country code (e.g. ''49'' for Germany).
* Area Code: The area code (e.g. ''30'' for Berlin).
* National Prefix: The national trunk prefix (''0'' in Germany).
* International Prefix: The international trunk prefix (''00'' in Germany).
* External Line: The prefix, necessary to access a trunk line. This prefix equals ''0'' in most PBX configurations.
* Subscriber Numbers: For the conversion of international numbers to internal extensions, the relevant subscriber numbers (comma-separated) may be configured here (e.g ''4321,4322,4323'').

Howto:License Summary

2018-09-24T07:38:28Z

Aci:

-
'''This article is still under construction and will be available soon'''
-

==Summary==
Sometimes you want to have a detailed overview of PBX user licenses.
In V12, the PBX only shows a global overview of available and used licenses. For an exact view, you have to look in the PBX object in the tab License.
This PHP solution was initially included as a feature request in the [http://class.innovaphone.com/moodle2/mod/forum/discuss.php?d=17316 innovaphone forum], and maintained by the community.
{{FIXME|reason=switch link to final post if ready}}

Thanks a lot for this. With the consent of all involved, we are now officially providing this solution.

==Applies To==
This information applies to

* innovapnone PBX running V12
* innovaphone Linux Application Platform V10

===Requirements===
* Linux Application Platform (or Webserver with PHP, XML and CURL)
* Same admin/pass combination on all PBXes

==More Information==

===Installation===
* [http://download.innovaphone.com/ice/wiki-src#licsummary Download] all needed files
* Connect via SSH (putty) to your Linux Application Platform
*# Create a new folder: <code>mkdir /var/www/innovaphone/licsummary</code>
*# Upload all files to the new folder (Use SCP to upload all files via SSH, otherwise you can upload it via webdav and move the files via SSH to the correct folder)
*# Change file permissions: <code>chown www-data:www-data -R /var/www/innovaphone/licsummary</code>
*# Check access: http://x.x.x.x/licsummary

===Setup===

* Edit index.php and add your custom configuration
<code php>
$config = (object) array(
'master_pbx' => '172.16.80.233',
'username' => 'admin',
'password' => 'ip811',
);
</code>

===Usage===
By default, we show all users who have a license assigned. The following object types are hidden: Config template

* Show also users without licenses
* Check "unlicensed" licenses (takes a long time)

{{FIXME|reason=screenshot}}

===Troubleshooting===
*Error: PBX not reachable
:Check IP/DNS in your configuration object

*Error: Wrong user/pass for Master PBX
:Fix Login information

*Error: Wrong user/pass for Slave PBX (<pbx name>)
:Fix Login information for your Slave PBX

===Known Problems===

== Download ==
*[http://download.innovaphone.com/ice/wiki-src#licsummary http://download.innovaphone.com/ice/wiki-src#licsummary] - download the complete file package of scripts and files described in this article.

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

Howto:License Summary

2018-09-24T07:36:51Z

Aci:

-
'''This article is still under construction and will be available soon'''
-

==Summary==
Sometimes you want to have a detailed overview of PBX user licenses.
In V12, the PBX only shows a global overview of available and used licenses. For an exact view, you have to look in the PBX object in the tab License.
This PHP solution was initially included as a feature request in the [http://class.innovaphone.com/moodle2/mod/forum/discuss.php?d=17316 innovaphone forum], and maintained by the community.
{{FIXME|reason=switch link to final post if ready}}

Thanks a lot for this. With the consent of all involved, we are now officially providing this solution.

==Applies To==
This information applies to

* innovapnone PBX running V12
* innovaphone Linux Application Platform V10

===Requirements===
* Linux Application Platform (or Webserver with PHP, XML and CURL)
* Same admin/pass combination on all PBXes

==More Information==

===Installation===
* [http://download.innovaphone.com/ice/wiki-src#licsummary Download] all needed files
* Connect via SSH (putty) to your Linux Application Platform
*# Create a new folder: <code>mkdir /var/www/innovaphone/licsummary</code>
*# Upload all files to the new folder (Use SCP to upload all files via SSH, otherwise you can upload it via webdav and move the files via SSH to the correct folder)
*# Change file permissions: <code>chown www-data:www-data -R /var/www/innovaphone/licsummary</code>
*# Check access: http://x.x.x.x/licsummary

===Setup===

* Edit index.php and add your custom configuration
<code php>
$config = (object) array(
'master_pbx' => '172.16.80.233',
'username' => 'admin',
'password' => 'ip811',
);
</code>

===Usage===
By default, we show all users who have a license assigned. The following object types are hidden: Config template

* Show also users without licenses
* Check "unlicensed" licenses (takes long time)

{{FIXME|reason=screenshot}}

===Troubleshooting===
*Error: PBX not reachable
:Check IP/DNS in your configuration object

*Error: Wrong user/pass for Master PBX
:Fix Login information

*Error: Wrong user/pass for Slave PBX (<pbx name>)
:Fix Login information for your Slave PBX

===Known Problems===

== Download ==
*[http://download.innovaphone.com/ice/wiki-src#licsummary http://download.innovaphone.com/ice/wiki-src#licsummary] - download the complete file package of scripts and files described in this article.

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