innovaphone wiki - User contributions [en]

Howto:EManager - effexx - 3rd Party Product

2023-05-03T07:49:22Z

Sebastian.Lutz:

==Product name==
effexx EManager - This product is end of life. 

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

Testing of this product has been finalized 15th of December, 2016.

==Category==
[[Category:Referral Product|{{PAGENAME}}]]
{{Category:3rdParty_VoIPSystem_Management}}
[[Category:3rdParty_VoIPSystem_Management|{{PAGENAME}}]]

==Applies To==
Voraussetzungen:

* innovaphone PBX, ab V11R1
* innovaphone Linux Application Platform


==More Information==
effexx eManager ist ein grafisches, webbasierendes Tool zur komfortablen Verwaltung und Konfiguration der innovaphone PBX.

eManager ermöglicht das vollständige Einrichten einzelner sowie mehrerer Nutzer gleichzeitig. Außerdem besteht die Möglichkeit, Nutzer mit Hilfe eines Excel Imports anzulegen bzw. zu bearbeiten.
Folgende Funktionen stehen in dem Konfigurationstool zur Verfügung:

*Anmelden an definierter PBX
*Einzelnutzer Bearbeitung
*Multinutzer Bearbeitung
*Filtermöglichkeiten nach PBX
*Löschen von Nutzern
*Bearbeitungsmöglichkeiten im Detail:
**Passwort setzen, Passwort = Nebenstelle
**Emailadresse setzen
**Fork-Objekt,-Device,-Nummer setzen
**Config Template auswählen und setzen
**Gruppen anlegen/hinzufügen/löschen inkl. Status und Modus
**Group Indication setzen
**Device-Namen und Device-Nummer: Standard setzen (Bearbeitung möglich)
**Tasten setzen inkl. Auswahl der Funktion, Bezeichnung und Nummer
**Tasten löschen
*PBX Backup
*Suchfunktion für Hauptansicht (Suche und Sortieren)
*Ändern von Tastennummern (Migration von V10 zu V11)
 

[[Image:EManager Hauptansicht.png]] 
<center>eManager Hauptansicht</center>
[[Image:EManager Hauptansicht mit aufgeklapptem Editor.png]] 
<center>eManager Hauptansicht mit aufgeklapptem Editor</center>
[[Image:EManager Excel Import.png]] 
<center>eManager Ansicht Excel Import</center>
 
 

Die Nutzung von eManager erfolgt über einen aktuellen Webbrowser. Es muss keine Clientsoftware installiert werden.

===Installation/Systemrequirements===
Die Installation von eConference erfolgt auf der innovaphone Linux Application Platform. Es wird kein separater Server benötigt.

==Contact Details==
This product is end of life. 
effexx its GmbH 
Obere Industriestraße 8 
57250 Netphen

Peter Stock 
Tel: +49 271 7095-220 
Fax: +49 271 7095-4200 
E-Mail: apps@effexx.com

User:Sebastian.Lutz

2018-02-21T12:03:33Z

Sebastian.Lutz: Removing all content from page

Howto:Config size Limitations

2018-02-21T07:18:14Z

Sebastian.Lutz:

===Limitations===

There are various global restrictions in the config size:

* the total size of the config file (all that starts with "config change") must not exceed 29kB
* the total line length of a config file line must not exceed 20kB (for v11r2 and earlier versions the limit is 8kB).
* the number of words on a config line is limited

There are some special restrictions in the config size:
* No more than 32 alias entries are allowed on one Gatekeeper/Registrar interface.
* No more than 6 Hardware IDs on a PBX Object are possible.

So if there is a problem, you can try to use shorter aliases, leave out the e164 (redundant anyway) or split it into 2 GWx entries. Nevertheless, it is ugly.

Online Calculator of bytes on String - https://mothereff.in/byte-counter

RSS Feeds

2017-10-12T09:07:09Z

Sebastian.Lutz: /* Edited Feeds */

==Applies To==
This information applies to inno-wiki


==Feeds==

This wiki is one of the major communications channels from innovaphone to partners. Partners should thus stay up-to-date to with its content. However, monitoring a web site for updates can be quite time consuming. RSS feeds are a great way to do this. Here is how it works.

MediaWiki (upon which inno-wiki is built), features various [http://en.wikipedia.org/wiki/Rss RSS] feeds. A news feed can be thought of as a channel where new information is provided regularly and in a coordinated fashion. These pieces of information (commonly known as "articles") can be accessed by means of web browsers and/or external programs known as "feed readers" or "aggregators".

Both Firefox and Internet Explorer support the inno-wiki feeds.

In addition to that, there is a whole bunch of feed readers available, most are for free. One that we at innovaphone found particularly useful is [http://rsspopper.blogspot.com/2004/10/home.html RssPopper]. It retrieves feed articles and inserts them into Outlook or OutlookExpress email folders.

=== Automatic Feeds ===
inno-wiki supports a [[Special:WikiFeeds|powerful mechanism to customize RSS feeds]]. Sometimes, wiki itself will suggest a feed. Watch out for entries like "RSS | Atom" in the toolbox on the lower left. However, depending on the type of information you are interested in, you may want to try the following:

==== News ====
[http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/rss/recentcategorychanges/category/News '''<nowiki>http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/rss/recentcategorychanges/category/News</nowiki>''']

This feed shows mainly release announcements.

==== Problem Alerts ====
[http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/rss/recentcategorychanges/category/Problem '''<nowiki>http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/rss/recentcategorychanges/category/Problem</nowiki>''']

This feed includes information that you probably would like to have known before when you run into problems. You should really have it subscribed.

==== New Articles ====
[http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/newestarticles '''<nowiki>http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/newestarticles</nowiki>''']

All new articles, regardless of their type

==== Changed Articles ====
[http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/recentarticlechanges '''<nowiki>http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/recentarticlechanges</nowiki>''']

All updated articles, regardless of their type

==== Articles created by non-innovaphone users ====
[http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/newestforeignarticles '''<nowiki>http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/newestforeignarticles</nowiki>''']

==== Articles changed by non-innovaphone users ====
[http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/recentforeignarticles '''<nowiki>http://wiki.innovaphone.com/index.php?title=Special:WikiFeeds/atom/recentforeignarticles</nowiki>''']

=== Edited Feeds ===
[http://forum.innovaphone.com/moodle2/rss/file.php/342/1/forum/7287/rss.xml '''<nowiki>http://forum.innovaphone.com/moodle2/rss/file.php/342/1/forum/7287/rss.xml</nowiki>''']

In addition to the feeds listed above, which are created and maintained automatically by the innovaphone wiki, there is an edited feed. ''Edited'' here means that the entries are hand-crafted. The obvious drawback is that when you rely on this feed only, you may might miss some information - if we decide not to post it. The benefit of course is that all messages are filtered by a human which might result in a slightly more sensible choice of information posted (in particular, the ''Changed Articles'' feed noted above tends to send a lot of less useful information hiding the good parts). As of this writing (fall 2017), we post all noteworthy wiki updates to this edited channel.

This feed is also available as an old-style forum with (optional) mail subscription at [http://forum.innovaphone.com/moodle2/rss/file.php/342/1/forum/7287/rss.xml '''<nowiki>http://forum.innovaphone.com/moodle2/rss/file.php/342/1/forum/7287/rss.xml</nowiki>'''].

Finally, you can also follow the user <code>innovaphone_tec</code> on [https://twitter.com/innovaphone_tec twitter], which will receive the same information.

== inno-wiki Feed List as OPML ==
Many RSS feed readers can import ''OPML'' files that include lists of feeds to subscribe to. For your convenience, here is one (you need to unzip it first):
[[Media:innovaphone-wiki-feeds.zip|innovaphone-wiki-feeds.zip]]. For example, in [http://www.mozilla-europe.org/de/products/thunderbird/ Thunderbird], you would create an ''RSS Account'', then add ''Add subscription'' and ''Import'' the opml.

== The Roadmap ==
There is one article of utmost importance to many of you: the [[Support:DVL-Roadmap|development roadmap]]. If the information provided by our RSS feeds is too much to you, you may consider to ''[[Special:Watchlist|watch]]'' this specific article. This will make sure you get a reminder email with link whenever it changes. ''Watch''ing is available for any wiki article on the little top-right tab above the article text.

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

Reference12r1:Concept Netlogon Windows Authentication

2017-07-31T09:03:32Z

Sebastian.Lutz: /* Configuration */ fixed wiki syntax, and fix hidden Computer-Account-Name variable

[[Category:Concept|Netlogon and myPBX Windows Authentication]]
From version 12r1 users can use their windows password for logging-in to myPBX. myPBX uses NTLM over the netlogon protocol for verifying windows passwords against the Active Directory.

== Applies to ==
* innovaphone devices with a PBX from version 12r1.
* innovaphone myPBX for Windows 12r1 and later only

== How it works ==
=== Connection to the domain controller ===
The netlogon service of the PBX needs to connect to the DC. It authenticates using a computer account in the domain.
# DNS is used to retrieve the IP address of the DC (SRV record for ''_ldap._tcp.example.com'').
# The endpoint mapper on the DC is asked for the actual port of the netlogon server on the DC.
# A connetion is established to the netlogon server. For authentication the configured computer name and computer password is used.

=== Login with windows password in myPBX ===
The login process using windows credentials works in three steps.

[[Image:Netlogon_overview.png]]

;NTLM authentication:
First an NTLM handshake is done, involving the netlogon service on the PBX and the windows domain controller. NTLM is a challenge response mechanism. The web application calculates a hash value of the entered windows password and a challenge given by the PBX. The PBX asks the Windows server, that also knows the password, to verify the hash. In the end the PBX knows if the entered password was correct. Also the PBX and the web application have a shared secret, called the NTLM session key, that can be used for encryption.

;Temporary credentials:
The PBX creates temporary credentials for the myPBX login and stores them at the user object. After that it encrypts the credentials using the NTLM session key and sends them to the web application.

;Login:
For the actual login, myPBX uses the temporary credentials. When the user logs out the credentials are deleted both in the PBX and the Browser.

=== Characteristics ===
* The windows password is just used to calculate hashes. It is never stored or transmitted over the network.
* The temporary credentials are stored in the PBX at the user object and the DOM storage of the browser. So the user doesn't have to enter the windows password again, if the PBX or the browser is restarted.
* On logout the temporary credentials are deleted in the DOM Storage of the browser and in the PBX. So the next time the user is asked again for the windows password.

[[Image:Netlogon pbx sessions.png]]

== Requirements ==
;Windows domain:
* A computer account for the innovaphone device with a known password.
* User authentication using NTLM must be enabled.

;PBX:
* Firmware from version 12r1 or later.
* Working DNS configuration.
* The usernames (Name) of the user objects in the PBX must match the Windows usernames (samAccountName).
* Netlogon authentication must be enabled on the myPBX configuration page.

;Network:
* TCP connections from the PBX to the domain controller must be possible.
Please note that the ''Netlogon'' protocol is used between the PBX and the AD only (using the ''DCE endpoint mapper'' on TCP port 135 and another dyncamic TCP port). The NTLM information is conveyed between the PBX and the myPBX client with HTTPS as usual.

== Configuration ==
=== Create a computer account with known Password ===
* Solution 1: (too much hassle): Create a computer account manual in the windows domain and set a password using an appropriate tool.
::See [https://support.microsoft.com/en-us/kb/216393 Example], ''Sample 2''
* Solution 2: Create a computer account via CLI and set password:
::Use Powershell on Domain Controller to create Computer Account
::<code> New-ADComputer -Name "Computer-Account-Name" -AccountPassword (Read-Host -AsSecureString "AccountPassword")</code>
:::Prompt will ask for password
::Note: if the ''New-ADComputer'' command is not available, refer to [https://social.technet.microsoft.com/wiki/contents/articles/20623.step-by-step-upgrading-the-powershell-version-4-on-2008-r2.aspx Step by Step Upgrading the Powershell Version 4 on 2008 R2].
* Configure the netlogon service on the innovaphone device on page Services/Netlogon/Config.
* Activate netlogon authentication on page PBX/Config/myPBX.

== Usage ==
Depending on the configuration on page PBX/Config/myPBX users can use their PBX user password, their Windows password or both for myPBX login.

== Restrictions ==
* Only a single windows domain is supported.
* Currently NTLMv1 is used. Since NTLM hashes are not very secure, HTTPS should be used for the communication between myPBX and the PBX.
* The windows session is not reused for authentication in myPBX. The user has to enter the windows password in myPBX.

== Tracing and logging ==
The log gives basic information about up and downtime of the service and the NTLM handshakes that are done.
<pre>
LOG NETLOGON 0 Service up
LOG NETLOGON 0 Authentication for 'exampleuser' failed (error c0000064)
LOG NETLOGON 0 Service down
</pre>

The trace contains more detailed information for tracking down problems and all the exchanged protocol messages. The protocol messages have been removed in the following example for better readability.
<pre>
NETLOGON: state ABORT
NETLOGON: state RECONNECT
NETLOGON: starting Domain(example.com) Computer(PBX-NETLOGON) ComputerPassword(XXX)
NETLOGON: state DNS
NETLOGON.0 -> dns.0 : DNS_GETHOSTBYNAME example.com ctx=0x0 flags=0x1 port=0
dns.0 -> NETLOGON.0 : DNS_GETHOSTBYNAME_RESULT ctx=0x0 result=0 addr=10.0.05 port=389
NETLOGON: state EPM_CONNECT
NETLOGON: connect to endpoint mapper at 10.0.05:135 (dc-w2k8.example.com)
NETLOGON: state EPM_BIND_HEAD
NETLOGON: state EPM_BIND_BODY
NETLOGON: state EPM_MAP_HEAD
NETLOGON: state EPM_MAP_BODY ........
NETLOGON: state EPM_DISCONNECT
NETLOGON: state NETLOGON_CONNECT
NETLOGON: connect to netlogon_service at 10.0.05:49159 (dc-w2k8.example.com)
NETLOGON: state NETLOGON_BIND_HEAD
NETLOGON: state NETLOGON_CHALLENGE_HEAD
NETLOGON: state NETLOGON_CHALLENGE_BODY ....
NETLOGON: state NETLOGON_AUTHENTICATE_HEAD
NETLOGON: encryption parameters ClientChallenge(e5cb2fd5f5218531) ServerChallenge(7338e9e65867e383) SessionKey(0978a50b44003835ac420ae6e69dfa89)
NETLOGON: state NETLOGON_AUTHENTICATE_BODY
NETLOGON: state NETLOGON_ALTER_HEAD
NETLOGON: state NETLOGON_ALTER_BODY
NETLOGON: state NETLOGON_DUMMYROUTINE_HEAD
NETLOGON: state NETLOGON_DUMMYROUTINE_BODY
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM(0, exampleuser)
challenge: 86fee2c0fa1e6ee6
nt_response: 58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702
lm_response: 09e25853e618688157c0faadb0861818f367056548ea9496
NETLOGON: start authentication Username(exampleuser) Challenge(86fee2c0fa1e6ee6) NtResponse(58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702) LmResponse(09e25853e618688157c0faadb0861818f367056548ea9496)
NETLOGON: state AUTHENTICATE_HEAD
NETLOGON: state AUTHENTICATE_BODY d...
NETLOGON: authentication failed (error c0000064)
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON_SOCKET.44 : SOCKET_RECV(16)
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM_RESULT(0, FAILED, c0000064, )
</pre>

Reference11r1 talk:PBX/Config/Import

2017-05-26T06:29:37Z

Sebastian.Lutz: New page: --~~~~ Its true that you change the attribute "cn" to "n"? Changed in Revision 46842: http://wiki.innovaphone.com/index.php?title=Reference11r1%3APBX%2FConfig%2FImport&diff=46842&oldid=4...

--[[User:Sebastian.Lutz|Sebastian.Lutz]] 08:29, 26 May 2017 (CEST)

Its true that you change the attribute "cn" to "n"?

Changed in Revision 46842: http://wiki.innovaphone.com/index.php?title=Reference11r1%3APBX%2FConfig%2FImport&diff=46842&oldid=45862

----

User:Sebastian.Lutz

2017-05-10T12:49:31Z

Sebastian.Lutz:

Hey Dude :-}

Sebastian Lutz
lutz@oberberg.net

Oberberg-Online Informationssysteme GmbH
Technik - TK
Dr.-Ottmar-Kohler-Str. 1, 51643 Gummersbach
Tel.: +49-2261-9 15 50-0 Fax: +49-2261-9 15 50-99
http://www.oberberg.net
-----------------------------------------------------------------------
PGP-Key-ID: 0x0BBC7949
Fingerprint: 0B1F B7D3 2D6D 5125 A703 F2AE F75D FB12 0BBC 7949
-----------------------------------------------------------------------

User:Sebastian.Lutz

2017-05-10T12:48:12Z

Sebastian.Lutz:

Reference9:Interfaces/ETH/Link

2017-05-10T12:35:17Z

Sebastian.Lutz: /* Configuration */

The transmission mode of the Ethernet interface is defined here. On phones with a configurable switch the PC and the LAN port can be configured.

== Configuration ==
The auto transmission mode is pre-selected:
{|
|valign=top nowrap=true|'''auto:'''
| Automatic selection of the transmission speed.
|-
|valign=top nowrap=true|'''10m-hdx:'''
| Corresponds to 10 MBit Half Duplex.
|-
|valign=top nowrap=true|'''10m-fdx:'''
| Corresponds to 10 MBit Full Duplex.
|-
|valign=top nowrap=true|'''100m-hdx:'''
| Corresponds to 100 MBit Half Duplex.
|-
|valign=top nowrap=true|'''100m-fdx:'''
| Corresponds to 100 MBit Full Duplex.
|-
|valign=top nowrap=true|'''1000m-fdx:'''
| Corresponds to 1000 MBit Full Duplex.
|}

Phones starting with serial number from 00-90-33-03-08-68 having 10/100 MBit Ethernet.

Phones (old IP200/IP202) before this serial number are only with 10Mbit Ethernet

'''Disable link LED:''' On IP110, IP200A, IP230 and IP240 the link LED´s can be disabled

'''Isolate PC Link:''' see [[Support:DVL-Roadmap_Firmware_V9#phone:_prevent_the_pc_port_of_the_ethernet_switch_from_receiving_frames_directly_from_the_phone_firmware | Prevent the PC Port of the Ethernet Switch from receiving Frames directly from the Phone Firmware]]

'''Use Autoneg for all speeds:''' By default, auto-negotiation is not used when the port is set to anything but <code>auto</code>. However, when this check-mark is ticked, auto-negotiation is used in the other modes too, to report the desired setting to the remote switch. Thus reduces the risk of a port configuration mismatch (provided the remote switch port is set to use auto-negotiation). This option is not available on all models.

'''Allow 100M-LAN port and 1000M PC port:''' On IP241 IP222 and IP232 the link is renegotiated if one port runs at 100Mbit while the other port runs at 1000M to avoid buffer overruns in the switch. This mechanism can be disabled by setting "Allow 100M-LAN port and 1000M PC port". This settings prevents link changes e.g on the LAN link if the PC link is changing.

'''Disable Energy Efficient Ethernet (EEE)''' On IP241, IP111, IP112, IP222 and IP232 energy efficient ethernet is implemented. This feature can be disabled. On some PC´s the EEE link was not reliable, disabling EEE can solve the problem.

== Status ==
In addition, the status of the interface (''Up'' or ''Down'') and the Auto-negotiation used (for example, 100m-fdx) are displayed.

If on IP241 IP222 and IP232 one port runs at 100Mbit the other port should not use 1000M to avoid buffer overruns. In this case the 1000M port is reconfigured to 100M, the status display this.

On IP222 and IP232 EEE is implemented, the status shows if EEE is negotiated.

There is also a possibility of tracing with help of a special traceflag, which gives us information to the Link negotiation.

!config add ETH0 /ltrace
!config write
!reset

Afterwards you'll find the information in the buffer trace.

We suggest to activate this traceflag just for a testing purpose. To remove this traceflag you'll need this command:

!config rem ETH0 /ltrace
!config write
!config activate

== Special Features: Ethernet MDX and EEE ==
IP400, IP21 and IP3000 the Ethernet interface has a switch to configure the port to be connected to a hub/switch or terminal.

On gateways with 2 Ethernet interfaces ETH0 can be connected directly to a switch port, ETH1 can be connected directly to terminal. Other connections are possible if auto-MDX is supported in the switch or in the gateway or if a crossover cable is used.

IP-Phones have an Ethernet switch, form the firmware this is seen as a single Ethernet interface. Again, the first interface can be connected directly to a switch, the second directly to a terminal ( e.g. a PC ). IP-Phones based on the INCA-IP ( IP110..IP240) do not support Auto-MDX, newer IP-Phones and IP-Phones with GIGABit Ethernet support Auto-MDX.

On IP800 and IP6000 initially a Ethernet phy is used that supports Auto-MDX only if autoneg is enabled. Leadfree versions of that phy allowed no reliable Auto-MDX at all. On newer build the phy was replaced with a type that supports Auto-MDX in all modes.

For details see this table:

{|border=1
|+
|Product
|HWBuild
|MDX
|EEE
|-
|IP400
|
| no
| no
|-
|IP3000
|
| no
| no
|-
|IP21
|
| yes
| no
|-
|IP22 IP24 IP28 IP38 IP302 IP305
|
| no
| no
|-
|IP110 IP150 IP200 IP230 IP240
|
| no
| no
|-
|IP230-1000 IP240-1000
|
| yes
| no
|-
|IP241 IP222 IP232
|
| yes
| yes
|-
|-
|IP111 IP112
|
| yes
| yes
|-
|IP800
|..107
| if autoneg is enabled
| no
|-
|IP800
|108..299
| no
| no
|-
|IP800
|300..
| yes
| no
|-
|IP6000
|..199
| if autoneg is enabled
| no
|-
|IP6000 IP2000
|200..299
| no
| no
|-
|IP6000 IP2000
|300..
| yes
| no
|-
|IP6010, IP3010, IP0010, IP1060, IP810
|
| yes
| no
|-
|IP29 IP311 IP411 IP811 IP1130 IP3011 IP0011
|
| yes
| no
|}

Reference9:Interfaces/ETH/Link

2017-05-10T12:34:47Z

Sebastian.Lutz: /* Configuration */

The transmission mode of the Ethernet interface is defined here. On phones with a configurable switch the PC and the LAN port can be configured.

== Configuration ==
The auto transmission mode is pre-selected:
{|
|valign=top nowrap=true|'''auto:'''
| Automatic selection of the transmission speed.
|-
|valign=top nowrap=true|'''10m-hdx:'''
| Corresponds to 10 MBit Half Duplex.
|-
|valign=top nowrap=true|'''10m-fdx:'''
| Corresponds to 10 MBit Full Duplex.
|-
|valign=top nowrap=true|'''100m-hdx:'''
| Corresponds to 100 MBit Half Duplex.
|-
|valign=top nowrap=true|'''100m-fdx:'''
| Corresponds to 100 MBit Full Duplex.
|-
|valign=top nowrap=true|'''1000m-fdx:'''
| Corresponds to 1000 MBit Full Duplex.
|}

Phones starting with serial number from 00-90-33-03-08-68 having 10/100 MBit Ethernet.

Phones (old IP200/IP202) before this serial number are only with 10Mbit Ethernet

'''Disable link LED:''' On IP110, IP200A, IP230 and IP240 the link LED´s can be disabled

'''Isolate PC Link:''' see [[Support:DVL-Roadmap_Firmware_V9#phone:_prevent_the_pc_port_of_the_ethernet_switch_from_receiving_frames_directly_from_the_phone_firmware | Prevent the PC Port of the Ethernet Switch from receiving Frames directly from the Phone Firmware]]

'''Use Autoneg for all speeds:''' By default, auto-negotiation is not used when the port is set to anything but <code>auto</code>. However, when this check-mark is ticked, auto-negotiation is used in the other modes too, to report the desired setting to the remote switch. Thus reduces the risk of a port configuration mismatch (provided the remote switch port is set to use auto-negotiation). This option is not available on all models.

'''Allow 100M-LAN port and 1000M PC port:''' On IP241 IP222 and IP232 the link is renegotiated if one port runs at 100Mbit while the other port runs at 1000M to avoid buffer overruns in the switch. This mechanism can be disabled by setting "Allow 100M-LAN port and 1000M PC port". This settings prevents link changes e.g on the LAN link if the PC link is changing.

'''Disable Energy Efficient Ethernet (EEE)''' On IP241, IP222 and IP232 energy efficient ethernet is implemented. This feature can be disabled. On some PC´s the EEE link was not reliable, disabling EEE can solve the problem.

== Status ==
In addition, the status of the interface (''Up'' or ''Down'') and the Auto-negotiation used (for example, 100m-fdx) are displayed.

If on IP241 IP222 and IP232 one port runs at 100Mbit the other port should not use 1000M to avoid buffer overruns. In this case the 1000M port is reconfigured to 100M, the status display this.

On IP222 and IP232 EEE is implemented, the status shows if EEE is negotiated.

There is also a possibility of tracing with help of a special traceflag, which gives us information to the Link negotiation.

!config add ETH0 /ltrace
!config write
!reset

Afterwards you'll find the information in the buffer trace.

We suggest to activate this traceflag just for a testing purpose. To remove this traceflag you'll need this command:

!config rem ETH0 /ltrace
!config write
!config activate

== Special Features: Ethernet MDX and EEE ==
IP400, IP21 and IP3000 the Ethernet interface has a switch to configure the port to be connected to a hub/switch or terminal.

On gateways with 2 Ethernet interfaces ETH0 can be connected directly to a switch port, ETH1 can be connected directly to terminal. Other connections are possible if auto-MDX is supported in the switch or in the gateway or if a crossover cable is used.

IP-Phones have an Ethernet switch, form the firmware this is seen as a single Ethernet interface. Again, the first interface can be connected directly to a switch, the second directly to a terminal ( e.g. a PC ). IP-Phones based on the INCA-IP ( IP110..IP240) do not support Auto-MDX, newer IP-Phones and IP-Phones with GIGABit Ethernet support Auto-MDX.

On IP800 and IP6000 initially a Ethernet phy is used that supports Auto-MDX only if autoneg is enabled. Leadfree versions of that phy allowed no reliable Auto-MDX at all. On newer build the phy was replaced with a type that supports Auto-MDX in all modes.

For details see this table:

{|border=1
|+
|Product
|HWBuild
|MDX
|EEE
|-
|IP400
|
| no
| no
|-
|IP3000
|
| no
| no
|-
|IP21
|
| yes
| no
|-
|IP22 IP24 IP28 IP38 IP302 IP305
|
| no
| no
|-
|IP110 IP150 IP200 IP230 IP240
|
| no
| no
|-
|IP230-1000 IP240-1000
|
| yes
| no
|-
|IP241 IP222 IP232
|
| yes
| yes
|-
|-
|IP111 IP112
|
| yes
| yes
|-
|IP800
|..107
| if autoneg is enabled
| no
|-
|IP800
|108..299
| no
| no
|-
|IP800
|300..
| yes
| no
|-
|IP6000
|..199
| if autoneg is enabled
| no
|-
|IP6000 IP2000
|200..299
| no
| no
|-
|IP6000 IP2000
|300..
| yes
| no
|-
|IP6010, IP3010, IP0010, IP1060, IP810
|
| yes
| no
|-
|IP29 IP311 IP411 IP811 IP1130 IP3011 IP0011
|
| yes
| no
|}

Reference12r1:PBX/Config/General

2017-04-11T09:52:12Z

Sebastian.Lutz: /* Common */

The fundamental operating modes of the PBX are configured on this page.

== Configuration ==

=== Common ===

;PBX Mode: The PBX operating mode
:* '''Off''' - The PBX is disabled. After enabling the PBX a browser refresh is needed to activate additional PBX webpages.
:* '''Master''' - The PBX on this device acts as Master. Within a multisite installation exactly one PBX must be configured as Master.
:* '''Slave''' - The PBX on this device acts as Slave. Within a multisite installation several PBXes can be configured as Slave.
:* '''Standby''' - The PBX on this device acts as Standby for the Master. As long as the master is available, this PBX is not active, but just monitors the Master. If the Master is not available this PBX is active.
:* '''Standby-Slave''' - The PBX on this device acts as Standby for a Slave. As long as the slave is available, this PBX is not active, but just monitors the slave. If the slave is not available this PBX is active.

;System Name: The system Name. On all PBX within a multisite installation the same System Name must be configured. For H.323 endpoints this name is the gatekeeper identifier, for SIP endpoints it is the server name.

;Use as Domain: Uses the ''System Name'' as domain name, together with the name field in the user object the PBX constructs the email address (used for sending emails out ox myPBX). This mechanism is also used for Federation, to federate with other domains.

;PBX Name: The name of the PBX on this device. With this name a PBX is associated to a node. The field 'Name' (not Long Name) of a PBX Node object relates to this name.

;DNS: DNS Name of the PBX. If configured this will be used for myPBX redirects if a client tries to register at a PBX on which the user is not configured.

;Unknown Registrations: If this checkmark is set, the PBX accepts 'unknown' registrations. This means registrations with no matching object configured. If from an endpoint registered in this way a number of an object is dialed, which has no registration active and no 'HW-ID' configured the name used for the registration is configured as 'HW-ID' of this object. This is an easy way to deploy large numbers of phones.

:'''With PBX Pwd only:''' If checked only registrations with a PBX authentication or a verfiied certificate in case of H.323/TLS are accepted. In this case either "PBX Pwd" or "TLS only" is set in a device generated.

;Reverse Proxy Addresses: Up to 8 addresses (no DNS names allowed) can be entered in this field, seperated by comma. Registrations from one of these addresses are assumed to be routed thru a Reverse Proxy.
: '''Assume TLS''': If the ''Assume TLS'' checkmark is set, it is assumed, that the reverse Proxy did a successful check of the TLS certificate against the registration name.

;Music On Hold URL: A URL for the Music On Hold. This file is read by the PBX using HTTP and sent to a held endpoint via RTP. The format of this URL is

:'''<nowiki>http://<addr>/<file>.$coder?coder=opus-wb,g722,g711a,g711u,g729,g723&repeat=true</nowiki>'''. <addr> is the IP address of the http server, no dns name is allowed here. <file> is the filename. $coder will be replaced by the actual coder used.

:Parameters: ''coder=opus-wb,g722,g711a,g711u,g729,g723'' is the list of available coders. Only these coders must be specified for which a corresponding file exists. ''repeat=true'' should be specified in order to loop the file endlessly. ''random=true'' can be used to start the music on hold on a random point (this will work only if the URL is not local though).

:By default the built-in Music-On-Hold is played (Pseudo URL: "MOH?coder=g729,g711a,g723&repeat=true"). You can also play a dial tone (Pseudo URL "TONE") or a ring-back tone (Pseudo URL "TONE?tone=ringback").

:If you configure a wrong (or invalid) URL then you will have silence as MOH. To prevent this situation when the MoH for some specific context/user(see below) is missing and silence is played instead of any MoH, an additional parameter ''fallback=true'' is available. If the file provided in the URL is missing (HTTP Error 404 Not Found is delivered by the HTTP Server) and the parameter ''fallback'' is provided, the default MoH will be played instead of silence. To use a custom file as fallback MoH, instead of default MoH, any file name can be provided with the ''fallback'' parameter: e.g. ''fallback=other_filename''. The file other_filename.g7xx must be placed in the same folder as a file provided with URL. A special filename ''fallback=ringback'' can be used to generate a ringback tone (equivalent to ''TONE?tone=ringback'') instead to play an alternative file.

:Within the URL %<id> can be used to put in some context information of the call. The information refers to the party which has put the receiving party on hold. For information about the receiving party itself, the id has to be preceded by '.' (e.g. '''.l''').

:'''l''' Long Name
:'''h''' Name (H.323 id)
:'''n''' Number
:'''N''' Node
:'''P''' PBX
:'''d''' Diverting Name
:'''#d''' Diverting Number

;External Music On Hold: To offload the device from playing the Music on hold, the Music On Hold can be played by a separate device. This device can register with a name configured here. To retrieve the Music On Hold a call is sent to this device. For each held endpoint a call is sent.

;Response Timeout: Global timeout (in seconds) after which any action for no response is taken (e.g. Call Forward on No Response). A timeout configured at any object overrides this value.

;Dial Complete Timeout: Global timeout (in seconds) after which any action for incomplete dialed number is taken (e.g. incomplete destination at trunk object).

;No. of Regs w/o Pwd: Number of registration without password authentication which are allowed per user. If 0 is configured no registration without password is possible.
Pls. note that registrations from 127.0.0.1 w/o password will be accepted anyway

;Recall Timeout: A value configured here enables recall after transfer. If a call is transferred and not answered within this time, the call is sent back to the transferring endpoint.

;Max Call Duration (h): Number of hours until a call with media is disconnected automatically. Affects all calls with initialized media channels signalled via PBX.

;Max WebRTC calls: Sets the max. amount of concurrent WebRTC calls. ''Usage: x (max y)'' The counters ''x'' and ''y'' show the current amount of WebRTC calls respectively the max. amount of concurrent calls, measured since the last reboot of the PBX.

;Group Default Visibility: Allows to restrict default visibility to active group members. If changed active subscriptions are not affected. Is used to prevent standard users from getting access to sensitive information like activities/presences of group members in myPBX. If not generally allowed by the administrator via this setting, normal users are not able to change it via myPBX.

;Pickup Prefix V7: In V7, the pickup prefix is obsolete. Please use the pbx object [[:Reference7:Administration/PBX/Objects/DTMF Features|DTMF Featurecodes]].

;Presence with Alert: Enable presentation of presence on phone upon alert. Setting applies for all PBX users. Alternatively, display of presence subject only delivered by Exchange can be prohibited - see [[Reference10:Concept_Exchange_Calendar_Connector#Exchange|Exchange Calendar Connector : Omit Subject]]

;Enable External Transfer: Unless this checkbox is set any attempt to transfer an external call back to an external destination will result in disconnection of the call.

;No CLIR on Internal calls: If checked numbers are displayed even if received with presentation restricted. When sending a call presentation restricted can still be set and should be honored by a public network.

;Media Relay:
:;Off: No Media Relay is done in the PBX
:;On: All media traffic is routed thru the PBX. Check this only if you need to have this, since it creates CPU load on the PBX. With the '''Except Addresses are identical or private''' checkmark, the RTP proxy can be restricted. This is useful in the case endpoints are registered, which are located in private network and for calls within the same private network no RTP proxy shall be done. To identify an address as private the "Private Networks" configuration from IP4/General/Settings is used. '''Video is not working when this setting is activated'''.
:;Auto: Media Relay is performed if calls are between private an public registration addresses, based on the configuration for private addresses under IP4/General/Settings. In v11 this was the default. With ICE this mechanism should be obsolete except for special applications.

;Generate CDRs: If this checkbox is set, the PBX generates CDRs for all calls. See [[Reference9:Concept_Call_Detail_Record_CDR_PBX]] for a description of the CDRs.

;Route Root-Node External Calls to: Destination object (Long Name) of Root-Node external calls. This configuration option is available on the Master or Standby PBX only. Any call call which cannot be terminated inside the PBX is sent to this destination as long as neither the source nor the destination of the call can be associated with a node with a PBX configured. This object must be assigned to this PBX.
:'''For calls from local PBX only''': If set on a master, calls from a slave are not sent to this destination but sent back to the slave where the call came from. On the slave the call is then sent to a destination configured with 'Route Root-Node External Calls to'.

;Route PBX-Node External Calls to: Destination object (Long Name) of PBX-Node external calls. Any call which cannot be terminated inside the PBX is sent to this destination as long as the source nor the destination of the call can be associated with the node of this PBX. If a call is sent from or to an object defined inside the node of this PBX or in a node hierarchically below the node of this PBX the call is associated to the node of this PBX. This object must be assigned to this PBX, that is, it has to register to this PBX.

;Route Internal Calls to: Destination object (Long Name) to which any call is sent for which a PBX internal destination was found, except for those calls that originated from that object. This can be used to apply special routing on PBX internal calls.

;Escape Dialtone from: The PBX object (Long Name) to which a call is made to get a dialtone if a dialtone is configured for the escape of a node. As above, this object must be assigned to this PBX.

;Prefix for Intl/Ntl/Subscriber: Prefixes to be used to map International, National and Subscriber numbers.
:* '''International Prefix''' (<code>000</code> in Germany).
:* '''National Prefix''' (<code>00</code> in Germany).
:* '''Subscriber Numbers''' (in Germany, <code>0</code> is a commonly used trunk line access code).

;Tones: The tones scheme to be used for PBX generated dialtones. This applies to dialtones generated for node prefixes, ringback on transfer and some more.

=== Slave PBX ===

If the PBX is operated in Slave mode, then the Slave PBX section is displayed

;Registration: The VOIP protocol used for the registration to the master. Possible choices are H.323, H.323/TCP or H.323/TLS.

;Master: The IP address of the PBX master

;License Only: If set, the PBX obtains license from master, but acts as master in all other respects.

;Alternate Master: The IP address of an alternative PBX master (standby, if available)

;Password: The password to be used for registration at the Master as configured in the corresponding PBX Object

;Master GK-ID: The System Name/Gatekeeper ID of the PBX Master were will register (Optional, usually used for DynPBX).

;Replication: This parameter allows you to select the replication style for the slave PBX: either ''All'' or ''Local'' (only users that need to be known in this PBX).

;dyn PBX ID: This parameter allows to set replication from a specific DynPBX configured on the Master Device.

;Use local static User DB: A dynPBX has also this checkmark. The database of the main PBX is used, but be careful due to the increased memory usage. The dynPBX will create its own PBX datastructure which allocates memory.

;Route Master calls if no Master to: If the master is not available, master calls are sent to this destination

;Max Calls to Master/No Reroute: This parameter can be used to limit the calls to the master. If a call is sent to the master and there are already calls to/from the master equal to or exceeding this value, the call is rejected if '''No Reroute''' is set or is handled as if the master was not available otherwise.

;License Limits: Here we can set limit of licensing for this Slave PBX for Port, Mobility, Operator and Softwarephone.

For complete replication from master to slave, check also password in [[Reference9:Administration/PBX/Security]]

=== Standby PBX ===

If the PBX is operated in Standby mode, then the Standby PBX section is displayed

;Master: The IP address of the PBX master

;Replicate from Master: Turns on full replication from the master PBX

;use TLS: Use LDAPS (TLS) instead of LDAP (TCP).

For complete replication from master to standby, check also password in [[Reference9:Administration/PBX/Security]]

== License Status ==

=== Licenses ===

A list of all installed PBX license with their current usage is displayed here.

;Count: The total number of installed licenses of this type.

;Usage: The total usage of this license type

;Local: The usage of this license on this PBX

;Slaves: The usage of this license on PBX's registered to this PBX.

see [[Reference10:Licenses]] for a description of the licenses.

=== Registrations ===

The current number of registrations and the limit as defined by the base license is displayed here. Because this limit is defined by the base license it includes any registrations because of standby as well, which require no registration license.

Reference11r1:Concept myPBX Video

2017-04-10T07:31:52Z

Sebastian.Lutz: Undo revision 46385 by Special:Contributions/Mario.moser (User talk:Mario.moser)

[[Category:Concept|myPBX Video]]
From version 10 the myPBX launcher can add a video codec to innovaphone hardware and software phones.

== How it works ==
* myPBX video adds an H.264 video codec to innovaphone hardware and software phones.
* The video codec is part of the myPBX launcher and uses the webcam, windows for H.264 encoding and graphic card of the computer for H.264 decoding. If the graphic does not support H.264, which would be uncommon, windows will be used for the decoding process. Windows is not used by default because its decoder introduces a long delay (1-2 sec.), unacceptable for a video call. This delay is not present in Windows 8.

* Default resolution is 352x288
** myPBX checks the resolution supported by the webcam. If available, 352x288 is used. Otherwise, 320x240
** likewise is done for the frame rate: if available, 30 fps is used, if not 15 fps
* The windows h264 encoder is configured to deliver an average data rate of 250 kbps.
* The video codec communicates with the phone using SOAP over Websocket. Once it is connected the phone negotiates video calls.
* The endpoint for video streams is the video codec on the computer. The endpoint for audio streams is still the audio codec on the phone.

[[Image:MyPBX video.png]]

== Requirements ==
=== PBX ===
* Recent firmware (v11 or higher)
* myPBX license (enabled at the user object)
* Video license (enabled at the user object)

Note: The video license information must be available in the PBX at the time of the registration of the phone.

=== Phone ===
* innovaphone hardware phone with recent firmware (v11 or higher) (not for DECT phones like IP61, IP62, IP63)
* innovaphone software phone (v11 or higher)

=== Computer ===
* myPBX launcher (v11 or higher)
* Windows 7
* .NET 4
* Graphics card with H.264 hardware support (otherwise video will be shown with delay)
* Webcam.

The video codec uses UDP ports starting from 50000.

== Configuration ==
In the following, it is assumed that the user already has a phone configured and myPBX running.
=== PBX ===
* Enable the video license on the user object.
=== Launcher ===
* Enable video telephony
* Configure a default call type (e.g. Audio-video)
* If needed, configure a proxy server for connecting to the phone. Otherwise leave the field empty.

[[Image:MyPBX video config.png]]

== Usage ==

=== Activation ===
If the launcher is connected to the selected phone, a camera button shows up in the web application next to the selected phone.

[[Image:MyPBX video activation.png]]

Clicking the button activates or deactivates video. When the call is terminated, the button is reset to the default setting, given by the default call type configured in the launcher.

From version 11 media escalation and one-way video is supported. That means that the user can add and remove video during a phone call. Adding video only activates sending the own video image. Deactivating video deactivates both directions.

=== Video telephony ===
When there is a video call, the launcher activates the webcam of the PC and opens a window showing your own image and the image of the remote party. If you hang up the window is closed and the webcam is deactivated.

[[Image:myPBX_video_window.png]]

=== Three-party video conference ===
myPBX supports three-party video conferences without an external MCU. The mixing of video streams is done at the computer starting the conference. Since the video rate is not very high and the maximum resolution used by myPBX is 352x288 any computer should handle this operation properly.

[[Image:myPBX_video_window_3pty.png]]

== Troubleshooting ==
=== Check list ===
If video doesn't work please check the following for both the caller and the callee.
* The user has an activated video or UC license.
* Only one myPBX instance is running for the user.
* Only one phone is registered to the selected device of the user.
* Video and application sharing is activated in the configuration of the myPBX launcher.
* The right phone is selected in myPBX.

Also check the myPBX trace for error messages.

=== Error messages in the myPBX trace ===
Here are some hints what might be the reason for error messages that occur in the myPBX trace.

RemoteMediaConnection(video): Connection failed (websocket error CouldNotDetermineLocalAddress)
RemoteVideoCodec: RemoteMediaChannel failed (invalid local address)

Is the websocket connection blocked by an anti-virus software or a personal firewall? Try deactivating it for a test. Configure exceptions/permissions for myPBX, if needed.

RemoteMediaConnection(video): Connection failed (websocket error AuthenticationFailed)

Is another instance of myPBX launcher connected to that phone? Only one instance is allowed at a time.

RemoteMediaConnection(video): ConnectFailed (No registration at device XYZ)

No phone is registered to the selected device. Register a phone or select a different device in myPBX.

RemoteMediaConnection(video): ConnectFailed (Not supported or unlicensed on device XYZ)

The selected phone does not support remote video. Old firmware? Third-party product? No video license? Video license not activated at the user object?

== Known issues ==

=== Media relay disables Video===
myPBX Video-Calls does not work if at PBX "Media Relay" is set to ON or it is set to AUTO and media-relay is selected.

=== Antivirus ===
Some antivirus are blocking websocket connection and therefore it is necessary to add an exception for myPBX application. If you are having this problem myPBX gets the loopback address as local address. You should see '''local address 127.0.0.1''' in myPBX trace log. 
* Avast! you should add myPBX under "Web Shield/Expert Settings/Exclusions/Processes to exclude"
* Kapsersky-Antivirus. You should add myPBX under "Einstellungen/Vertrauenswürdige Zone/Vertrauenswürdige Anwendungen/ hinzufügen"

=== Integrated Webcam in Dell Vostro Laptops ===
MyPbx/Pc crashes when using the integrated webcam. External ones are ok. 
* The problem at our side was caused by the software '''Dell Webcam Central''', apparently installed by default in this laptop model. Please uninstall this software if you encounter any problem with the integrated webcam. 

=== Webcam support under Media Foundation from Microsoft ===
According to Microsoft ( http://msdn.microsoft.com/en-us/library/windows/desktop/bb970511(v=vs.85).aspx ) only webcams that support UVC1.1 (USB Video Class) will work under Media Foundation.

So far we only found problems with a Wireless Webcam from Logilink/Technaxx.

http://www.logilink.eu/showproduct/UA0098.htm

=== Interoperability ===
Third party video phones must be registered using SIP. Video is not supported for non-innovaphone devices that are registered using H.323.

=== Microsoft Update for the Windows 7 h264 decoder ===
The video card is used for h264 decoding because the Windows h264 decoder in Windows 7 introduces a delay of about 1 sec. 
Microsoft released in February a platform update for Windows 7 which includes a fix for this issue. 
http://support.microsoft.com/kb/2670838/en-us 
In this document it is mentioned that the update "improves the features and performance of the following components" and one of them is the "H.264 Video Decoder". 
The only problem is that there maybe some incompatibilities with some systems. So please, read the document carefully before installing it. 
This update would only be necessary for those whose video card does not support h264 decoding and therefore experience the delay in the incoming video stream. 

=== CISCO Adaptive Security Appliance ===
Enabled IP-Compression (ip-comp) can cause problems related to video transmission. If you don't have remote users which connected with modem, this feature can be normaly disabled.

Reference12r1:Concept myPBX for iOS

2017-04-07T08:41:11Z

Sebastian.Lutz: add H323 domain

[[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 [[Reference12r1: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>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>mod cmd UP1 poll</nowiki>
Results in the following prepared link
<nowiki>com.innovaphone.commands: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>mod cmd UP1 poll</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 that the command
<nowiki>config change MAIN /deny-uri-commands 1</nowiki>
prevents further provisioning commands via this mechanism.

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

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

== Known issues ==
As of v12r1/v12r2, myPBX for iOS does not support iOS ''push notifications''. As a result it may (for example, if you change networks) loose registration to the PBX when it goes in to background mode for a longer period and it will then not be able to recover unless it is brought back to foreground mode again.

If you must make sure that myPBX for iOS is reachable all the time, best make sure it is not running in background.

Reference12r1:Concept myPBX for iOS

2017-04-07T08:39:04Z

Sebastian.Lutz: fix proto

[[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 [[Reference12r1: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>config change PHONE SIG /h323 user /prot SH323 /gk-addr thepbx.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>mod cmd UP1 poll</nowiki>
Results in the following prepared link
<nowiki>com.innovaphone.commands:config change PHONE SIG /h323 user /prot+SH323 /gk-addr thepbx.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>mod cmd UP1 poll</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 that the command
<nowiki>config change MAIN /deny-uri-commands 1</nowiki>
prevents further provisioning commands via this mechanism.

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

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

== Known issues ==
As of v12r1/v12r2, myPBX for iOS does not support iOS ''push notifications''. As a result it may (for example, if you change networks) loose registration to the PBX when it goes in to background mode for a longer period and it will then not be able to recover unless it is brought back to foreground mode again.

If you must make sure that myPBX for iOS is reachable all the time, best make sure it is not running in background.

Reference12r1:Concept Netlogon Windows Authentication

2016-08-12T09:23:44Z

Sebastian.Lutz: /* Configuration */

[[Category:Concept|Netlogon and myPBX Windows Authentication]]
In version 12r1 users can use their windows password for logging-in to myPBX. myPBX uses NTLM over the netlogon protocol for verifying windows passwords against the Active Directory.

== Applies to ==
* innovaphone devices with a PBX from version 12r1.

== How it works ==
=== Connection to the domain controller ===
The netlogon service of the PBX needs to connect to the DC. It authenticates using a computer account in the domain.
# DNS is used to retrieve the IP address of the DC (SRV record for ''_ldap._tcp.example.com'').
# The endpoint mapper on the DC is asked for the actual port of the netlogon server on the DC.
# A connetion is established to the netlogon server. For authentication the configured computer name and computer password is used.

=== Login with windows password in myPBX ===
The login process using windows credentials works in three steps.

[[Image:Netlogon_overview.png]]

;NTLM authentication:
First an NTLM handshake is done, involving the netlogon service on the PBX and the windows domain controller. NTLM is a challenge response mechanism. The web application calculates a hash value of the entered windows password and a challenge given by the PBX. The PBX asks the Windows server, that also knows the password, to verify the hash. In the end the PBX knows if the entered password was correct. Also the PBX and the web application have a shared secret, called the NTLM session key, that can be used for encryption.

;Temporary credentials:
The PBX creates temporary credentials for the myPBX login and stores them at the user object. After that it encrypts the credentials using the NTLM session key and sends them to the web application.

;Login:
For the actual login, myPBX uses the temporary credentials. When the user logs out the credentials are deleted both in the PBX and the Browser.

=== Characteristics ===
* The windows password is just used to calculate hashes. It is never stored or transmitted over the network.
* The temporary credentials are stored in the PBX at the user object and the DOM storage of the browser. So the user doesn't have to enter the windows password again, if the PBX or the browser is restarted.
* On logout the temporary credentials are deleted in the DOM Storage of the browser and in the PBX. So the next time the user is asked again for the windows password.

[[Image:Netlogon pbx sessions.png]]

== Requirements ==
;Windows domain:
* A computer account for the innovaphone device with a known password.
* User authentication using NTLM must be enabled.

;PBX:
* Firmware from version 12r1.
* Working DNS configuration.
* The usernames (Name) of the user objects in the PBX must match the Windows usernames (samAccountName).
* Netlogon authentication must be enabled on the myPBX configuration page.

;Network:
* TCP connections from the PBX to the domain controller must be possible.

== Configuration ==
* Create a computer account with known password
** Solution 1: (to much hassle): Create a computer account manual in the windows domain and set a password using an appropriate tool.
*** (Example at[https://support.microsoft.com/en-us/kb/216393] Sample 2
** Solution 2: Create a computer account via CLI and set password:
*** Use Powershell on Domain Controller to create Computer Account
*** New-ADComputer -Name <Computer-Account-Name> -AccountPassword (Read-Host -AsSecureString "AccountPassword")
**** Prompt will ask for password
* Configure the netlogon service on the innovaphone device on page Services/Netlogon/Config.
* Activate netlogon authentication on page PBX/Config/myPBX.

== Usage ==
Depending on the configuration on page PBX/Config/myPBX users can use their PBX user password, their Windows password or both for myPBX login.

== Restrictions ==
* Only a single windows domain is supported.
* Since NTLM hashes are not very secure, HTTPS should be used for the communication between myPBX and the PBX.
* The windows session is not reused for authentication in myPBX. The user has to enter the windows password in myPBX.

== Tracing and logging ==
The log gives basic information about up and downtime of the service and the NTLM handshakes that are done.
<pre>
LOG NETLOGON 0 Service up
LOG NETLOGON 0 Authentication for 'exampleuser' failed (error c0000064)
LOG NETLOGON 0 Service down
</pre>

The trace contains more detailed information for tracking down problems and all the exchanged protocol messages. The protocol messages have been removed in the following example for better readability.
<pre>
NETLOGON: state ABORT
NETLOGON: state RECONNECT
NETLOGON: starting Domain(example.com) Computer(PBX-NETLOGON) ComputerPassword(XXX)
NETLOGON: state DNS
NETLOGON.0 -> dns.0 : DNS_GETHOSTBYNAME example.com ctx=0x0 flags=0x1 port=0
dns.0 -> NETLOGON.0 : DNS_GETHOSTBYNAME_RESULT ctx=0x0 result=0 addr=10.0.05 port=389
NETLOGON: state EPM_CONNECT
NETLOGON: connect to endpoint mapper at 10.0.05:135 (dc-w2k8.example.com)
NETLOGON: state EPM_BIND_HEAD
NETLOGON: state EPM_BIND_BODY
NETLOGON: state EPM_MAP_HEAD
NETLOGON: state EPM_MAP_BODY ........
NETLOGON: state EPM_DISCONNECT
NETLOGON: state NETLOGON_CONNECT
NETLOGON: connect to netlogon_service at 10.0.05:49159 (dc-w2k8.example.com)
NETLOGON: state NETLOGON_BIND_HEAD
NETLOGON: state NETLOGON_CHALLENGE_HEAD
NETLOGON: state NETLOGON_CHALLENGE_BODY ....
NETLOGON: state NETLOGON_AUTHENTICATE_HEAD
NETLOGON: encryption parameters ClientChallenge(e5cb2fd5f5218531) ServerChallenge(7338e9e65867e383) SessionKey(0978a50b44003835ac420ae6e69dfa89)
NETLOGON: state NETLOGON_AUTHENTICATE_BODY
NETLOGON: state NETLOGON_ALTER_HEAD
NETLOGON: state NETLOGON_ALTER_BODY
NETLOGON: state NETLOGON_DUMMYROUTINE_HEAD
NETLOGON: state NETLOGON_DUMMYROUTINE_BODY
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM(0, exampleuser)
challenge: 86fee2c0fa1e6ee6
nt_response: 58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702
lm_response: 09e25853e618688157c0faadb0861818f367056548ea9496
NETLOGON: start authentication Username(exampleuser) Challenge(86fee2c0fa1e6ee6) NtResponse(58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702) LmResponse(09e25853e618688157c0faadb0861818f367056548ea9496)
NETLOGON: state AUTHENTICATE_HEAD
NETLOGON: state AUTHENTICATE_BODY d...
NETLOGON: authentication failed (error c0000064)
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON_SOCKET.44 : SOCKET_RECV(16)
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM_RESULT(0, FAILED, c0000064, )
</pre>

Reference12r1:Concept myPBX Toolbox

2016-04-20T12:19:25Z

Sebastian.Lutz: /* Example */

[[Category:Concept|myPBX WebRTC Softwarephone]]
The myPBX toolbox is a set of Java Script files that can be used for integrating functionality of the innovaphone PBX into arbitrary web sites.

= Supported features =
* Presence monitoring
* Outgoing WebRTC calls with audio, video and application sharing

= Requirements =
;Web site:
* The needed JavaScript files of the libraries have to be included in the web site.
;PBX:
* User object with password for login and a WebRTC device
* Call filters for that user object
* Valid STUN/TURN configuration
;Licenses:
* myPBX license
* Video license (for video telephony)
* Application Sharing license (for viewing shared applications)
* WebRTC channel license (per WebRTC call)
;Network:
* The PBX service (<code>https://xxx/PBX0/WEBSOCKET</code>) must be accessible from the public internet (NAT port forwarding or reverse proxy).

= Authentication =
For connecting the credentials of a PBX user account is needed. The credentials can be hard coded in the Java Script code (not recommended) or they can be stored on the web server that hosts the application (recommended).

A typical flow for the second method would be like follows.
# The PBX chooses the server parameters (realm, sessionId, serverNonce) and sends it to the Application
# The callback onAuthenticate(realm, sessionId, serverNonce) is called.
# The Application sends the parameters to the web server.
# The Webserver chooses the client parameters (username, clientNonce) and calculated the login digest and sends it back to the application.
# The application calls the setAuthentication(username, clientNonce, digest) function.
# The PBX accepts the login.

= Reference =
== innovaphone.pbxwebsocket.Connection ==
=== Includes ===
The following files have to be included in the html file in order to use the WebRTC endpoint.
* <code>innovaphone.common.crypto.js</code>
* <code>innovaphone.pbxwebsocket.Connection.js</code>

=== Constructor ===
;new Connection(url, username, password):
:;url: The URL of the PBX websocket service (e.g. <code>wss://xxx/PBX0/WEBSOCKET/websocket</code>)
:;username: The username of the PBX user object.
:;password: The password of the PBX user object.

=== Methods ===
;function close(): Disconnects from the PBX.
;function setAuthentication(username, clientNonce, digest): Sets the client parameters of the authentication and the calculated digest.
:;username: The H323 id of the user object
:;clientNonce: A random number
:;digest: sha256("innovaphonePbxWebsocket:ClientAuth:" + realm + ":" + sessionId + ":" + username + ":" + password + ":" + clientNonce + ":" + serverNonce)
;function sendSubscribeEndpoint(name, number): Starts presence monitoring for a given endpoint specifyed by name ''or'' number.
:;name: The URI or H.323 id
:;number: The phone number
;function sendUnsubscribeEndpoint(name, number): Stops presence monitoring for a given endpoint specifyed by name ''or'' number.
:;name: The URI or H.323 id
:;number: The phone number

The methods for WebRTC calls are not described here. Use innovaphone.pbxwebsocket.WebRtcEndpoint.js instead.

=== Callbacks ===
;function onauthenticate(realm, sessionId, serverNonce): This callback is used for authenting users when the web page shall not be aware of the user password. Set connection.onauthenticate to get a callback during login process. The login hash can then be calculated on the webserver and be given back using function setAuthentication.

;function onconnected(userInfo): Called when the connection has been successfully established.
:;userInfo: An object containing informmation about the connected user.

;function onerror(error): Called when the connection could not be established or an other error occurred.
:;error: A string containing an error message.
;onclosed(): Called if the connection was closed.

;function onendpointpresence(name, number, phoneStatus, imStatus, activity, note): Called if the presence of a subscribed endpoint has changed.
:;name: The URI or H.323 id
:;number: The phone number
:;phoneStatus: Tells if a phone is registered, <code>open</code> or <code>closed</code>.
:;imStatus: Tells if a chat client is registered, <code>open</code> or <code>closed</code>.
:;activity: Presence activity <code>away</code>, <code>busy</code>, <code>lunch</code>, <code>vacation</code>, <code>busy</code>, <code>dnd</code>, <code>on-the-phone</code>
:;note: Presence note

The callbacks for WebRTC calls are not described here. Use innovaphone.pbxwebsocket.WebRtcEndpoint.js instead.

=== Example ===
The following example connects to the PBX and does presence monitoring for the user with the H.323 ID "target".

<script type="text/javascript" src="innovaphone.common.crypto.js"></script>
<script type="text/javascript" src="innovaphone.pbxwebsocket.Connection.js"></script>
<script type="text/javascript">

// dependencies
var Connection = innovaphone.pbxwebsocket.Connection;

// private
var connection = null;
var config = {
url: "ws://192.168.0.1/PBX0/WEBSOCKET/websocket",
username: "user",
password: "password"
};

// callbacks
function onConnected(userInfo) {
console.log("Connected: " + JSON.stringify(userInfo));
connection.sendSubscribeEndpoint("target", null);
}

function onError(error) {
console.log("Error: " + error);
}

function onClosed() {
console.log("Closed");
}

function close() {
if (connection) connection.close();
connection = null;
}

function onEndpointPresence(name, number, phoneStatus, imStatus, activity, note) {
console.log("EndpointPresence: activity=" + activity + " note=" + note);
}

// main function
function start() {
if (connection) connection.close();
connection = new Connection(config.url, config.username, config.password);
connection.onconnected = onConnected;
connection.onerror = onError;
connection.onclosed = onClosed;
connection.onendpointpresence = onEndpointPresence;
}

</script>

== innovaphone.pbxwebsocket.WebRtcEndpoint ==
This file contains a WebRTC endpoint implementation that can be used for adding WebRTC calls to a web page. For that the credentials of a user object on the PBX is needed. Visitors of the web page will use that user object for making phone calls.

'''In some browsers like Chrome WebRTC only works on HTTPS pages. So it is mandatory to use HTTPS and WSS on your page.'''

=== Includes ===
The following files have to be included in the html file in order to use the WebRTC endpoint.
* <code>innovaphone.common.crypto.js</code>
* <code>innovaphone.pbxwebsocket.Connection.js</code>
* <code>innovaphone.pbxwebsocket.ToneGenerator.js</code>
* <code>innovaphone.pbxwebsocket.WebRtcEndpoint.js</code>

If you want to use application sharing the following files must also be included:
* <code>innovaphone.applicationSharing.jpeg.js</code>
* <code>innovaphone.applicationSharing.zlib.js</code>
* <code>innovaphone.applicationSharing.png.js</code>
* <code>innovaphone.applicationSharing.main.js</code>

Additionally the MP3 files containing the ring tones and ring back tones are needed on the web server in the same directory as the javascript files.

=== Compatibility check ===

You can test if the browser supports WebRTC by checking the bool <code>innovaphone.pbxwebsocket.WebRtc.supported</code>.

=== Constructor ===
;new WebRtcEndpoint(url, username, password, device, physicalLocation, regContext, onLog, onCall):
:;url: The URL of the PBX websocket service (e.g. <code>ws://10.0.0.1/PBX0/WEBSOCKET/websocket</code>)
:;username: The username of the PBX user object.
:;password: The password of the PBX user object.
:;device: The device ID that shall be used for making calls.
:;physicalLocation: The physical location of the user (optional).
:;regContext: A numeric value that will be used for identifying the registration in the PBX (optional).
:;logFunction: A callback function that is called for logging debug info (optional).
:;onCall: A callback function that is called when calls are added, updated or removed. Applications that want to use call control have to specify this callback function. Applications that don't should give <code>null</code>. (optional)
:;onAuthenticate: An optional callback function. If set it is called with the parameters (realm, sessionId, serverNonce). Applications should calculate the login hash unsing these parameters and the username and password and call setAuthentication.

=== Methods ===
;function close(): Closes the WebRTC endpoint and disconnects from the PBX.
;function initCall(name, number, video, sharing): Starts a phone call. This is only possible if the application supplied an <code>onCall</code> callback to the constructor.
:;name: The URI to be called (optional, supply name or number).
:;number: The phone number to be called (optional, supply name or number).
:;video: Set to <code>true</code> for starting a video call (optional).
:;sharing: Set to <code>true</code> for starting an application sharing call (optional).
;function connectCall(id): Connects a call.
:;id: The ID of the call.
;function clearCall(id): Terminates a call.
:;id: The ID of the call (optional). If no ID is supplied, all calls are terminated.
;function attachVideo(local, remote): Attaches HTML video elements to the WebRTC endpoints. The endpoint will use them to playback video. Applications can both attach before or during a video call. Also attaching multiple video elements for a single call is possible. The application should mute the video elements (<code>muted="muted"</code>) in order to avoid playback of audio.
:;local: The HTML video element for playback of the local webcam image (optional, may be <code>null</code>).
:;remote: The HTML video element for playback of the remote video image (optional, may be <code>null</code>).
;function detachVideo(local, remote): Detaches HTML video elements that have previously attached. This will stop the playback on the supplied elements.
:;local: The HTML video element to be detached (optional, may be <code>null</code>).
:;remote: The HTML video element to be detached (optional, may be <code>null</code>).
;function attachSharing(sharingDiv, createAppCallback, removeAppCallback, resizeCalback): Attaches a DIV element to the WebRTC endpoints. The endpoint will allocate inside this element a canvas object where the application sharing data will be displayed. Since more than one application could be shared, the javascript application has to provide a callback to be informed that a new application arrived and another callback to be informed that an application is not anymore shared. Both callbacks should received an '''id''' as argument. Another callback will be provided in case the shared application changes its resolution.
:;createAppCallback: createAppCallback(id, name). This callback also receives the name of the new application.
:;removeAppCallback: removeAppCallback(id).
:;resizeCallback: resizeCallback().
;function detachSharing(): Detaches elements that were previously attached.
;function sharingEvent(type, data): The endpoint provides an interface to send events to the application sharing class.
:;changeDisplayApp: This event is used to switch inside the canvas object between applications being shared. type is equal to '''changeDisplayApp''' and data should be the '''id''' of the application to be displayed. This '''id''' is the one provided in the create application callback.
:;fitToElement: This event adjusts the application being shared to the size of the DIV element provided with the '''attachSharing''' function. type is equal to '''fitToElement''' and data should be '''true''' if the application should be adjusted to the canvas element or false otherwise (original size).
:;requestControl: This event allows the client to request control (mouse, keyboard) over the shared applications. The sharing party still must accept this request before the client gets the control. type is equal to '''requestControl''' and data should be '''null'''.
;function setAuthentication(username, clientNonce, digest): Sets the client parameters of the authentication and the calculated digest.
:;username: The H323 id of the user object
:;clientNonce: A random number
:;digest: sha256("innovaphonePbxWebsocket:ClientAuth:" + realm + ":" + sessionId + ":" + username + ":" + password + ":" + clientNonce + ":" + serverNonce)

=== Callbacks ===
;function onLog(text): Should write the supplied text to the log of the application.
;function onCall(event, call): Is called when the state of calls of this WebRTC endpoint changes.
:;event: A string that can be <code>added</code>, <code>updated</code> and <code>removed</code>.
:;call: The call object containing the current info about the call.
::;id: The numeric id of the call.
::;dir: The direction of the call (<code>in</code> or <code>out</code>).
::;state:The state of the call (<code>idle</code>, <code>calling</code>, <code>incomplete</code>, <code>complete</code>, <code>alerting</code>, <code>connected</code>, <code>disconnecting</code>, <code>disconnected</code>, <code>parked</code>).
::;hold: <code>true</code>, if the call is on hold (optional).
::;name: The URI of the remote party (optional).
::;number: The phone number of the remote party (optional).
::;video: <code>true</code>, if video is active (optional).
::;sharing: <code>true</code>, if application sharing is active (optional).
::;cause: The cause code (optional).

=== Example ===
<script type="text/javascript" src="innovaphone.common.crypto.js"></script>
<script type="text/javascript" src="innovaphone.pbxwebsocket.Connection.js"></script>
<script type="text/javascript" src="innovaphone.pbxwebsocket.ToneGenerator.js"></script>
<script type="text/javascript" src="innovaphone.pbxwebsocket.WebRtcEndpoint.js"></script>
<script type="text/javascript" src="innovaphone.applicationSharing.jpeg.js"></script>
<script type="text/javascript" src="innovaphone.applicationSharing.zlib.js"></script>
<script type="text/javascript" src="innovaphone.applicationSharing.png.js"></script>
<script type="text/javascript" src="innovaphone.applicationSharing.main.js"></script>
<script type="text/javascript">

// dependencies
var WebRtcEndpoint = innovaphone.pbxwebsocket.WebRtc.Endpoint;

var endpoint = null;
var config = {
url: "wss://192.168.0.1/PBX0/WEBSOCKET/websocket",
username: "user",
password: "password",
device: "user-webrtc",
physicalLocation: null,
regContext: "0"
};

function logFunction(text) {
console.log("WebRTC demo: " + text);
}

function onCall(event, call) {
if (call.dir == "in") {
if (endpoint) endpoint.clearCall(call.id);
}
console.log("Call " + event + ": " + JSON.stringify(call));
}

function initCall(name, number, video, sharing) {
if (endpoint) endpoint.initCall(name, number, video, sharing);
}

function clearAllCalls() {
if (endpoint) endpoint.clearCall();
}

function close() {
if (endpoint) {
endpoint.detachVideo(document.getElementById("video-local"), document.getElementById("video-remote"));
endpoint.detachSharing();
endpoint.close();
}
endpoint = null;
}

function createNewApplication(id, name) {
var new_app = document.createElement("input");
new_app.setAttribute("id", "appSharing_" + id);
new_app.setAttribute("value", name);
new_app.setAttribute("type", "button");
appendChild(new_app);
}

function removeApplication(id) {
var input_b = document.getElementById("appSharing_" + id);
if(input_b) removeChild(input_b);
}

function start() {
if (endpoint) endpoint.close();
endpoint = new WebRtcEndpoint(config.url, config.username, config.password, config.device, config.physicalLocation, config.regContext, logFunction, onCall);
endpoint.attachVideo(document.getElementById("video-local"), document.getElementById("video-remote"));
endpoint.attachSharing(document.getElementById("sharing-local"), createNewApplication, removeApplication);
}

</script>

Reference12r1:Concept Netlogon Windows Authentication

2016-04-15T09:43:00Z

Sebastian.Lutz: /* Configuration */ typo

[[Category:Concept|Netlogon and myPBX Windows Authentication]]
In version 12r1 users can use their windows password for logging-in to myPBX. myPBX uses NTLM over the netlogon protocol for verifying windows passwords against the Active Directory.

== Applies to ==
* innovaphone devices with a PBX from version 12r1.

== How it works ==
=== Connection to the domain controller ===
The netlogon service of the PBX needs to connect to the DC. It authenticates using a computer account in the domain.
# DNS is used to retrieve the IP address of the DC (SRV record for ''_ldap._tcp.example.com'').
# The endpoint mapper on the DC is asked for the actual port of the netlogon server on the DC.
# A connetion is established to the netlogon server. For authentication the configured computer name and computer password is used.

=== Login with windows password in myPBX ===
The login process using windows credentials works in three steps.

[[Image:Netlogon_overview.png]]

;NTLM authentication:
First an NTLM handshake is done, involving the netlogon service on the PBX and the windows domain controller. NTLM is a challenge response mechanism. The web application calculates a hash value of the entered windows password and a challenge given by the PBX. The PBX asks the Windows server, that also knows the password, to verify the hash. In the end the PBX knows if the entered password was correct. Also the PBX and the web application have a shared secret, called the NTLM session key, that can be used for encryption.

;Temporary credentials:
The PBX creates temporary credentials for the myPBX login and stores them at the user object. After that it encrypts the credentials using the NTLM session key and sends them to the web application.

;Login:
For the actual login, myPBX uses the temporary credentials. When the user logs out the credentials are deleted both in the PBX and the Browser.

=== Characteristics ===
* The windows password is just used to calculate hashes. It is never stored or transmitted over the network.
* The temporary credentials are stored in the PBX at the user object and the DOM storage of the browser. So the user doesn't have to enter the windows password again, if the PBX or the browser is restarted.
* On logout the temporary credentials are deleted in the DOM Storage of the browser and in the PBX. So the next time the user is asked again for the windows password.

[[Image:Netlogon pbx sessions.png]]

== Requirements ==
;Windows domain:
* A computer account for the innovaphone device with a known password.
* User authentication using NTLM must be enabled.

;PBX:
* Firmware from version 12r1.
* Working DNS configuration.
* The usernames (Name) of the user objects in the PBX must match the Windows usernames (samAccountName).
* Netlogon authentication must be enabled on the myPBX configuration page.

;Network:
* TCP connections from the PBX to the domain controller must be possible.

== Configuration ==
* Create a computer account with known password
** Solution 1: (to much hassle): Create a computer account manual in the windows domain and set a password using an appropriate tool.
*** (Example at[https://support.microsoft.com/en-us/kb/216393] Sample 2
** Solution 2: Create a computer account via CLI and set password:
*** Use Powershell on Domain Controller to create Computer Account
*** New-ADComputer -Name <Computer-Account-Name> -AccountPassword (Read-Host -AsSecureString "AccountPassword")
**** Promt will ask for password
* Configure the netlogon service on the innovaphone device on page Services/Netlogon/Config.
* Activate netlogon authentication on page PBX/Config/myPBX.

== Usage ==
Depending on the configuration on page PBX/Config/myPBX users can use their PBX user password, their Windows password or both for myPBX login.

== Restrictions ==
* Only a single windows domain is supported.
* Since NTLM hashes are not very secure, HTTPS should be used for the communication between myPBX and the PBX.
* The windows session is not reused for authentication in myPBX. The user has to enter the windows password in myPBX.

== Tracing and logging ==
The log gives basic information about up and downtime of the service and the NTLM handshakes that are done.
<pre>
LOG NETLOGON 0 Service up
LOG NETLOGON 0 Authentication for 'exampleuser' failed (error c0000064)
LOG NETLOGON 0 Service down
</pre>

The trace contains more detailed information for tracking down problems and all the exchanged protocol messages. The protocol messages have been removed in the following example for better readability.
<pre>
NETLOGON: state ABORT
NETLOGON: state RECONNECT
NETLOGON: starting Domain(example.com) Computer(PBX-NETLOGON) ComputerPassword(XXX)
NETLOGON: state DNS
NETLOGON.0 -> dns.0 : DNS_GETHOSTBYNAME example.com ctx=0x0 flags=0x1 port=0
dns.0 -> NETLOGON.0 : DNS_GETHOSTBYNAME_RESULT ctx=0x0 result=0 addr=10.0.05 port=389
NETLOGON: state EPM_CONNECT
NETLOGON: connect to endpoint mapper at 10.0.05:135 (dc-w2k8.example.com)
NETLOGON: state EPM_BIND_HEAD
NETLOGON: state EPM_BIND_BODY
NETLOGON: state EPM_MAP_HEAD
NETLOGON: state EPM_MAP_BODY ........
NETLOGON: state EPM_DISCONNECT
NETLOGON: state NETLOGON_CONNECT
NETLOGON: connect to netlogon_service at 10.0.05:49159 (dc-w2k8.example.com)
NETLOGON: state NETLOGON_BIND_HEAD
NETLOGON: state NETLOGON_CHALLENGE_HEAD
NETLOGON: state NETLOGON_CHALLENGE_BODY ....
NETLOGON: state NETLOGON_AUTHENTICATE_HEAD
NETLOGON: encryption parameters ClientChallenge(e5cb2fd5f5218531) ServerChallenge(7338e9e65867e383) SessionKey(0978a50b44003835ac420ae6e69dfa89)
NETLOGON: state NETLOGON_AUTHENTICATE_BODY
NETLOGON: state NETLOGON_ALTER_HEAD
NETLOGON: state NETLOGON_ALTER_BODY
NETLOGON: state NETLOGON_DUMMYROUTINE_HEAD
NETLOGON: state NETLOGON_DUMMYROUTINE_BODY
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM(0, exampleuser)
challenge: 86fee2c0fa1e6ee6
nt_response: 58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702
lm_response: 09e25853e618688157c0faadb0861818f367056548ea9496
NETLOGON: start authentication Username(exampleuser) Challenge(86fee2c0fa1e6ee6) NtResponse(58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702) LmResponse(09e25853e618688157c0faadb0861818f367056548ea9496)
NETLOGON: state AUTHENTICATE_HEAD
NETLOGON: state AUTHENTICATE_BODY d...
NETLOGON: authentication failed (error c0000064)
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON_SOCKET.44 : SOCKET_RECV(16)
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM_RESULT(0, FAILED, c0000064, )
</pre>

Reference12r1:Concept Netlogon Windows Authentication

2016-04-15T09:02:46Z

Sebastian.Lutz: /* Configuration */ Update HowTo Create Computer Account

[[Category:Concept|Netlogon and myPBX Windows Authentication]]
In version 12r1 users can use their windows password for logging-in to myPBX. myPBX uses NTLM over the netlogon protocol for verifying windows passwords against the Active Directory.

== Applies to ==
* innovaphone devices with a PBX from version 12r1.

== How it works ==
=== Connection to the domain controller ===
The netlogon service of the PBX needs to connect to the DC. It authenticates using a computer account in the domain.
# DNS is used to retrieve the IP address of the DC (SRV record for ''_ldap._tcp.example.com'').
# The endpoint mapper on the DC is asked for the actual port of the netlogon server on the DC.
# A connetion is established to the netlogon server. For authentication the configured computer name and computer password is used.

=== Login with windows password in myPBX ===
The login process using windows credentials works in three steps.

[[Image:Netlogon_overview.png]]

;NTLM authentication:
First an NTLM handshake is done, involving the netlogon service on the PBX and the windows domain controller. NTLM is a challenge response mechanism. The web application calculates a hash value of the entered windows password and a challenge given by the PBX. The PBX asks the Windows server, that also knows the password, to verify the hash. In the end the PBX knows if the entered password was correct. Also the PBX and the web application have a shared secret, called the NTLM session key, that can be used for encryption.

;Temporary credentials:
The PBX creates temporary credentials for the myPBX login and stores them at the user object. After that it encrypts the credentials using the NTLM session key and sends them to the web application.

;Login:
For the actual login, myPBX uses the temporary credentials. When the user logs out the credentials are deleted both in the PBX and the Browser.

=== Characteristics ===
* The windows password is just used to calculate hashes. It is never stored or transmitted over the network.
* The temporary credentials are stored in the PBX at the user object and the DOM storage of the browser. So the user doesn't have to enter the windows password again, if the PBX or the browser is restarted.
* On logout the temporary credentials are deleted in the DOM Storage of the browser and in the PBX. So the next time the user is asked again for the windows password.

[[Image:Netlogon pbx sessions.png]]

== Requirements ==
;Windows domain:
* A computer account for the innovaphone device with a known password.
* User authentication using NTLM must be enabled.

;PBX:
* Firmware from version 12r1.
* Working DNS configuration.
* The usernames (Name) of the user objects in the PBX must match the Windows usernames (samAccountName).
* Netlogon authentication must be enabled on the myPBX configuration page.

;Network:
* TCP connections from the PBX to the domain controller must be possible.

== Configuration ==
* Create a computer account with known password
** Solution 1 (to much hassle): Create a computer account manual in the windows domain and set a password using an appropriate tool.
*** (Example at[https://support.microsoft.com/en-us/kb/216393] Sample 2
** Solution 2: Create a computer account via CLI and set password:
*** Use Powershell on Domain Controller to create Computer Account
*** New-ADComputer -Name <Computer-Account-Name> -AccountPassword (Read-Host -AsSecureString "AccountPassword")
**** Promt will ask for password
* Configure the netlogon service on the innovaphone device on page Services/Netlogon/Config.
* Activate netlogon authentication on page PBX/Config/myPBX.

== Usage ==
Depending on the configuration on page PBX/Config/myPBX users can use their PBX user password, their Windows password or both for myPBX login.

== Restrictions ==
* Only a single windows domain is supported.
* Since NTLM hashes are not very secure, HTTPS should be used for the communication between myPBX and the PBX.
* The windows session is not reused for authentication in myPBX. The user has to enter the windows password in myPBX.

== Tracing and logging ==
The log gives basic information about up and downtime of the service and the NTLM handshakes that are done.
<pre>
LOG NETLOGON 0 Service up
LOG NETLOGON 0 Authentication for 'exampleuser' failed (error c0000064)
LOG NETLOGON 0 Service down
</pre>

The trace contains more detailed information for tracking down problems and all the exchanged protocol messages. The protocol messages have been removed in the following example for better readability.
<pre>
NETLOGON: state ABORT
NETLOGON: state RECONNECT
NETLOGON: starting Domain(example.com) Computer(PBX-NETLOGON) ComputerPassword(XXX)
NETLOGON: state DNS
NETLOGON.0 -> dns.0 : DNS_GETHOSTBYNAME example.com ctx=0x0 flags=0x1 port=0
dns.0 -> NETLOGON.0 : DNS_GETHOSTBYNAME_RESULT ctx=0x0 result=0 addr=10.0.05 port=389
NETLOGON: state EPM_CONNECT
NETLOGON: connect to endpoint mapper at 10.0.05:135 (dc-w2k8.example.com)
NETLOGON: state EPM_BIND_HEAD
NETLOGON: state EPM_BIND_BODY
NETLOGON: state EPM_MAP_HEAD
NETLOGON: state EPM_MAP_BODY ........
NETLOGON: state EPM_DISCONNECT
NETLOGON: state NETLOGON_CONNECT
NETLOGON: connect to netlogon_service at 10.0.05:49159 (dc-w2k8.example.com)
NETLOGON: state NETLOGON_BIND_HEAD
NETLOGON: state NETLOGON_CHALLENGE_HEAD
NETLOGON: state NETLOGON_CHALLENGE_BODY ....
NETLOGON: state NETLOGON_AUTHENTICATE_HEAD
NETLOGON: encryption parameters ClientChallenge(e5cb2fd5f5218531) ServerChallenge(7338e9e65867e383) SessionKey(0978a50b44003835ac420ae6e69dfa89)
NETLOGON: state NETLOGON_AUTHENTICATE_BODY
NETLOGON: state NETLOGON_ALTER_HEAD
NETLOGON: state NETLOGON_ALTER_BODY
NETLOGON: state NETLOGON_DUMMYROUTINE_HEAD
NETLOGON: state NETLOGON_DUMMYROUTINE_BODY
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM(0, exampleuser)
challenge: 86fee2c0fa1e6ee6
nt_response: 58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702
lm_response: 09e25853e618688157c0faadb0861818f367056548ea9496
NETLOGON: start authentication Username(exampleuser) Challenge(86fee2c0fa1e6ee6) NtResponse(58881d894b81835edd0bfe758e468a0a0cd553e8c9f7a702) LmResponse(09e25853e618688157c0faadb0861818f367056548ea9496)
NETLOGON: state AUTHENTICATE_HEAD
NETLOGON: state AUTHENTICATE_BODY d...
NETLOGON: authentication failed (error c0000064)
NETLOGON: state CONNECTED
NETLOGON.0 -> NETLOGON_SOCKET.44 : SOCKET_RECV(16)
NETLOGON.0 -> NETLOGON.0 : NETLOGON_NTLM_RESULT(0, FAILED, c0000064, )
</pre>

Reference9:Event/0x00031001

2014-03-11T11:51:29Z

Sebastian.Lutz:

'''Severity Indeterminate'''

'''SourceDECTDescriptionQoS low'''

This is an alarm which is generated from the DECT-System.

The wireless network quality is bad and some Voicepackets could not be received.

Howto:Setup SIP Federation with innovaphone AG V9

2013-10-14T07:11:24Z

Sebastian.Lutz: /* SIP Federation Partner */

==Applies To==
This information applies to innovaphone systems V9 and later.

==More Information==

===Problem Details===
With the innovaphone myPBX UC Client it is not only possible to communicate with the persons within your company, but also possible to use the unified communication features like presence etc. also with external companies.

Our company, innovaphone AG, provides an interface for the SIP federation with our partners and customers. This article describes how to setup your innovaphone PBX to be able to communicate with innovaphone AG using UC features.

===Prerequisites===
Make sure you have following:

*innovaphone PBX System with the recent V9 or V10 firmware
*licenses for myPBX
*access to your public DNS server, to be able to configure required DNS record
*access to the internet from the PBX or other innovaphone gateway
*the System Name of the PBX must be equal to the domain part used for E-Mails
*the Name of the User Objects (do not mix with Long Name) must be equal to the user part of the E-Mail addresses used for external communication
**if the Users E-Mail address is <code>bob@company.example</code>, the System Name must be <code>company.example</code> and the Name of User Object <code>bob</code>

==Configuration==

===PBX===

====System Name====
The ''System Name'' of the PBX must be set according the DNS domain name used for federation. In case of innovaphone AG this is <code>innovaphone.com</code>.

The option ''Use as Domain'' must be active.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_PBX_system_name.png]]

====Visibility====
In order to give innovaphone AG the access to your presence and on-line status, the ''Access'' on the PBX User Object must be configured. This can be done for the complete domain <code>@innovaphone.com</code> or to a specific person <code>bob@innovaphone.com</code>.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_access.png]]

This can be done on a per-user level or in an appropriate template.

To set up default access rights (which may be restrictive) for all federation partners, you can specify <code>@</code> only as ''Name'' (which serves as a ''catch-all''-domain) (available from v10sr3).

====Gateway Object====
Create a Gateway Object without number. Place the ''Long Name'' of this object to the ''Route Root-Node External Calls to'' filed of the PBX General configuration page:

[[Image:Setup SIP Federation with innovaphone AG PBX external.png]]

In case this option already used to route calls to another PBX in a [[Howto:Looping_in_a_innovaphone_Gateway|loop in scenario]], make sure to route the calls first to the SIP interface configured for the federation, ant than to the 3rd Party PBX.

===SIP Interface===
The SIP interface is required to be able send and accept SIP calls and presence subscriptions to the federation partners. The mode of the SIP interface should be ''Open Federation''.

This SIP interface must be reachable from the internet via TCP port 5061 and must be registered at the Gateway Object in the PBX used for federation.

The best practice is to route incoming federation calls to numbers (e.g. <code>123@example.com</code>) via the Trunk Line Object that is used for PSTN calls. In the following picture you will find the routing ways of the federation calls:

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line.png]]

[[Image:Setup SIP Federation with innovaphone AG routes ex.png]]

'''Important''': Make sure to enable ''Interworking(QSIG,SIP)'' on the routes from and to this interface.

You can use an additional innovaphone gateway to offload the SIP interface for federation from the PBX gateway and place it in the DMZ.

Depending on your network configuration (NAT, Firewall etc.) it is useful to enable ''Media-Relay'' on the SIP interface to be able to make voice calls.

===DNS Entries===
The SIP Federation mechanism relies on the DNS to resolve the domain name of the federation partner and find out the IP address to send the SIP messages.

Following DNS entries form you as federation partner are required:
*SRV record <code>_sips._tcp.yourcompany.example</code> or <code>_sipfederationtls._tcp.yourcompany.example</code>pointing to an IP address or host name of the innovaphone gateway that hosts the SIP interface for federation
*in case SRV record points to a host name, the host name must be resolved to the IP address of the innovaphone gateway that hosts the SIP interface for federation

For example, following DNS entries are configured for federation with the innovaphone AG:

_sips._tcp.innovaphone.com IN SRV 5061 sip.innovaphone.com

sip.innovaphone.com IN A 145.253.157.4

===Certificates===
The innovaphone gateway, that hosts the SIP interface for federation must have a certificate with a Common Name (CN) or SubjectAlternativeName (DNS) that matches your domain name. You can use a self signed one, generated directly on the box.

In case you configure DNS and IP Entries in the certificate, make sure the domain name used for the PBX and Federation Interface is included in the certificate.

[[Image:Setup SIP Federation with innovaphone AG creating self signed cert.png]]

E.g., innovaphone AG provides following entries in the certificate:
CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4

However, only CN and DNS for innovaphone.com would be sufficient for SIP Federation.

====Get on the Trust List====

If you try to federate with innovaphone AG for the first time, your certificate will be rejected, cause it will be not on our trust list.

To get on the trust list at our federation gateway, please contact [mailto:presales@innovaphone.com presales] and provide the domain name and the certificate data.

====Put the certificate of innovaphone AG on the own Trust List====

You have also to trust a certificate, provided by innovaphone:

Subject
C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4
Issuer C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com

Serial number FBA06716
Not before 22.08.2013 09:26:00 GMT
Not after 22.08.2023 09:26:00 GMT
CA yes
Path length 0
Key usage digital_signature key_encipherment key_cert_sign
Subject key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
Authority key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
--------
Type X.509 v3
Public key 1024-bit RSA
SHA1 27:E1:9A:19:A2:EC:E3:0E:9F:F6:96:75:49:90:AC:55:F5:36:3C:70
MD5 08:AB:5C:DE:D0:6E:90:E2:8E:81:00:F7:06:A2:41:18

==Security Considerations==

===Firewall===
In case a firewall is used to filter the connections from the internet to your SIP gateway, please define a rule to allow incoming connections from the IP address 145.253.157.4 to the TCP port 5061.

Also make sure to allow a range of UDP ports for RTP, in case voice calls should be supported.

===Offload SIP Federation Interface to DMZ===
When possible, offload the SIP Interface in the Federation mode to an innovaphone Gateway in the DMZ, so the PBX itself is not reachable from the internet directly.

===Secure your PBX===

In case the Gateway with PBX is reachable from the internet, make sure to use secure passwords for administration and user objects. 'implement IP-Filters to disable registrations at the PBX from the internet.

==Usage==

To add somebody on your favourites list, go to the myPBX and place the e-mail address of the person into the search field. Then press on the star symbol.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_add_buddy_list.png]]

In case the federation was configured correctly and access rights are configured to be able to see presence and on-line status, the save button for an ''External URI'' will appear.

==SIP Federation Partner==
Here is a list of domains accepting SIP federation connections:

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ SIP Federation enabled Domains
! Domain !! access !! contact
|-
| innovaphone.com || on request || presales@innovaphone.com
|-
| oberberg.net || on request || admin_tk@oberberg.net
|-
| inikon.ch || on request || marc.steiner@inikon.ch
|-
| estos.de || presence only ||
|}

==Troubleshooting==

The best way to troubleshoot the SIP federation is to make an RPCAP Wireshark trace on the gateway with the SIP interface used for federation.

Check the trace for following:

*a DNS request and reply resolving the SRV record
*establishing of the TLS connection
*SIP subscribe and notify requests (visible only in the innovaphone log part if SIP tracing is enabled)

==Related Articles==
[[Reference9:Gateway/Interfaces/SIP]]

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

Howto:Setup SIP Federation with innovaphone AG V9

2013-10-08T13:58:27Z

Sebastian.Lutz: /* SIP Federation Partner */

==Applies To==
This information applies to innovaphone systems V9 and later.

==More Information==

===Problem Details===
With the innovaphone myPBX UC Client it is not only possible to communicate with the persons within your company, but also possible to use the unified communication features like presence etc. also with external companies.

Our company, innovaphone AG, provides an interface for the SIP federation with our partners and customers. This article describes how to setup your innovaphone PBX to be able to communicate with innovaphone AG using UC features.

===Prerequisites===
Make sure you have following:

*innovaphone PBX System with the recent V9 or V10 firmware
*licenses for myPBX
*access to your public DNS server, to be able to configure required DNS record
*access to the internet from the PBX or other innovaphone gateway
*the System Name of the PBX must be equal to the domain part used for E-Mails
*the Name of the User Objects (do not mix with Long Name) must be equal to the user part of the E-Mail addresses used for external communication
**if the Users E-Mail address is <code>bob@company.example</code>, the System Name must be <code>company.example</code> and the Name of User Object <code>bob</code>

==Configuration==

===PBX===

====System Name====
The ''System Name'' of the PBX must be set according the DNS domain name used for federation. In case of innovaphone AG this is <code>innovaphone.com</code>.

The option ''Use as Domain'' must be active.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_PBX_system_name.png]]

====Visibility====
In order to give innovaphone AG the access to your presence and on-line status, the ''Access'' on the PBX User Object must be configured. This can be done for the complete domain <code>@innovaphone.com</code> or to a specific person <code>bob@innovaphone.com</code>.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_access.png]]

This can be done on a per-user level or in an appropriate template.

To set up default access rights (which may be restrictive) for all federation partners, you can specify <code>@</code> only as ''Name'' (which serves as a ''catch-all''-domain) (available from v10sr3).

====Gateway Object====
Create a Gateway Object without number. Place the ''Long Name'' of this object to the ''Route Root-Node External Calls to'' filed of the PBX General configuration page:

[[Image:Setup SIP Federation with innovaphone AG PBX external.png]]

In case this option already used to route calls to another PBX in a [[Howto:Looping_in_a_innovaphone_Gateway|loop in scenario]], make sure to route the calls first to the SIP interface configured for the federation, ant than to the 3rd Party PBX.

===SIP Interface===
The SIP interface is required to be able send and accept SIP calls and presence subscriptions to the federation partners. The mode of the SIP interface should be ''Open Federation''.

This SIP interface must be reachable from the internet via TCP port 5061 and must be registered at the Gateway Object in the PBX used for federation.

The best practice is to route incoming federation calls to numbers (e.g. <code>123@example.com</code>) via the Trunk Line Object that is used for PSTN calls. In the following picture you will find the routing ways of the federation calls:

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line.png]]

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line routes example.png]]

'''Important''': Make sure to enable ''Interworking(QSIG,SIP)'' on the routes from and to this interface.

You can use an additional innovaphone gateway to offload the SIP interface for federation from the PBX gateway and place it in the DMZ.

Depending on your network configuration (NAT, Firewall etc.) it is useful to enable ''Media-Relay'' on the SIP interface to be able to make voice calls.

===DNS Entries===
The SIP Federation mechanism relies on the DNS to resolve the domain name of the federation partner and find out the IP address to send the SIP messages.

Following DNS entries form you as federation partner are required:
*SRV record <code>_sips._tcp.yourcompany.example</code> or <code>_sipfederationtls._tcp.yourcompany.example</code>pointing to an IP address or host name of the innovaphone gateway that hosts the SIP interface for federation
*in case SRV record points to a host name, the host name must be resolved to the IP address of the innovaphone gateway that hosts the SIP interface for federation

For example, following DNS entries are configured for federation with the innovaphone AG:

_sips._tcp.innovaphone.com IN SRV 5061 sip.innovaphone.com

sip.innovaphone.com IN A 145.253.157.4

===Certificates===
The innovaphone gateway, that hosts the SIP interface for federation must have a certificate with a Common Name (CN) or SubjectAlternativeName (DNS) that matches your domain name. You can use a self signed one, generated directly on the box.

In case you configure DNS and IP Entries in the certificate, make sure the domain name used for the PBX and Federation Interface is included in the certificate.

[[Image:Setup SIP Federation with innovaphone AG creating self signed cert.png]]

E.g., innovaphone AG provides following entries in the certificate:
CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4

However, only CN and DNS for innovaphone.com would be sufficient for SIP Federation.

====Get on the Trust List====

If you try to federate with innovaphone AG for the first time, your certificate will be rejected, cause it will be not on our trust list.

To get on the trust list at our federation gateway, please contact [mailto:presales@innovaphone.com presales] and provide the domain name and the certificate data.

====Put the certificate of innovaphone AG on the own Trust List====

You have also to trust a certificate, provided by innovaphone:

Subject
C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4
Issuer C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com

Serial number FBA06716
Not before 22.08.2013 09:26:00 GMT
Not after 22.08.2023 09:26:00 GMT
CA yes
Path length 0
Key usage digital_signature key_encipherment key_cert_sign
Subject key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
Authority key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
--------
Type X.509 v3
Public key 1024-bit RSA
SHA1 27:E1:9A:19:A2:EC:E3:0E:9F:F6:96:75:49:90:AC:55:F5:36:3C:70
MD5 08:AB:5C:DE:D0:6E:90:E2:8E:81:00:F7:06:A2:41:18

==Security Considerations==

===Firewall===
In case a firewall is used to filter the connections from the internet to your SIP gateway, please define a rule to allow incoming connections from the IP address 145.253.157.4 to the TCP port 5061.

Also make sure to allow a range of UDP ports for RTP, in case voice calls should be supported.

===Offload SIP Federation Interface to DMZ===
When possible, offload the SIP Interface in the Federation mode to an innovaphone Gateway in the DMZ, so the PBX itself is not reachable from the internet directly.

===Secure your PBX===

In case the Gateway with PBX is reachable from the internet, make sure to use secure passwords for administration and user objects. 'implement IP-Filters to disable registrations at the PBX from the internet.

==Usage==

To add somebody on your favourites list, go to the myPBX and place the e-mail address of the person into the search field. Then press on the star symbol.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_add_buddy_list.png]]

In case the federation was configured correctly and access rights are configured to be able to see presence and on-line status, the save button for an ''External URI'' will appear.

==SIP Federation Partner==
Here is a list of domains accepting SIP federation connections:

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ SIP Federation enabled Domains
! Domain !! Note !! contact
|-
| innovaphone.com || on request || presales@innovaphone.com
|-
| oberberg.net || on request || admin_tk@oberberg.net
|-
| inikon.ch || on request ||
|-
| estos.de || presence only ||
|}

==Troubleshooting==

The best way to troubleshoot the SIP federation is to make an RPCAP Wireshark trace on the gateway with the SIP interface used for federation.

Check the trace for following:

*a DNS request and reply resolving the SRV record
*establishing of the TLS connection
*SIP subscribe and notify requests (visible only in the innovaphone log part if SIP tracing is enabled)

==Related Articles==
[[Reference9:Gateway/Interfaces/SIP]]

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

Howto:Setup SIP Federation with innovaphone AG V9

2013-10-08T13:48:01Z

Sebastian.Lutz: /* SIP Federation Partner */

==Applies To==
This information applies to innovaphone systems V9 and later.

==More Information==

===Problem Details===
With the innovaphone myPBX UC Client it is not only possible to communicate with the persons within your company, but also possible to use the unified communication features like presence etc. also with external companies.

Our company, innovaphone AG, provides an interface for the SIP federation with our partners and customers. This article describes how to setup your innovaphone PBX to be able to communicate with innovaphone AG using UC features.

===Prerequisites===
Make sure you have following:

*innovaphone PBX System with the recent V9 or V10 firmware
*licenses for myPBX
*access to your public DNS server, to be able to configure required DNS record
*access to the internet from the PBX or other innovaphone gateway
*the System Name of the PBX must be equal to the domain part used for E-Mails
*the Name of the User Objects (do not mix with Long Name) must be equal to the user part of the E-Mail addresses used for external communication
**if the Users E-Mail address is <code>bob@company.example</code>, the System Name must be <code>company.example</code> and the Name of User Object <code>bob</code>

==Configuration==

===PBX===

====System Name====
The ''System Name'' of the PBX must be set according the DNS domain name used for federation. In case of innovaphone AG this is <code>innovaphone.com</code>.

The option ''Use as Domain'' must be active.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_PBX_system_name.png]]

====Visibility====
In order to give innovaphone AG the access to your presence and on-line status, the ''Access'' on the PBX User Object must be configured. This can be done for the complete domain <code>@innovaphone.com</code> or to a specific person <code>bob@innovaphone.com</code>.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_access.png]]

This can be done on a per-user level or in an appropriate template.

To set up default access rights (which may be restrictive) for all federation partners, you can specify <code>@</code> only as ''Name'' (which serves as a ''catch-all''-domain) (available from v10sr3).

====Gateway Object====
Create a Gateway Object without number. Place the ''Long Name'' of this object to the ''Route Root-Node External Calls to'' filed of the PBX General configuration page:

[[Image:Setup SIP Federation with innovaphone AG PBX external.png]]

In case this option already used to route calls to another PBX in a [[Howto:Looping_in_a_innovaphone_Gateway|loop in scenario]], make sure to route the calls first to the SIP interface configured for the federation, ant than to the 3rd Party PBX.

===SIP Interface===
The SIP interface is required to be able send and accept SIP calls and presence subscriptions to the federation partners. The mode of the SIP interface should be ''Open Federation''.

This SIP interface must be reachable from the internet via TCP port 5061 and must be registered at the Gateway Object in the PBX used for federation.

The best practice is to route incoming federation calls to numbers (e.g. <code>123@example.com</code>) via the Trunk Line Object that is used for PSTN calls. In the following picture you will find the routing ways of the federation calls:

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line.png]]

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line routes example.png]]

'''Important''': Make sure to enable ''Interworking(QSIG,SIP)'' on the routes from and to this interface.

You can use an additional innovaphone gateway to offload the SIP interface for federation from the PBX gateway and place it in the DMZ.

Depending on your network configuration (NAT, Firewall etc.) it is useful to enable ''Media-Relay'' on the SIP interface to be able to make voice calls.

===DNS Entries===
The SIP Federation mechanism relies on the DNS to resolve the domain name of the federation partner and find out the IP address to send the SIP messages.

Following DNS entries form you as federation partner are required:
*SRV record <code>_sips._tcp.yourcompany.example</code> or <code>_sipfederationtls._tcp.yourcompany.example</code>pointing to an IP address or host name of the innovaphone gateway that hosts the SIP interface for federation
*in case SRV record points to a host name, the host name must be resolved to the IP address of the innovaphone gateway that hosts the SIP interface for federation

For example, following DNS entries are configured for federation with the innovaphone AG:

_sips._tcp.innovaphone.com IN SRV 5061 sip.innovaphone.com

sip.innovaphone.com IN A 145.253.157.4

===Certificates===
The innovaphone gateway, that hosts the SIP interface for federation must have a certificate with a Common Name (CN) or SubjectAlternativeName (DNS) that matches your domain name. You can use a self signed one, generated directly on the box.

In case you configure DNS and IP Entries in the certificate, make sure the domain name used for the PBX and Federation Interface is included in the certificate.

[[Image:Setup SIP Federation with innovaphone AG creating self signed cert.png]]

E.g., innovaphone AG provides following entries in the certificate:
CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4

However, only CN and DNS for innovaphone.com would be sufficient for SIP Federation.

====Get on the Trust List====

If you try to federate with innovaphone AG for the first time, your certificate will be rejected, cause it will be not on our trust list.

To get on the trust list at our federation gateway, please contact [mailto:presales@innovaphone.com presales] and provide the domain name and the certificate data.

====Put the certificate of innovaphone AG on the own Trust List====

You have also to trust a certificate, provided by innovaphone:

Subject
C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4
Issuer C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com

Serial number FBA06716
Not before 22.08.2013 09:26:00 GMT
Not after 22.08.2023 09:26:00 GMT
CA yes
Path length 0
Key usage digital_signature key_encipherment key_cert_sign
Subject key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
Authority key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
--------
Type X.509 v3
Public key 1024-bit RSA
SHA1 27:E1:9A:19:A2:EC:E3:0E:9F:F6:96:75:49:90:AC:55:F5:36:3C:70
MD5 08:AB:5C:DE:D0:6E:90:E2:8E:81:00:F7:06:A2:41:18

==Security Considerations==

===Firewall===
In case a firewall is used to filter the connections from the internet to your SIP gateway, please define a rule to allow incoming connections from the IP address 145.253.157.4 to the TCP port 5061.

Also make sure to allow a range of UDP ports for RTP, in case voice calls should be supported.

===Offload SIP Federation Interface to DMZ===
When possible, offload the SIP Interface in the Federation mode to an innovaphone Gateway in the DMZ, so the PBX itself is not reachable from the internet directly.

===Secure your PBX===

In case the Gateway with PBX is reachable from the internet, make sure to use secure passwords for administration and user objects. 'implement IP-Filters to disable registrations at the PBX from the internet.

==Usage==

To add somebody on your favourites list, go to the myPBX and place the e-mail address of the person into the search field. Then press on the star symbol.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_add_buddy_list.png]]

In case the federation was configured correctly and access rights are configured to be able to see presence and on-line status, the save button for an ''External URI'' will appear.

==SIP Federation Partner==
Here is a list of domains accepting SIP federation connections:

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ SIP Federation enabled Domains
! Domain !! Note !! contact
|-
| innovaphone.com || on request || presales@innovaphone.com
|-
| inikon.ch || on request ||
|-
| estos.de || presence only ||
|-
| oberberg.net || on request || admin_tk@oberberg.net
|}

==Troubleshooting==

The best way to troubleshoot the SIP federation is to make an RPCAP Wireshark trace on the gateway with the SIP interface used for federation.

Check the trace for following:

*a DNS request and reply resolving the SRV record
*establishing of the TLS connection
*SIP subscribe and notify requests (visible only in the innovaphone log part if SIP tracing is enabled)

==Related Articles==
[[Reference9:Gateway/Interfaces/SIP]]

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

Howto:Setup SIP Federation with innovaphone AG V9

2013-10-08T13:46:40Z

Sebastian.Lutz: /* SIP Federation Partner */

==Applies To==
This information applies to innovaphone systems V9 and later.

==More Information==

===Problem Details===
With the innovaphone myPBX UC Client it is not only possible to communicate with the persons within your company, but also possible to use the unified communication features like presence etc. also with external companies.

Our company, innovaphone AG, provides an interface for the SIP federation with our partners and customers. This article describes how to setup your innovaphone PBX to be able to communicate with innovaphone AG using UC features.

===Prerequisites===
Make sure you have following:

*innovaphone PBX System with the recent V9 or V10 firmware
*licenses for myPBX
*access to your public DNS server, to be able to configure required DNS record
*access to the internet from the PBX or other innovaphone gateway
*the System Name of the PBX must be equal to the domain part used for E-Mails
*the Name of the User Objects (do not mix with Long Name) must be equal to the user part of the E-Mail addresses used for external communication
**if the Users E-Mail address is <code>bob@company.example</code>, the System Name must be <code>company.example</code> and the Name of User Object <code>bob</code>

==Configuration==

===PBX===

====System Name====
The ''System Name'' of the PBX must be set according the DNS domain name used for federation. In case of innovaphone AG this is <code>innovaphone.com</code>.

The option ''Use as Domain'' must be active.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_PBX_system_name.png]]

====Visibility====
In order to give innovaphone AG the access to your presence and on-line status, the ''Access'' on the PBX User Object must be configured. This can be done for the complete domain <code>@innovaphone.com</code> or to a specific person <code>bob@innovaphone.com</code>.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_access.png]]

This can be done on a per-user level or in an appropriate template.

To set up default access rights (which may be restrictive) for all federation partners, you can specify <code>@</code> only as ''Name'' (which serves as a ''catch-all''-domain) (available from v10sr3).

====Gateway Object====
Create a Gateway Object without number. Place the ''Long Name'' of this object to the ''Route Root-Node External Calls to'' filed of the PBX General configuration page:

[[Image:Setup SIP Federation with innovaphone AG PBX external.png]]

In case this option already used to route calls to another PBX in a [[Howto:Looping_in_a_innovaphone_Gateway|loop in scenario]], make sure to route the calls first to the SIP interface configured for the federation, ant than to the 3rd Party PBX.

===SIP Interface===
The SIP interface is required to be able send and accept SIP calls and presence subscriptions to the federation partners. The mode of the SIP interface should be ''Open Federation''.

This SIP interface must be reachable from the internet via TCP port 5061 and must be registered at the Gateway Object in the PBX used for federation.

The best practice is to route incoming federation calls to numbers (e.g. <code>123@example.com</code>) via the Trunk Line Object that is used for PSTN calls. In the following picture you will find the routing ways of the federation calls:

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line.png]]

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line routes example.png]]

'''Important''': Make sure to enable ''Interworking(QSIG,SIP)'' on the routes from and to this interface.

You can use an additional innovaphone gateway to offload the SIP interface for federation from the PBX gateway and place it in the DMZ.

Depending on your network configuration (NAT, Firewall etc.) it is useful to enable ''Media-Relay'' on the SIP interface to be able to make voice calls.

===DNS Entries===
The SIP Federation mechanism relies on the DNS to resolve the domain name of the federation partner and find out the IP address to send the SIP messages.

Following DNS entries form you as federation partner are required:
*SRV record <code>_sips._tcp.yourcompany.example</code> or <code>_sipfederationtls._tcp.yourcompany.example</code>pointing to an IP address or host name of the innovaphone gateway that hosts the SIP interface for federation
*in case SRV record points to a host name, the host name must be resolved to the IP address of the innovaphone gateway that hosts the SIP interface for federation

For example, following DNS entries are configured for federation with the innovaphone AG:

_sips._tcp.innovaphone.com IN SRV 5061 sip.innovaphone.com

sip.innovaphone.com IN A 145.253.157.4

===Certificates===
The innovaphone gateway, that hosts the SIP interface for federation must have a certificate with a Common Name (CN) or SubjectAlternativeName (DNS) that matches your domain name. You can use a self signed one, generated directly on the box.

In case you configure DNS and IP Entries in the certificate, make sure the domain name used for the PBX and Federation Interface is included in the certificate.

[[Image:Setup SIP Federation with innovaphone AG creating self signed cert.png]]

E.g., innovaphone AG provides following entries in the certificate:
CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4

However, only CN and DNS for innovaphone.com would be sufficient for SIP Federation.

====Get on the Trust List====

If you try to federate with innovaphone AG for the first time, your certificate will be rejected, cause it will be not on our trust list.

To get on the trust list at our federation gateway, please contact [mailto:presales@innovaphone.com presales] and provide the domain name and the certificate data.

====Put the certificate of innovaphone AG on the own Trust List====

You have also to trust a certificate, provided by innovaphone:

Subject
C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4
Issuer C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com

Serial number FBA06716
Not before 22.08.2013 09:26:00 GMT
Not after 22.08.2023 09:26:00 GMT
CA yes
Path length 0
Key usage digital_signature key_encipherment key_cert_sign
Subject key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
Authority key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
--------
Type X.509 v3
Public key 1024-bit RSA
SHA1 27:E1:9A:19:A2:EC:E3:0E:9F:F6:96:75:49:90:AC:55:F5:36:3C:70
MD5 08:AB:5C:DE:D0:6E:90:E2:8E:81:00:F7:06:A2:41:18

==Security Considerations==

===Firewall===
In case a firewall is used to filter the connections from the internet to your SIP gateway, please define a rule to allow incoming connections from the IP address 145.253.157.4 to the TCP port 5061.

Also make sure to allow a range of UDP ports for RTP, in case voice calls should be supported.

===Offload SIP Federation Interface to DMZ===
When possible, offload the SIP Interface in the Federation mode to an innovaphone Gateway in the DMZ, so the PBX itself is not reachable from the internet directly.

===Secure your PBX===

In case the Gateway with PBX is reachable from the internet, make sure to use secure passwords for administration and user objects. 'implement IP-Filters to disable registrations at the PBX from the internet.

==Usage==

To add somebody on your favourites list, go to the myPBX and place the e-mail address of the person into the search field. Then press on the star symbol.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_add_buddy_list.png]]

In case the federation was configured correctly and access rights are configured to be able to see presence and on-line status, the save button for an ''External URI'' will appear.

==SIP Federation Partner==
Here is a list of domains accepting SIP federation connections:

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ SIP Federation enabled Domains
! Domain !! Note !! contact
|-
| inikon.ch || on request ||
|-
| estos.de || presence only ||
|-
| oberberg.net || on request || admin_tk@oberberg.net
|}

==Troubleshooting==

The best way to troubleshoot the SIP federation is to make an RPCAP Wireshark trace on the gateway with the SIP interface used for federation.

Check the trace for following:

*a DNS request and reply resolving the SRV record
*establishing of the TLS connection
*SIP subscribe and notify requests (visible only in the innovaphone log part if SIP tracing is enabled)

==Related Articles==
[[Reference9:Gateway/Interfaces/SIP]]

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

Howto:Setup SIP Federation with innovaphone AG V9

2013-10-08T13:46:26Z

Sebastian.Lutz: /* SIP Federation Partner */

==Applies To==
This information applies to innovaphone systems V9 and later.

==More Information==

===Problem Details===
With the innovaphone myPBX UC Client it is not only possible to communicate with the persons within your company, but also possible to use the unified communication features like presence etc. also with external companies.

Our company, innovaphone AG, provides an interface for the SIP federation with our partners and customers. This article describes how to setup your innovaphone PBX to be able to communicate with innovaphone AG using UC features.

===Prerequisites===
Make sure you have following:

*innovaphone PBX System with the recent V9 or V10 firmware
*licenses for myPBX
*access to your public DNS server, to be able to configure required DNS record
*access to the internet from the PBX or other innovaphone gateway
*the System Name of the PBX must be equal to the domain part used for E-Mails
*the Name of the User Objects (do not mix with Long Name) must be equal to the user part of the E-Mail addresses used for external communication
**if the Users E-Mail address is <code>bob@company.example</code>, the System Name must be <code>company.example</code> and the Name of User Object <code>bob</code>

==Configuration==

===PBX===

====System Name====
The ''System Name'' of the PBX must be set according the DNS domain name used for federation. In case of innovaphone AG this is <code>innovaphone.com</code>.

The option ''Use as Domain'' must be active.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_PBX_system_name.png]]

====Visibility====
In order to give innovaphone AG the access to your presence and on-line status, the ''Access'' on the PBX User Object must be configured. This can be done for the complete domain <code>@innovaphone.com</code> or to a specific person <code>bob@innovaphone.com</code>.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_access.png]]

This can be done on a per-user level or in an appropriate template.

To set up default access rights (which may be restrictive) for all federation partners, you can specify <code>@</code> only as ''Name'' (which serves as a ''catch-all''-domain) (available from v10sr3).

====Gateway Object====
Create a Gateway Object without number. Place the ''Long Name'' of this object to the ''Route Root-Node External Calls to'' filed of the PBX General configuration page:

[[Image:Setup SIP Federation with innovaphone AG PBX external.png]]

In case this option already used to route calls to another PBX in a [[Howto:Looping_in_a_innovaphone_Gateway|loop in scenario]], make sure to route the calls first to the SIP interface configured for the federation, ant than to the 3rd Party PBX.

===SIP Interface===
The SIP interface is required to be able send and accept SIP calls and presence subscriptions to the federation partners. The mode of the SIP interface should be ''Open Federation''.

This SIP interface must be reachable from the internet via TCP port 5061 and must be registered at the Gateway Object in the PBX used for federation.

The best practice is to route incoming federation calls to numbers (e.g. <code>123@example.com</code>) via the Trunk Line Object that is used for PSTN calls. In the following picture you will find the routing ways of the federation calls:

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line.png]]

[[Image:Setup SIP Federation with innovaphone AG routing via trunk line routes example.png]]

'''Important''': Make sure to enable ''Interworking(QSIG,SIP)'' on the routes from and to this interface.

You can use an additional innovaphone gateway to offload the SIP interface for federation from the PBX gateway and place it in the DMZ.

Depending on your network configuration (NAT, Firewall etc.) it is useful to enable ''Media-Relay'' on the SIP interface to be able to make voice calls.

===DNS Entries===
The SIP Federation mechanism relies on the DNS to resolve the domain name of the federation partner and find out the IP address to send the SIP messages.

Following DNS entries form you as federation partner are required:
*SRV record <code>_sips._tcp.yourcompany.example</code> or <code>_sipfederationtls._tcp.yourcompany.example</code>pointing to an IP address or host name of the innovaphone gateway that hosts the SIP interface for federation
*in case SRV record points to a host name, the host name must be resolved to the IP address of the innovaphone gateway that hosts the SIP interface for federation

For example, following DNS entries are configured for federation with the innovaphone AG:

_sips._tcp.innovaphone.com IN SRV 5061 sip.innovaphone.com

sip.innovaphone.com IN A 145.253.157.4

===Certificates===
The innovaphone gateway, that hosts the SIP interface for federation must have a certificate with a Common Name (CN) or SubjectAlternativeName (DNS) that matches your domain name. You can use a self signed one, generated directly on the box.

In case you configure DNS and IP Entries in the certificate, make sure the domain name used for the PBX and Federation Interface is included in the certificate.

[[Image:Setup SIP Federation with innovaphone AG creating self signed cert.png]]

E.g., innovaphone AG provides following entries in the certificate:
CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4

However, only CN and DNS for innovaphone.com would be sufficient for SIP Federation.

====Get on the Trust List====

If you try to federate with innovaphone AG for the first time, your certificate will be rejected, cause it will be not on our trust list.

To get on the trust list at our federation gateway, please contact [mailto:presales@innovaphone.com presales] and provide the domain name and the certificate data.

====Put the certificate of innovaphone AG on the own Trust List====

You have also to trust a certificate, provided by innovaphone:

Subject
C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com
DNS=innovaphone.com
DNS=sip.innovaphone.com
IP=145.253.157.4
Issuer C=Germany, ST=BW, L=Sindelfingen, O=innovaphone AG, OU=Techserv, CN=innovaphone.com

Serial number FBA06716
Not before 22.08.2013 09:26:00 GMT
Not after 22.08.2023 09:26:00 GMT
CA yes
Path length 0
Key usage digital_signature key_encipherment key_cert_sign
Subject key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
Authority key ID 79:E8:1A:D0:4F:3E:3A:2E:13:DD:BB:9F:76:68:6B:00:2B:97:37:6C
--------
Type X.509 v3
Public key 1024-bit RSA
SHA1 27:E1:9A:19:A2:EC:E3:0E:9F:F6:96:75:49:90:AC:55:F5:36:3C:70
MD5 08:AB:5C:DE:D0:6E:90:E2:8E:81:00:F7:06:A2:41:18

==Security Considerations==

===Firewall===
In case a firewall is used to filter the connections from the internet to your SIP gateway, please define a rule to allow incoming connections from the IP address 145.253.157.4 to the TCP port 5061.

Also make sure to allow a range of UDP ports for RTP, in case voice calls should be supported.

===Offload SIP Federation Interface to DMZ===
When possible, offload the SIP Interface in the Federation mode to an innovaphone Gateway in the DMZ, so the PBX itself is not reachable from the internet directly.

===Secure your PBX===

In case the Gateway with PBX is reachable from the internet, make sure to use secure passwords for administration and user objects. 'implement IP-Filters to disable registrations at the PBX from the internet.

==Usage==

To add somebody on your favourites list, go to the myPBX and place the e-mail address of the person into the search field. Then press on the star symbol.

[[Image:Setup_SIP_Federation_with_innovaphone_AG_add_buddy_list.png]]

In case the federation was configured correctly and access rights are configured to be able to see presence and on-line status, the save button for an ''External URI'' will appear.

==SIP Federation Partner==
Here is a list of domains accepting SIP federation connections:

{|border="2" cellspacing="4" cellpadding="3" rules="all" style="margin:1em 1em 1em 0; border:solid 1px #AAAAAA; border-collapse:collapse;empty-cells:show;"
|+ SIP Federation enabled Domains
! Domain !! Note !! contact
|-
| inikon.ch || on request only
|-
| estos.de || presence only
|-
| oberberg.net || on request || admin_tk@oberberg.net
|}

==Troubleshooting==

The best way to troubleshoot the SIP federation is to make an RPCAP Wireshark trace on the gateway with the SIP interface used for federation.

Check the trace for following:

*a DNS request and reply resolving the SRV record
*establishing of the TLS connection
*SIP subscribe and notify requests (visible only in the innovaphone log part if SIP tracing is enabled)

==Related Articles==
[[Reference9:Gateway/Interfaces/SIP]]

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

Reference10:Concept Linux Application Platform

2013-09-10T07:37:50Z

Sebastian.Lutz: /* Enable further Tracing */

==Introduction==

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

==Requirements==

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

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

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

==Installation==

Download the latest Linux Application Platform from [https://download.innovaphone.com download.innovaphone.com ]. 
You can download and install two different packages:

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

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

====IPxx10 Gateways====

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

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

====VMWare====

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

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

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

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

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

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

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

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

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

* On an IPxx10: assign a static IP under [[ Reference10:Linux/IP ]]
* On a VMWare: assign a static IP in your local DHCP server for your MAC address defined in the *.vmx file

==Administration==

===General===

====Configure IP====

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

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

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

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

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

====Configure Authenticated URLs====

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

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

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

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

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

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

===Web Server===

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

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

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

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

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

Here you can change the credentials for Web Server access.

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

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

Here you can change the credentials for webdav access.

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

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

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

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

===Certificates===

The current server certificate installed on the web server is shown here. A self signed certificate, innovaphone-linux, is installed by default. It is recommended to change it with your own certificate.

It is also possible to trust or reject other certificates.

===Backup===

The web server can be configured to poll a Command File URL (on a web server). 
The backup process is similar to [[Reference10:Services/Update]]. 

An alarm server can be also configured to receive alarms during an automatic backup: [[ #Alarm_Server | Alarm Server under Diagnostics ]].

At the bottom you will see a list of the current automatic backup serials from the Command File URL and the log of the last automatic backups.

[[Image:backup_restore.jpg]]

====Command File====

Example:
saveinnovaphonecfgs http://172.16.123.123/webdav/backup/cfgs-#i-#b10.tar.gz

The available default commands are:

=====saveinnovaphonecfgs=====

Saves all neccessary configuration files (no application specific files) as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphonelogs=====

Saves all available (also application related) log files as a tar gz archive (so you should use .tar.gz as ending).

=====times=====
Executes the following command(s) only, if the specified time matches and only once per hour (independent of poll timeout value). 
Example:

<pre>
# both commands always executed
saveinnovaphonelogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-logs-#i-#m-#b10.tar.gz 
saveinnovaphonecfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-cfg-#i-#m-#b10.tar.gz 
# commands only from monday till saturday at 10am and 11am executed.
times day:1,2,3,4,5 hour:10,11
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz 
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz 
# commands only Saturdays and Sundays at 00am executed.
times day:6,7 hour:00
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz 
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz 
</pre>

* day goes from 1 (Monday) to 7 (Sunday). 
* hour goes from 00 to 23. 

You can specify multiple times commands to override the last one. 

=====Backup file name macros=====

You can use some macros for the backup filename:

* #i - will be replaced with the current IP address
* #m - will be replaced with the current MAC address
* #d - will be replaced with date/time in format Ymd-His (20110231-111010)
* #bxx - will be replaced with the current backup index, whilst xx is the maximum index

====Save configuration files/data====

Open this link to see all available files/data/logs to download them manually.

Password files for web server authentication won't be saved!

====Restore configuration files/data====

Open this link to restore all available files/data.

Password files for web server authentication won't be restored!

===Relay Hosts===

The Application Platform contains a mail client which speaks SMTP.
The SMTP daemon (postfix) looks up by default the DNS MX record of the recipient email address. 
Relay SMTP hosts can also be configured to deliver the mails. Each relay host is related to a sender mail address or a sender mail domain. TLS is used if the host supports it. 
Examples of the server entry:
; mydomain.com: MX record to the domain
; smtphost: host name with MX record lookup
; [gateway.example.com]: host name with DNS lookup
; [an.ip.add.ress]: IP address without DNS lookup
The form [hostname] turns off MX lookups. See also [http://www.postfix.org/postconf.5.html#relayhost the postfix documentation]. 
If anonymous SMTP is to be used, user and password must be left empty.
 

[[Image:relay_hosts.jpg]]

Currently innovaphone Reporting and innovaphone Faxserver are using these relay hosts, if entered.

===Database===

The innovaphone database is created to store e.g. relay hosts.
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

The database user is '''innovaphone''' with default password '''innovaphone'''.
This password may be changed here.

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here.

For the PgAdmin III it is imporant to use innovaphone as Service-DB (Wartungs-DB). Default login credentials - User: innovaphone - Password: innovaphone

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 (G722 will come in a later service release). 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then!

==Applications==

===List===

A list of all currently installed applications. 
If an application has an own web interface, you can reach it by using the application name link. 

====Uninstall====
Use the uninstall link in the list to uninstall an application.

===Upload/Update===

Here all new applications, application updates and application platform updates are installed. 
After uploading the file, the installation will start automatically and the installation process will be shown. The page refreshes until the installation has finished.

==Diagnostics==

===Logs===

Here you can view, download or clear the available log files from the application platform or from installed applications. 
You can also download all log files at once (this archiv also contains older versions from the log files).

===RPCAP===

Enable/disable RPCAP for use with Wireshark. 
A link will be displayed, which you can use within Wireshark.

===Alarm Server===

Configure an innovaphone device as alarm server:

* '''ip''': IP address of the innovaphone device
* ['''port''']
* ['''user''']: user for authentication to the alarm server
* ['''password''']
* ['''https''']: use https to send the alarm

Options in '''[]''' are optional.

Alarms from installed applications or the application platform itself will be sent to this configured server.

===Status===

View the disk usage.

===Reset===
====IPxx10====

Shutdown the application platform. You'll have to restart it over the IPxx10 gateway.

====VMWare====

Shutdown the application platform or reboot it.

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
The following scripts are used to retrieve the logs/alarms:
* logs: /ap/log.fcgi
* alarms: /ap/alarm.fcgi

So you can make the path '''/ap''' public on the ''Linux Web Server'' or you configure an authenticated URL for these files/this path on your ''innovaphone gateway''. 

If you configure an authenticated URL, don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like
https://111.111.111.111:443/ap or http://111.111.111.111:80/ap

==Use as File/VM-Server==

You can use the application platform as file server, e.g. for udpate scripts, voicemail etc. 
You can access the server with a webdav client via '''http(s)://Linux-IP/webdav''' 
Public access to certain paths etc. can be configured under the [[Reference10:Concept_Linux_Application_Platform#Web_Server | web server configuration]].

Keep in mind that the Linux Filesystem(ext3) is case sensetive. The PBX will always search for lowercase letters. If you name your file ‘greetings.G711A’ it won’t be found. You have to name the file ‘greetings.g711a’.

==Enable further Tracing==
There are different trace options, which can be enabled by calling a certain php script: 
https://LINUX-IP/trace.php?level=63

The level is calculated by the addition of one or multiple of the following trace options:

{| border=1
|| '''Option''' || '''To add'''
|-
|| TRACE_STD || 1
|-
|| TRACE_DB || 2
|-
|| TRACE_TIME || 4
|-
|| TRACE_CALL_FLOW_TOTAL || 8
|-
|| TRACE_CALL_FLOW || 16
|-
|| TRACE_PARSE_CFG || 32
|-
|}

So currently all trace options are enabled with the level '''63'''.

Default trace level are "0"

==Appendix==
===Creating own applications===
See [[Reference10:Concept Linux Application]]

===Tools===

====NetDrive====

[http://www.heise.de/software/download/netdrive/55134 NetDrive] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

===Manual Debian Upgrade===
If you have installed one of our upgrade hotfixes and you had installed packages, which weren't included in innovaphone applications, the upgrade of some packages might have failed. You will see a warning message on your application platform. Something like:

<code type="text">
The following packages couldn't be upgraded due to missing dependencies: php5-cgi php5-cli
Take a look at our wiki to see, what you have to do now!
</code>

Now you have to perfom some actions yourself:
* make sure, your Linux Application Platform has internet access
* login with a terminal client like Putty
* start 'apt-get update'
* start 'apt-get install php5-cgi php5-cli' (list the packages of the warning message)
* delete the file /var/www/innovaphone/log/missing_packages.log to clear the warning message:
** rm /var/www/innovaphone/log/missing_packages.log

Your installation should be now up to date again.

===Configuring a new Kernel===
If you have installed a hotfix with a new kernel, you will see a warning message on your application platform. Something like:

<code type="text">
You're not running the latest kernel Image-6010-3.4.10!
Take a look at our wiki to see, what you have to do now!
</code>

To change to the new kernel, you have to reconfigure something on your device, where the CF card is plugged in.
* First shutdown your Linux (see [[ Reference10:Concept_Linux_Application_Platform#IPxx10 ]])
* Stop Linux under [[ Reference10:Linux/General ]]
* Configure the latest kernel file (currently <code>Image-6010-3.4.10</code>) under [[ Reference10:Linux/General ]] '''Linux kernel file'''
* Start Linux under [[ Reference10:Linux/General ]]

===Alarms of the Application Platform===
If you have configured an [[ #Alarm_Server | Alarm Server]], you will receive certain alarms. 
Currently, the following alarms exist:

* Disk Usage >= 90%
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

* adduser
* apt
* apt-utils
* aptitude
* aptitude-common
* base-files
* base-passwd
* bash
* binutils
* bsdmainutils
* bsdutils
* bzip2
* ca-certificates
* comerr-dev
* coreutils
* cpio
* cpp
* cpp-4.7
* cpp-4.6
* cron
* curl
* dash
* db-util
* db5.1-util
* debconf
* debconf-i18n
* debian-archive-keyring
* debianutils
* diffutils
* dmidecode
* dmsetup
* dos2unix
* dovecot-common
* dovecot-core
* dovecot-pgsql
* dovecot-pop3d
* dovecot-sieve
* dpkg
* e2fslibs
* e2fsprogs
* file
* findutils
* gamin
* gcc
* gcc-4.7
* gcc-4.6
* gcc-4.6-base
* gcc-4.7-base
* gettext-base
* gnupg
* gpgv
* grep
* groff-base
* grub-common
* grub-legacy
* gzip
* hdparm
* hostname
* ifupdown
* info
* initramfs-tools
* initscripts
* insserv
* install-info
* iproute
* iptables
* iputils-ping
* isc-dhcp-client
* isc-dhcp-common
* klibc-utils
* kmod
* krb5-multidev
* libacl1
* libapt-inst1.5
* libapt-pkg4.12
* libasprintf0c2
* libattr1
* libblkid1
* libboost-iostreams1.49.0
* libbsd0
* libbz2-1.0
* libbz2-dev
* libc-bin
* libc-client2007e
* libc-dev-bin
* libc6
* libc6-dev
* libcap2
* libclass-isa-perl
* libcomerr2
* libcurl3
* libcurl4-openssl-dev
* libcwidget3
* libdb5.1
* libdevmapper1.02.1
* libedit2
* libept1.4.12
* libexpat1
* libfcgi-dev
* libfcgi0ldbl
* libffi5
* libfreetype6
* libfuse2
* libgamin-dev
* libgamin0
* libgcc1
* libgcrypt11
* libgcrypt11-dev
* libgdbm-dev
* libgdbm3
* libglib2.0-0
* libgmp10
* libgnutls-dev
* libgnutls-openssl27
* libgnutls26
* libgnutlsxx27
* libgomp1
* libgpg-error-dev
* libgpg-error0
* libgpgme11
* libgpm2
* libgssapi-krb5-2
* libgssrpc4
* libidn11
* libidn11-dev
* libitm1
* libk5crypto3
* libkadm5clnt-mit8
* libkadm5srv-mit8
* libkdb5-6
* libkeyutils1
* libklibc
* libkmod2
* libkrb5-3
* libkrb5-dev
* libkrb5support0
* libldap-2.4-2
* libldap2-dev
* liblocale-gettext-perl
* liblzma5
* libmagic1
* libmemcache-dev
* libmemcache0
* libmount1
* libmpc2
* libmpfr4
* libmysqlclient18
* libncurses5
* libncursesw5
* libnewt0.52
* libnfnetlink0
* libonig2
* libopts25
* libp11-kit-dev
* libp11-kit0
* libpam-modules
* libpam-modules-bin
* libpam-pgsql
* libpam-runtime
* libpam0g
* libpam0g-dev
* libparted0debian1
* libpcre3
* libpcre3-dev
* libpcrecpp0
* libpipeline1
* libpng12-0
* libpng12-dev
* libpopt0
* libpq-dev
* libpq5
* libprocps0
* libpth20
* libqdbm14
* libquadmath0
* libreadline6
* librtmp-dev
* librtmp0
* libsasl2-2
* libsasl2-modules
* libselinux1
* libsemanage-common
* libsemanage1
* libsepol1
* libsigc++-2.0-0c2a
* libslang2
* libsqlite3-0
* libsqlite3-dev
* libss2
* libssh2-1
* libssh2-1-dev
* libssl-dev
* libssl1.0.0
* libstdc++6
* libtasn1-3
* libtasn1-3-dev
* libtext-charwidth-perl
* libtext-iconv-perl
* libtext-wrapi18n-perl
* libtinfo5
* libtokyocabinet9
* libudev0
* libusb-0.1-4
* libustr-1.0-1
* libuuid-perl
* libuuid1
* libwrap0
* libxapian22
* libxml2
* libxml2-dev
* libxml2-utils
* linux-base
* linux-image-3.2.0-4-686-pae
* linux-libc-dev
* locales
* login
* logrotate
* lsb-base
* lsb-release
* make
* makedev
* man-db
* manpages
* manpages-dev
* mawk
* mime-support
* mlock
* module-init-tools
* mount
* multiarch-support
* mysql-common
* nano
* ncurses-base
* ncurses-bin
* net-tools
* netbase
* netcat-traditional
* ntp
* ntpdate
* openssh-client
* openssh-server
* openssl
* parted
* passwd
* patch
* perl-base
* php-pear
* php-xml-parser
* php-xml-serializer
* php5-cgi
* php5-cli
* php5-common
* php5-curl
* php5-imap
* php5-pgsql
* php5-xcache
* pkg-config
* postfix
* postfix-pcre
* postfix-pgsql
* postgresql-9.1
* postgresql-client-9.1
* postgresql-client-common
* postgresql-common
* procps
* psmisc
* python
* python-minimal
* python2.7
* python2.7-minimal
* rdate
* readline-common
* rsyslog
* sasl2-bin
* sed
* sensible-utils
* shared-mime-info
* ssh
* ssl-cert
* sudo
* sysv-rc
* sysvinit
* sysvinit-utils
* tar
* tasksel
* tasksel-data
* traceroute
* tzdata
* ucf
* udev
* util-linux
* uuid-dev
* vim
* vim-common
* vim-runtime
* vim-tiny
* wget
* whiptail
* xz-utils
* zlib1g
* zlib1g-dev
* lighttpd-mod-webdav
* lighttpd

==Known Issues==
===Separate authentication for innovaphone applications===
If you configured a separate authentication, it depends on the used browser, whether you have to re-authenticate on switching between the root web and the innovaphone application web access or not.

===Refreshing issue on hotfix installation===
[[ Reference10:Concept_Linux_Application_Platform#Refreshing_issue_on_installation | See here. ]]

===Kernel Update in VM Platform===
The installation of a new kernel fails and this process leaves the system unstable, not being able to install any more debian packages. Hotfix installations will probably fail.

===Outdated packages? Debian Upgrade?===
From time to time we will deliver upgraded debian packages with a new hotfix. As we have to insure compatibility with our applications, we won't perform an upgrade for each hotfix! 
 
Please do '''not''' perform an update/upgrade yourself, as this will break future hotfix/application releases. Sometimes we deliver debian packages in our hotfixes and dependencies might be broken if you update/upgrade yourself.

====I want to do it anyway!!!====
Ok, save your application/ap configuration and data files and install our latest '''FULL''' release without any hotfix. Restore the configuration/data files and perform your update/upgrade. Now you can be happy, if everything still works fine... 
Perform these steps for each new hotfix release, as you might not be able to apply a new hotfix.

[[Category:Concept|Linux Application Platform]]

Reference9:PBX/Objects/PBX

2012-11-21T13:44:45Z

Sebastian.Lutz: /* Licenses */

The PBX object is used to define another PBX which can register. With each PBX object a Node for this PBX is configured as well. The following configuration parameter have special meaning in the context of a PBX object

== Name ==

The Name of the PBX object defines the name of the PBX. A Name must be configured for a PBX object otherwise it cannot be used.

== Number ==

The Number of the PBX object defines the prefix of the Node generated for this PBX. A PBX object without Number (prefix) is invalid. This prefix must be unique within the node of the object as it is with the Number configured for other objects.

== Parent Node ==

A hierachy of Nodes can be configured. The Top-Level nodes are configured with a Parent Node of 'root'. By configuring another node here, the new node is defined as subnode of this Parent Node.

The node tree root is called '''root''' always: that is, you cannot have another node be the root. In particular, all ''parent node'' links must ultimately end up in the node called '''root'''.

== Parent PBX ==

The PBX to which this PBX can register. For the PBX of the Master PBX this PBX itself must be configured. For example if the Master is configured on Node 'headquarters', which means the PBX Name of the master is 'headquarters', the PBX object uses the Name 'headquarters' as well and the Parent PBX of this object is configured to 'headquarters' also.

== Password ==

This password is used for the authentication of the slave PBX registration

== Busy on ... Calls ==

This parameter can be used to limit the calls to a slave PBX. A CFNR configured at the Node Object can be used to redirect a call if the number of active calls to/from the slave PBX is equal to or exceeding this value.

== Escape ==

The escape digits can be dialed to call the next higher level of the numbering node. These escape digits are used the same way as prefixes for the national/international network in the public telephone network. If escape digits are defined no higher nodes can be called from this node without the escape digits. If there is a conflict between the escape digits and the numbers of other objects within this node, the escape digits have precedence.

== Dialtone ==

A checkmark indicates that a dialtone should be played if the escape is dialed without any further digits. To play the dialtone a call is initiated to the object configured on the [[Reference:Administration/PBX/General|PBX/General]] page.

== Reroute Destinations ==

For calls which have this node as destination, call rerouting can be configured for some conditions. The rerouting confgured here takes precedence over rerouting, which may be configured at a Trunk Object thru which the call is coming in. Any call forwarding configured at a user takes precedence over this rerouting. The rerouting is only executed for calls originating from a different node.

A configured No is always interpreted in the context of this node.

=== Incomplete Number ===

If the dialed number is incomplete the call is rerouted to the configured Name/Number. There is a fixed timeout of 4s to determine that no more digits are dialed.

=== No Response ===

The CFNR timeout configured for the PBX or for the dialed user is used to determine that the user does not answer. In this case the call is rerouted to the configured Name/No.

== Number Mapping ==

For dialed International, National or subscriber numbers prefixes can be configured which are added to the called party number. The type of number is changed to 'Unknown'. This useful for example if an directory is used where all numbers are stored in the international format (e.g. +49 7031 ...). In this case a prefix can be configured which includes the Trunk, so that the call is sent to the public network.

==Licenses==
In this tab it shows how many licenses this corresponding slave PBX has in use (if license floating model is in use).

== CFB, CFNR ==

CFB, CFNR can be used for alternate routing to this PBX in case the maximum number of calls defined by busy on ... calls is reached (CFB) or if the registration of the slave PBX is down (CFNR).

Reference9:Gateway/Routes/Map

2012-05-22T09:45:52Z

Sebastian.Lutz: /* Configuration */

This page is used to edit a Number map.

== Configuration ==

;Description

:This description is displayed in the last column of the routing table. It can be used for documentation purposes.

;Disable
:The Disable checkmark disables a route without deleting it. This way a route can be disabled temporarily without the need to re-enter all the configuration if it is enabled again.

;From Interfaces
:All available interfaces are displayed. By setting the checkmark next to an interface, this interface is added to the list of interfaces for which the route handles incoming calls. Even if this is a page to edit a map the From interface list is valid for the route. It cannot be modified for a single map only.

;Number In/Out
:The Number In/Out input fields (input fields with no label but an arrow in between) are used to do a headmatch on the received called party number and replace the matching part of the called party number by Number Out. As digits any valid dialing digit is allowed (0..9,*,#). 
:- A '?' as digit in Number in indicates that this digit matches to any received digit. 
::These digits are copied to the positions marked wuth '?' in the out field. 
:- A '.' at the end of Number In can be used to indicate that the number should match only if the respective number of additional digits is received. 
::Any digits matching with '.' are not replaced by Number Out. 
::This way a conversion of overlap to en-block dialing can be performed. 
:- A '!' at the end of Number In indicates that any additional digit received after it, should be cut off. 
:- A '^' character in Number Out indicates that any digit after this character shall be sent as DTMF after the connect.

;Name Out
:The name in the Name Out field (the field without label below Number Out) is sent as destination name with the call. A call passed a route with the used Name Out field will be disabled for the further overlap dialing.

;To Interface
:The drop down is used to select the interface to which the call is sent if the map matches. There are two pseudo interfaces available: DISC and MAP. DISC disconnects the call if the map matches. MAP just does the number mapping as configured and the searching for routes will continue.

;DISC
:This input field is only used together with the DISC pseudo To interface. The numeric value for the disconnect cause can be configured. Common values are 16-normal clearing, 17-busy, 44-No channel available. This can be also used for rerouting.

;Add UUI
:This input field is used to define User User Information which is added to the call. User User Information may be used by the endpoint receiving the call for all kinds of purposes. Innovaphone HTTP interfaces are using this as URL to retrieve announcements.

;Final Route
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, no reroute shall be performed.

;Final Map
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, rerouting shall start with the first map of the next route. Any additional maps within the same route are not evaluated.

;No Reroute on Wrong No
:This checkmark indicates that no reroute is performed if the cause indicates a wrong number. Usually a reroute is performed on local interface problems<ref>''local interface problems'' are assumed if the attempted call terminates with [[Reference:ISDN Errorcodes|cause codes]] 34, 38, 41, 42, 44, 47 or 49. A ''wrong number'' is assumed for cause codes 1, 2, 3 and 18</ref> (e.g. no channel) or if the cause indicates that the number cannot be reached thru this interface. This option turns off rerouting if the cause indicates that the number cannot be reached thru this interface. This option should be set if the reroute should be an overflow to the next interface of the same bundle.

;Verify CGPN
:This checkmark indicates that this map is regarded as matching only if a matching CGPN Map is found as well. This is the mechanism which allows routing of calls based on the Calling Party Number.

;Interworking (QSIG,SIP)
:If this checkmark is set supplementary services are interworked between the protocols. If not set QSIG or other ISDN facilities are forwarded transparently thru H.323 calls. SIP cannot be used to forward facilities transparently.

;Rerouting As Deflection
:This checkmark may be activated only in conjunction with the supplementary service ''Partial Rerouting'' and with an activated ''Interworking (QSIG,SIP)'' checkmark. This checkmark turns a Call Rerouting protocol handshake into a Call Deflection protocol handshake.

;Routing on Diverting No
:If this checkmark is set the route only matches to an incoming diverting number instead of a called party number. If the diverting number matches the called party number is replaced by the diverting number and the diverting number is removed and the call is routed normally.

;Force enblock
:Used to convert a call from overlap dialing to enblock dialing. The call is not sent until for a timeout of 4s no additional dialing digit is received.
:Configurable between 500ms and 6000ms.

;Add #
:This checkmark is only used together with Force enblock. When the call is sent '#' is added as last digit to the called party number.

;Disable Echo Canceler
:Used on IP2x IP30x for modem connections to disable the echo canceller, activate a static jitter buffer and to reduce to output volume.

;Emergency
:If a call using this route fails because of no channel available, a call on the destination interface is disconnected and the call is sent again. This way Emergency calls won't fail because of no channel available.

;Call Counter
:Call Counters can be used to limit the calls sent thru the given route. If the same Call Counter (any Name) is configured for several maps, each active call sent thru such a map is counted with the Call Counter. If the Call Counter is at our above 'max' the call is treated as if the interface had no channel available (reroute is performed and if there is no other matching route the call is disconnected with cause 'No channel available'.

Reference9:Gateway/Routes/Map

2012-05-22T09:45:30Z

Sebastian.Lutz: /* Configuration */

This page is used to edit a Number map.

== Configuration ==

;Description

:This description is displayed in the last column of the routing table. It can be used for documentation purposes.

;Disable
:The Disable checkmark disables a route without deleting it. This way a route can be disabled temporarily without the need to re-enter all the configuration if it is enabled again.

;From Interfaces
:All available interfaces are displayed. By setting the checkmark next to an interface, this interface is added to the list of interfaces for which the route handles incoming calls. Even if this is a page to edit a map the From interface list is valid for the route. It cannot be modified for a single map only.

;Number In/Out
:The Number In/Out input fields (input fields with no label but an arrow in between) are used to do a headmatch on the received called party number and replace the matching part of the called party number by Number Out. As digits any valid dialing digit is allowed (0..9,*,#). 
:- A '?' as digit in Number in indicates that this digit matches to any received digit. 
::These digits are copied to the positions marked wuth '?' in the out field. 
:- A '.' at the end of Number In can be used to indicate that the number should match only if the respective number of additional digits is received. 
::Any digits matching with '.' are not replaced by Number Out. 
::This way a conversion of overlap to en-block dialing can be performed. 
:- A '!' at the end of Number In indicates that any additional digit received after it, should be cut off. 
:- A '^' character in Number Out indicates that any digit after this character shall be sent as DTMF after the connect.

;Name Out
:The name in the Name Out field (the field without label below Number Out) is sent as destination name with the call. A call passed a route with the used Name Out field will be disabled for the further overlap dialing.

;To Interface
:The drop down is used to select the interface to which the call is sent if the map matches. There are two pseudo interfaces available: DISC and MAP. DISC disconnects the call if the map matches. MAP just does the number mapping as configured and the searching for routes will continue.

;DISC
:This input field is only used together with the DISC pseudo To interface. The numeric value for the disconnect cause can be configured. Common values are 16-normal clearing, 17-busy, 44-No channel available. This can be also used for rerouting.

;Add UUI
:This input field is used to define User User Information which is added to the call. User User Information may be used by the endpoint receiving the call for all kinds of purposes. Innovaphone HTTP interfaces are using this as URL to retrieve announcements.

;Final Route
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, no reroute shall be performed.

;Final Map
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, rerouting shall start with the first map of the next route. Any additional maps within the same route are not evaluated.

;No Reroute on Wrong No
:This checkmark indicates that no reroute is performed if the cause indicates a wrong number. Usually a reroute is performed on local interface problems<ref>''local interface problems'' are assumed if the attempted call terminates with [[Reference:ISDN Errorcodes|cause codes]] 34, 38, 41, 42, 44, 47 or 49. A ''wrong number'' is assumed for cause codes 1, 2, 3 and 18</ref> (e.g. no channel) or if the cause indicates that the number cannot be reached thru this interface. This option turns off rerouting if the cause indicates that the number cannot be reached thru this interface. This option should be set if the reroute should be an overflow to the next interface of the same bundle.

;Verify CGPN
:This checkmark indicates that this map is regarded as matching only if a matching CGPN Map is found as well. This is the mechanism which allows routing of calls based on the Calling Party Number.

;Interworking (QSIG,SIP)
:If this checkmark is set supplementary services are interworked between the protocols. If not set QSIG or other ISDN facilities are forwarded transparently thru H.323 calls. SIP cannot be used to forward facilities transparently.

;Rerouting As Deflection
:This checkmark may be activated only in conjunction with the supplementary service ''Partial Rerouting'' and with an activated ''Interworking (QSIG,SIP)'' checkmark. This checkmark turns a Call Rerouting protocol handshake into a Call Deflection protocol handshake.

;Routing on Diverting No
:If this checkmark is set the route only matches to an incoming diverting number instead of a called party number. If the diverting number matches the called party number is replaced by the diverting number and the diverting number is removed and the call is routed normally.

;Force enblock
:Used to convert a call from overlap dialing to enblock dialing. The call is not sent until for a timeout of 4s no additional dialing digit is received.
:Configurable between 500ms and 6000ms

;Add #
:This checkmark is only used together with Force enblock. When the call is sent '#' is added as last digit to the called party number.

;Disable Echo Canceler
:Used on IP2x IP30x for modem connections to disable the echo canceller, activate a static jitter buffer and to reduce to output volume.

;Emergency
:If a call using this route fails because of no channel available, a call on the destination interface is disconnected and the call is sent again. This way Emergency calls won't fail because of no channel available.

;Call Counter
:Call Counters can be used to limit the calls sent thru the given route. If the same Call Counter (any Name) is configured for several maps, each active call sent thru such a map is counted with the Call Counter. If the Call Counter is at our above 'max' the call is treated as if the interface had no channel available (reroute is performed and if there is no other matching route the call is disconnected with cause 'No channel available'.

Howto7:ACD with Voicemail XML Script and external Database or Application

2012-05-15T14:31:00Z

Sebastian.Lutz: /* Configuration */

This article describes how to setup a simple automated call distribution by using custom voicemail XML script and an external database or a CRM application.

==Applies To==
This information applies to

* innovaphone PBX, V7

==More Information==
A frequently asked feature for incoming call centers is ability to connect incoming customer calls to their respective personal point of contact(an agent or agent group). The relationship of customer calling number and responsible agent is stored in the external database or CRM application. For this purpose a custom XML voicemail script can be used to perform a query from innovaphone PBX to an external application via HTTP.

The voicemail command <code>exec url</code> executes an HTTP GET CGI-request. The URL is supposed to contain arbitrary script variables. The remote CGI script shall return a short voicemail script comprising <code>assign</code> elements.

The call distribution is intentional designed so that the first free agent gets the most calls.

Please note, that the scripts are exemplary and free and can be modified to fulfill your special requirements.

===Configuration===
The outline for the following configuration scenario shall be as follows:
*Create a file with XML script listed below and named "acd.xml".
*Additionally place the text files with numbers of agents and voicemail box in this folder.
*Create a new voicemail object in the PBX with URL <code>http://127.0.0.1/drive/CF0/acd.xml?$_pbxfwd=true</code>.

Contents of acd.xml:
<code xml>
<?xml version="1.0" encoding="utf-8" ?>
<voicemail xmlns="http://www.innovaphone.com/xsd/voicemail6.xsd">
<function define="Main">

<pbx-getcallinfo out-cgpn="$cgpn" out-cdpn="$cdpn" out-leg2="$leg2" />


<assign out="$forward" value="999"/>


<exec url="http://172.16.0.17/query.php?cgpn=$cgpn"/>


<pbx-fwd e164="$forward" out-cause="$cause" barge-in="false" />

</function>
</voicemail>
</code>

A very simple server side code example based on PHP:
<code php>
<?php

//default forward destination
$forward = "999";

//just for test: if CGPN is 235, forward to 103
//implement your db query etc. here instead
if ($_GET['cgpn'] == "235") $forward = "103";

echo "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
echo "<voicemail xmlns=\"http://www.innovaphone.com/xsd/voicemail6.xsd\">\r\n";
echo " <assign out=\"\$forward\" value=\"$forward\"/>\r\n";
echo "</voicemail>\r\n";
?>
</code>

The response of the PHP script should be as follows(if CGPN is 235):
<code xml>
<?xml version="1.0" encoding="utf-8"?>
<voicemail xmlns="http://www.innovaphone.com/xsd/voicemail6.xsd">
<assign out="$forward" value="103"/>
</voicemail>
?>
</code>

===Known Problems===

*Don't forget to provide additional option to the script URL, since it is required for the executing of call forwards: <code>?$_pbxfwd=true</code>

== Related Articles ==
[[Howto:How_to_Configure_the_innovaphone_Voicemail|How to Configure the innovaphone Voicemail]]

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

Reference9:Gateway/Routes/Map

2011-09-26T10:21:42Z

Sebastian.Lutz: /* Configuration */

This page is used to edit a Number map.

== Configuration ==

;Description

:This description is displayed in the last column of the routing table. It can be used for documentation purposes.

;Disable
:The Disable checkmark disables a route without deleting it. This way a route can be disabled temporarily without the need to re-enter all the configuration if it is enabled again.

;From Interfaces
:All available interfaces are displayed. By setting the checkmark next to an interface, this interface is added to the list of interfaces for which the route handles incoming calls. Even if this is a page to edit a map the From interface list is valid for the route. It cannot be modified for a single map only.

;Number In/Out
:The Number In/Out input fields (input fields with no label but an arrow in between) are used to do a headmatch on the received called party number and replace the matching part of the called party number by Number Out. As digits any valid dialing digit is allowed (0..9,*,#). 
:- A '?' as digit in Number in indicates that this digit matches to any received digit. 
::These digits are copied to the positions marked wuth '?' in the out field. 
:- A '.' at the end of Number In can be used to indicate that the number should match only if the respective number of additional digits is received. 
::Any digits matching with '.' are not replaced by Number Out. 
::This way a conversion of overlap to en-block dialing can be performed. 
:- A '!' at the end of Number In indicates that any additional digit received after it, should be cut off. 
:- A '^' character in Number Out indicates that any digit after this character shall be sent as DTMF after the connect.

;Name Out
:The name in the Name Out field (the field without label below Number Out) is sent as destination name with the call. A call passed a route with the used Name Out field will be disabled for the further overlap dialing.

;To Interface
:The drop down is used to select the interface to which the call is sent if the map matches. There are two pseudo interfaces available: DISC and MAP. DISC disconnects the call if the map matches. MAP just does the number mapping as configured and the searching for routes will continue.

;DISC
:This input field is only used together with the DISC pseudo To interface. The numeric value for the disconnect cause can be configured. Common values are 16-normal clearing, 17-busy, 44-No channel available. This can be also used for rerouting.

;Add UUI
:This input field is used to define User User Information which is added to the call. User User Information may be used by the endpoint receiving the call for all kinds of purposes. Innovaphone HTTP interfaces are using this as URL to retrieve announcements.

;Final Route
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, no reroute shall be performed.

;Final Map
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, rerouting shall start with the first map of the next route. Any additional maps within the same route are not evaluated.

;No Reroute on Wrong No
:This checkmark indicates that no reroute is performed if the cause indicates a wrong number. Usually a reroute is performed on local interface problems<ref>''local interface problems'' are assumed if the attempted call terminates with [[Reference:ISDN Errorcodes|cause codes]] 34, 38, 41, 42, 44, 47 or 49. A ''wrong number'' is assumed for cause codes 1, 2, 3 and 18</ref> (e.g. no channel) or if the cause indicates that the number cannot be reached thru this interface. This option turns off rerouting if the cause indicates that the number cannot be reached thru this interface. This option should be set if the reroute should be an overflow to the next interface of the same bundle.

;Verify CGPN
:This checkmark indicates that this map is regarded as matching only if a matching CGPN Map is found as well. This is the mechanism which allows routing of calls based on the Calling Party Number.

;Interworking (QSIG,SIP)
:If this checkmark is set supplementary services are interworked between the protocols. If not set QSIG or other ISDN facilities are forwarded transparently thru H.323 calls. SIP cannot be used to forward facilities transparently.

;Rerouting As Deflection
:This checkmark may be activated only in conjunction with the supplementary service ''Partial Rerouting'' and with an activated ''Interworking (QSIG,SIP)'' checkmark. This checkmark turns a Call Rerouting protocol handshake into a Call Deflection protocol handshake.

;Routing on Diverting No
:If this checkmark is set the route only matches to an incoming diverting number instead of a called party number. If the diverting number matches the called party number is replaced by the diverting number and the diverting number is removed and the call is routed normally.

;Force enblock
:Used to convert a call from overlap dialing to enblock dialing. The call is not sent until for a timeout of 4s no additional dialing digit is received.

;Add #
:This checkmark is only used together with Force enblock. When the call is sent '#' is added as last digit to the called party number.

;Disable Echo Canceler
:Used on IP2x IP30x for modem connections to disable the echo canceller, activate a static jitter buffer and to reduce to output volume.

;Emergency
:If a call using this route fails because of no channel available, a call on the destination interface is disconnected and the call is sent again. This way Emergency calls won't fail because of no channel available.

;Call Counter
:Call Counters can be used to limit the calls sent thru the given route. If the same Call Counter (any Name) is configured for several maps, each active call sent thru such a map is counted with the Call Counter. If the Call Counter is at our above 'max' the call is treated as if the interface had no channel available (reroute is performed and if there is no other matching route the call is disconnected with cause 'No channel available'.

Reference9:Gateway/Routes/Map

2011-09-26T10:20:58Z

Sebastian.Lutz: /* Configuration */

This page is used to edit a Number map.

== Configuration ==

;Description

:This description is displayed in the last column of the routing table. It can be used for documentation purposes.

;Disable
:The Disable checkmark disables a route without deleting it. This way a route can be disabled temporarily without the need to re-enter all the configuration if it is enabled again.

;From Interfaces
:All available interfaces are displayed. By setting the checkmark next to an interface, this interface is added to the list of interfaces for which the route handles incoming calls. Even if this is a page to edit a map the From interface list is valid for the route. It cannot be modified for a single map only.

;Number In/Out
:The Number In/Out input fields (input fields with no label but an arrow in between) are used to do a headmatch on the received called party number and replace the matching part of the called party number by Number Out. As digits any valid dialing digit is allowed (0..9,*,#). 
:- A '?' as digit in Number in indicates that this digit matches to any received digit these digits are copied to the positions marked wuth '?' in the out field. 
:- A '.' at the end of Number In can be used to indicate that the number should match only if the respective number of additional digits is received. 
::Any digits matching with '.' are not replaced by Number Out. 
::This way a conversion of overlap to en-block dialing can be performed. 
:- A '!' at the end of Number In indicates that any additional digit received after it, should be cut off. 
:- A '^' character in Number Out indicates that any digit after this character shall be sent as DTMF after the connect.

;Name Out
:The name in the Name Out field (the field without label below Number Out) is sent as destination name with the call. A call passed a route with the used Name Out field will be disabled for the further overlap dialing.

;To Interface
:The drop down is used to select the interface to which the call is sent if the map matches. There are two pseudo interfaces available: DISC and MAP. DISC disconnects the call if the map matches. MAP just does the number mapping as configured and the searching for routes will continue.

;DISC
:This input field is only used together with the DISC pseudo To interface. The numeric value for the disconnect cause can be configured. Common values are 16-normal clearing, 17-busy, 44-No channel available. This can be also used for rerouting.

;Add UUI
:This input field is used to define User User Information which is added to the call. User User Information may be used by the endpoint receiving the call for all kinds of purposes. Innovaphone HTTP interfaces are using this as URL to retrieve announcements.

;Final Route
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, no reroute shall be performed.

;Final Map
:This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, rerouting shall start with the first map of the next route. Any additional maps within the same route are not evaluated.

;No Reroute on Wrong No
:This checkmark indicates that no reroute is performed if the cause indicates a wrong number. Usually a reroute is performed on local interface problems<ref>''local interface problems'' are assumed if the attempted call terminates with [[Reference:ISDN Errorcodes|cause codes]] 34, 38, 41, 42, 44, 47 or 49. A ''wrong number'' is assumed for cause codes 1, 2, 3 and 18</ref> (e.g. no channel) or if the cause indicates that the number cannot be reached thru this interface. This option turns off rerouting if the cause indicates that the number cannot be reached thru this interface. This option should be set if the reroute should be an overflow to the next interface of the same bundle.

;Verify CGPN
:This checkmark indicates that this map is regarded as matching only if a matching CGPN Map is found as well. This is the mechanism which allows routing of calls based on the Calling Party Number.

;Interworking (QSIG,SIP)
:If this checkmark is set supplementary services are interworked between the protocols. If not set QSIG or other ISDN facilities are forwarded transparently thru H.323 calls. SIP cannot be used to forward facilities transparently.

;Rerouting As Deflection
:This checkmark may be activated only in conjunction with the supplementary service ''Partial Rerouting'' and with an activated ''Interworking (QSIG,SIP)'' checkmark. This checkmark turns a Call Rerouting protocol handshake into a Call Deflection protocol handshake.

;Routing on Diverting No
:If this checkmark is set the route only matches to an incoming diverting number instead of a called party number. If the diverting number matches the called party number is replaced by the diverting number and the diverting number is removed and the call is routed normally.

;Force enblock
:Used to convert a call from overlap dialing to enblock dialing. The call is not sent until for a timeout of 4s no additional dialing digit is received.

;Add #
:This checkmark is only used together with Force enblock. When the call is sent '#' is added as last digit to the called party number.

;Disable Echo Canceler
:Used on IP2x IP30x for modem connections to disable the echo canceller, activate a static jitter buffer and to reduce to output volume.

;Emergency
:If a call using this route fails because of no channel available, a call on the destination interface is disconnected and the call is sent again. This way Emergency calls won't fail because of no channel available.

;Call Counter
:Call Counters can be used to limit the calls sent thru the given route. If the same Call Counter (any Name) is configured for several maps, each active call sent thru such a map is counted with the Call Counter. If the Call Counter is at our above 'max' the call is treated as if the interface had no channel available (reroute is performed and if there is no other matching route the call is disconnected with cause 'No channel available'.

Reference7:Administration/Relay/Routes/Map

2011-07-20T09:11:46Z

Sebastian.Lutz: /* Configuration */

This page is used to edit a Number map.

== Configuration ==

{|
|valign=top nowrap=true|'''Description'''
|This description is displayed in the last coloum of the routing table. It can be used for documentation purposes.
|-
|valign=top nowrap=true|'''Disable'''
|The Disable checkmark disables a route without deleting it. This way a route can be disabled temporarily without the need to re-enter all the configuration if it is enabled again.
|-
|valign=top nowrap=true|'''From Interfaces'''
|All available interfaces are displayed. By setting the checkmark next to an interface, this interface is added to the list of interfaces for which the route handles incoming calls. Even if this is a page to edit a map the From interface list is valid for the route. It cannot be modified for a single map only.
|-
|valign=top nowrap=true|'''Number In/Out'''
|The 'Number In/Out' input fields (input fields with no label but an arrow in between) are used to do a headmatch on the received called party number and replace the matching part of the called party number by 'Number Out'. As digits any valid dialing digit is allowed (0..9,*,#). A '?' as digit in 'Number in' indicates that this digit matches to any received digit. '.' at the end of 'Number In' can be used to indicate that the number should match only if the respective number of additional digits is received. Any digits matching with '.' are not replaced by 'Number Out'. This way a conversion of overlap to en-block dialing can be performed. A '!' at the end of 'Number In' indicates that any additional digit received after it, should be cut off. A '^' character in 'Number Out' indicates that any digit after this character shall be sent as DTMF after the connect.
|-
|valign=top nowrap=true|'''Name Out'''
|The name in the Name Out field (the field without label below Number Out) is sent as destination name with the call. A call passed a route with the used Name Out field will be disabled for the further overlap dialing.
|-
|valign=top nowrap=true|'''To Interface'''
|The drop down is used to select the interface to which the call is sent if the map matches. There are two pseudo interfaces available: DISC and MAP. DISC disconnects the call if the map matches. MAP just does the number mapping as configured and the searching for routes will continue.
|-
|valign=top nowrap=true|'''DISC'''
|This input field is only used together with the DISC pseudo To interface. The numeric value for the disconnect cause can be configured. Common values are 16-normal clearing, 17-busy, 44-No channel available. This can be also used for rerouting.
|-
|valign=top nowrap=true|'''Add UUI'''
|This input field is used to define User User Information which is added to the call. User User Information may be used by the endpoint receiving the call for all kinds of purposes. Innovaphone HTTP interfaces are using this as URL to retrieve announcements.
|-
|valign=top nowrap=true|'''Final Route'''
|This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, no reroute shall be performed.
|-
|valign=top nowrap=true|'''Final Map'''
|This checkmark indicates that if a call thru this route fails even with a cause which should usually result in a re-route, rerouting shall start with the first map of the next route. Any additional maps within the same route are not evaluated.
|-
|valign=top nowrap=true|'''No Reroute on Wrong No'''
|This checkmark indicates that no reroute is performed if the cause indicates a wrong number. Usually a reroute is performed on local interface problems<ref>''local interface problems'' are assumed if the attempted call terminates with [[Reference:ISDN Errorcodes|cause codes]] 34, 38, 41, 42, 44, 47 or 49. A ''wrong number'' is assumed for cause codes 1, 2, 3 and 18</ref> (e.g. no channel) or if the cause indicates that the number cannot be reached thru this interface. This option turns off rerouting if the cause indicates that the number cannot be reached thru this interface. This option should be set if the reroute should be an overflow to the next interface of the same bundle.
|-
|valign=top nowrap=true|'''Verify CGPN'''
|This checkmark indicates that this map is regarded as matching only if a matching CGPN Map is found as well. This is the mechanism which allows routing of calls based on the Calling Party Number.
|-
|valign=top nowrap=true|'''Interworking (QSIG,SIP)'''
|If this checkmark is set supplementary services are interworked between the protocols. If not set QSIG or other ISDN facilities are forwarded transparently thru H.323 calls. SIP cannot be used to forward facilities transparently.
|-
|valign=top nowrap=true|'''Rerouting As Deflection'''
|This checkmark may be activated only in conjunction with the supplementary service ''Partial Rerouting'' and with an activated ''Interworking (QSIG,SIP)'' checkmark. This checkmark turns a Call Rerouting protocol handshake into a Call Deflection protocol handshake.
|-
|valign=top nowrap=true|'''Routing on Diverting No'''
|If this checkmark is set the route only matches to an incoming diverting number instead of a called party number. If the diverting number matches the called party number is replaced by the diverting number and the diverting number is removed and the call is routed normally.
|-
|valign=top nowrap=true|'''Force enblock'''
|Used to convert a call from overlap dialing to enblock dialing. The call is not sent until for a timeout of 4s no additional dialing digit is received.
|-
|valign=top nowrap=true|'''Add #'''
|This checkmark is only used together with Force enblock. When the call is sent '#' is added as last digit to the called party number.
|-
|valign=top nowrap=true|'''Disable Echo Canceler'''
|Used on IP2x IP30x for modem connections to disable the echo canceller, activate a static jitter buffer and to reduce to output volume.
|-
|valign=top nowrap=true|'''Call Counter'''
|Call Counters can be used to limit the calls sent thru the given route. If the same Call Counter (any Name) is configured for several maps, each active call sent thru such a map is counted with the Call Counter. If the Call Counter is at our above 'max' the call is treated as if the interface had no channel available (reroute is performed and if there is no other matching route the call is disconnected witn cause 'No channel available'.
|}

<references/>

User:Sebastian.Lutz

2011-06-16T10:48:13Z

Sebastian.Lutz: New page: Hey Dude :-}

Hey Dude :-}

Freeedit:Wiki Edit Sandbox

2010-04-13T17:23:29Z

Sebastian.Lutz:

This is a dummy article to safely try editing wiki articles.

Patrick Montaine '''Ball Packaging Europe'''

Christoph Anhorn- '''swisspro AG'''

= Wiki Syntax ([[Help:Formatting|more about formatting]], [[Help:Contents|generic help]]): =

Italic ''word'': <code>''word''</code> 
Bold '''word''': <code>'''word'''</code> 
:Indented line: <code>:line</code> 

# numbered list item: <code># list item</code>
## numbered list sub item: <code>## list item</code>

* dotted list item: <code>* list item</code>
** dotted list sub item: <code>** list item</code>

hidden search tag:  <code></code>

= Play Arena =

John Larsen '''Ascom Denmark A/S'''

Marco Koch, '''Wrocklage Intermedia GmbH Germany''' 
Frank Schneebeck, '''ETe Datentechnik GmbH Germany''' 
Christoph Hanken, Paragon Data GmbH
Jonas Teckentrup, Paragon Data GmbH
Porretta Mauro, '''SARTE S.p.A. Italy''' 
Kevin Edmonds, '''Consult Partner GmbH''' 
Karsten Otto, '''westko network service GmbH''' 
Arne Stark, '''westko network service GmbH''' 
Henk Schuurman, '''Soft Solutions''' 
Marko Röhncke, '''Kevag-Telekom GmbH''' 
Kristijan Fabina, '''Datentechnik d.o.o.''' 
Dirk Lange, '''Nachrichtentechnik Bielefeld GmbH''' 
Ludwig Kempter, '''LEWTelNet GmbH''' 
Jukka Somiska, '''Daimler Finland''' 
Gisbert Cremerius, '''Hack-Attack''' 
Massimiliano Tamaro '''Test s.p.a Italy''' 
Marco Boschi '''Eksaip Vicenza''' 
Stig Aune, '''Stig Aune Consulting''' 
Sandro Haas, '''KufGem EDV GmbH''' 
Daniel Haidacher, '''KufGem EDV GmbH''' 
Marc Steiner, '''Inikon AG''' 
Johan de Jong, '''trizwo GmbH''' 
René Scholz, '''Ascom''' 
Rocco Schmidt, '''ATS Ascom''' 
Marcel Britten, '''Connect GmbH''' 
Hans-Joachim Haun, '''VB OLD''' 
Marco Falger, '''Koch Media GmbH''' 
Swen Angelstein,'''ST.AG''' 
Arne Schmidt, '''TELCAT Multicom GmbH''' 
Liang Zhang, '''Koch Media GmbH''' 
Dirk-Jan van Dalen, '''Telematch BV''' 
Edwin Lansbergen, '''Telematch BV''' 
Benjamin Köhler, '''iits GmbH & Co. KG''' 
Christian Bengtsson, '''COBS AB. Sweden''' 
Sebastian Lutz, '''Oberberg-Online Informationssysteme GmbH'''